SVETlANNa
Contents:
Physical Basis
Command reference
Installation
Examples
SVETlANNa
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
agr_short_description() (in module svetlanna.logging)
AlgorithmOptions (class in svetlanna.phase_retrieval_problem.phase_retrieval)
Aperture (class in svetlanna.elements)
(class in svetlanna.elements.aperture)
append_feedback_queue() (svetlanna.elements.reservoir.SimpleReservoir method)
(svetlanna.elements.SimpleReservoir method)
Axes (class in svetlanna.simulation_parameters)
axes_size() (svetlanna.simulation_parameters.SimulationParameters method)
(svetlanna.SimulationParameters method)
AxisNotFound
B
batch_forward() (svetlanna.detector.DetectorProcessorClf method)
batch_zone_integral() (svetlanna.detector.DetectorProcessorClf method)
begin() (svetlanna.Clerk method)
(svetlanna.clerk.Clerk method)
C
cast_tensor() (in module svetlanna.axes_math)
cHz (svetlanna.units.ureg attribute)
clean_backup_checkpoints() (svetlanna.Clerk method)
(svetlanna.clerk.Clerk method)
clean_checkpoints() (svetlanna.Clerk method)
(svetlanna.clerk.Clerk method)
Clerk (class in svetlanna)
(class in svetlanna.clerk)
ClerkMode (class in svetlanna.clerk)
cm (svetlanna.units.ureg attribute)
constant_factor (svetlanna.phase_retrieval_problem.phase_retrieval.AlgorithmOptions attribute)
ConstrainedParameter (class in svetlanna)
(class in svetlanna.parameters)
context_generator() (in module svetlanna.specs.specs_writer)
ConvDiffNetwork4F (class in svetlanna.networks.diffractive_conv)
ConvLayer4F (class in svetlanna.networks.diffractive_conv)
cost_func (svetlanna.phase_retrieval_problem.phase_retrieval_result.PhaseRetrievalResult attribute)
(svetlanna.phase_retrieval_problem.PhaseRetrievalResult attribute)
cost_func_evolution (svetlanna.phase_retrieval_problem.phase_retrieval_result.PhaseRetrievalResult attribute)
(svetlanna.phase_retrieval_problem.PhaseRetrievalResult attribute)
cs (svetlanna.units.ureg attribute)
D
decode() (svetlanna.networks.autoencoder.LinearAutoencoder method)
default_widget_html_method() (in module svetlanna.visualization.widgets)
Detector (class in svetlanna.detector)
detector_segmentation() (svetlanna.detector.DetectorProcessorClf method)
DetectorProcessorClf (class in svetlanna.detector)
device (svetlanna.detector.DetectorProcessorClf property)
(svetlanna.networks.autoencoder.LinearAutoencoder property)
(svetlanna.networks.diffractive_conv.ConvDiffNetwork4F property)
(svetlanna.networks.diffractive_rnn.DiffractiveRNN property)
(svetlanna.simulation_parameters.SimulationParameters property)
(svetlanna.SimulationParameters property)
dHz (svetlanna.units.ureg attribute)
DiffractiveLayer (class in svetlanna.elements)
(class in svetlanna.elements.diffractive_layer)
DiffractiveRNN (class in svetlanna.networks.diffractive_rnn)
disp (svetlanna.phase_retrieval_problem.phase_retrieval.AlgorithmOptions attribute)
dm (svetlanna.units.ureg attribute)
draw_image() (svetlanna.specs.ImageRepr method)
(svetlanna.specs.specs.ImageRepr method)
draw_wavefront() (in module svetlanna.visualization.widgets)
drop_feedback_queue() (svetlanna.elements.reservoir.SimpleReservoir method)
(svetlanna.elements.SimpleReservoir method)
ds (svetlanna.units.ureg attribute)
E
Element (class in svetlanna.elements)
(class in svetlanna.elements.element)
element_type (svetlanna.visualization.ElementHTML attribute)
(svetlanna.visualization.widgets.ElementHTML attribute)
ElementHTML (class in svetlanna.visualization)
(class in svetlanna.visualization.widgets)
elements (svetlanna.visualization.widgets.SpecsWidget attribute)
(svetlanna.visualization.widgets.StepwiseForwardWidget attribute)
encode() (svetlanna.networks.autoencoder.LinearAutoencoder method)
expand() (svetlanna.parameters.InnerParameterStorageModule method)
F
file() (svetlanna.specs.ParameterSaveContext method)
(svetlanna.specs.specs.ParameterSaveContext method)
forward() (svetlanna.detector.Detector method)
(svetlanna.detector.DetectorProcessorClf method)
(svetlanna.elements.aperture.MulElement method)
(svetlanna.elements.diffractive_layer.DiffractiveLayer method)
(svetlanna.elements.DiffractiveLayer method)
(svetlanna.elements.Element method)
(svetlanna.elements.element.Element method)
(svetlanna.elements.free_space.FreeSpace method)
(svetlanna.elements.FreeSpace method)
(svetlanna.elements.FunctionModule method)
(svetlanna.elements.lens.ThinLens method)
(svetlanna.elements.nonlinear_element.FunctionModule method)
(svetlanna.elements.nonlinear_element.NonlinearElement method)
(svetlanna.elements.NonlinearElement method)
(svetlanna.elements.reservoir.SimpleReservoir method)
(svetlanna.elements.SimpleReservoir method)
(svetlanna.elements.slm.SpatialLightModulator method)
(svetlanna.elements.SpatialLightModulator method)
(svetlanna.elements.ThinLens method)
(svetlanna.LinearOpticalSetup method)
(svetlanna.networks.autoencoder.LinearAutoencoder method)
(svetlanna.networks.diffractive_conv.ConvDiffNetwork4F method)
(svetlanna.networks.diffractive_conv.ConvLayer4F method)
(svetlanna.networks.diffractive_rnn.DiffractiveRNN method)
(svetlanna.phase_retrieval_problem.phase_retrieval.SetupLike method)
(svetlanna.phase_retrieval_problem.SetupLike method)
(svetlanna.setup.LinearOpticalSetup method)
(svetlanna.transforms.GaussModulation method)
(svetlanna.transforms.ToWavefront method)
forward_logging_hook() (in module svetlanna.logging)
FreeSpace (class in svetlanna.elements)
(class in svetlanna.elements.free_space)
fs (svetlanna.units.ureg attribute)
FunctionModule (class in svetlanna.elements)
(class in svetlanna.elements.nonlinear_element)
fwhm() (svetlanna.Wavefront method)
(svetlanna.wavefront.Wavefront method)
G
gaussian_beam() (svetlanna.Wavefront class method)
(svetlanna.wavefront.Wavefront class method)
GaussModulation (class in svetlanna.transforms)
generate_structure_html() (in module svetlanna.visualization.widgets)
gerchberg_saxton_algorithm() (in module svetlanna.phase_retrieval_problem)
(in module svetlanna.phase_retrieval_problem.algorithms)
get_aperture (svetlanna.elements.slm.SpatialLightModulator property)
(svetlanna.elements.SpatialLightModulator property)
get_conv_layer_4f() (svetlanna.networks.diffractive_conv.ConvLayer4F method)
get_diffractive_layer() (svetlanna.networks.diffractive_conv.ConvLayer4F method)
get_free_space() (svetlanna.networks.diffractive_conv.ConvLayer4F method)
get_gauss() (svetlanna.transforms.GaussModulation method)
get_new_filepath() (svetlanna.specs.ParameterSaveContext method)
(svetlanna.specs.specs.ParameterSaveContext method)
get_thin_lens() (svetlanna.networks.diffractive_conv.ConvLayer4F method)
get_transmission_function() (svetlanna.elements.Aperture method)
(svetlanna.elements.aperture.Aperture method)
(svetlanna.elements.aperture.MulElement method)
(svetlanna.elements.aperture.RectangularAperture method)
(svetlanna.elements.aperture.RoundAperture method)
(svetlanna.elements.lens.ThinLens method)
(svetlanna.elements.RectangularAperture method)
(svetlanna.elements.RoundAperture method)
(svetlanna.elements.ThinLens method)
GHz (svetlanna.units.ureg attribute)
Gm (svetlanna.units.ureg attribute)
Gs (svetlanna.units.ureg attribute)
H
html (svetlanna.visualization.ElementHTML attribute)
(svetlanna.visualization.widgets.ElementHTML attribute)
HTMLRepresentation (class in svetlanna.specs)
(class in svetlanna.specs.specs)
hybrid_input_output() (in module svetlanna.phase_retrieval_problem)
(in module svetlanna.phase_retrieval_problem.algorithms)
Hz (svetlanna.units.ureg attribute)
I
ImageRepr (class in svetlanna.specs)
(class in svetlanna.specs.specs)
impulse_response_angular_spectrum() (svetlanna.elements.free_space.FreeSpace method)
(svetlanna.elements.FreeSpace method)
impulse_response_fresnel() (svetlanna.elements.free_space.FreeSpace method)
(svetlanna.elements.FreeSpace method)
index() (svetlanna.simulation_parameters.Axes method)
InnerParameterStorageModule (class in svetlanna.parameters)
intensity (svetlanna.Wavefront property)
(svetlanna.wavefront.Wavefront property)
is_scalar() (in module svetlanna.axes_math)
K
kHz (svetlanna.units.ureg attribute)
km (svetlanna.units.ureg attribute)
ks (svetlanna.units.ureg attribute)
L
LinearAutoencoder (class in svetlanna.networks.autoencoder)
LinearOpticalSetup (class in svetlanna)
(class in svetlanna.setup)
load_checkpoint() (svetlanna.Clerk method)
(svetlanna.clerk.Clerk method)
load_conditions() (svetlanna.Clerk method)
(svetlanna.clerk.Clerk method)
load_logs() (svetlanna.Clerk method)
(svetlanna.clerk.Clerk method)
load_logs_to_pandas() (svetlanna.Clerk method)
(svetlanna.clerk.Clerk method)
load_state_dict() (svetlanna.clerk.StatefulTorchClass method)
log_message() (in module svetlanna.logging)
M
m (svetlanna.units.ureg attribute)
make_buffer() (svetlanna.elements.Element method)
(svetlanna.elements.element.Element method)
MarkdownRepresentation (class in svetlanna.specs)
(class in svetlanna.specs.specs)
max_intensity (svetlanna.Wavefront property)
(svetlanna.wavefront.Wavefront property)
maxiter (svetlanna.phase_retrieval_problem.phase_retrieval.AlgorithmOptions attribute)
meshgrid() (svetlanna.simulation_parameters.SimulationParameters method)
(svetlanna.SimulationParameters method)
MHz (svetlanna.units.ureg attribute)
mHz (svetlanna.units.ureg attribute)
Mm (svetlanna.units.ureg attribute)
mm (svetlanna.units.ureg attribute)
module
svetlanna
svetlanna.axes_math
svetlanna.clerk
svetlanna.detector
svetlanna.elements
svetlanna.elements.aperture
svetlanna.elements.diffractive_layer
svetlanna.elements.element
svetlanna.elements.free_space
svetlanna.elements.lens
svetlanna.elements.nonlinear_element
svetlanna.elements.reservoir
svetlanna.elements.slm
svetlanna.logging
svetlanna.networks
svetlanna.networks.autoencoder
svetlanna.networks.diffractive_conv
svetlanna.networks.diffractive_rnn
svetlanna.parameters
svetlanna.phase_retrieval_problem
svetlanna.phase_retrieval_problem.algorithms
svetlanna.phase_retrieval_problem.phase_retrieval
svetlanna.phase_retrieval_problem.phase_retrieval_result
svetlanna.setup
svetlanna.simulation_parameters
svetlanna.specs
svetlanna.specs.specs
svetlanna.specs.specs_writer
svetlanna.transforms
svetlanna.units
svetlanna.visualization
svetlanna.visualization.widgets
svetlanna.wavefront
Ms (svetlanna.units.ureg attribute)
ms (svetlanna.units.ureg attribute)
mul() (in module svetlanna.wavefront)
MulElement (class in svetlanna.elements.aperture)
N
names (svetlanna.simulation_parameters.Axes property)
new_run (svetlanna.clerk.ClerkMode attribute)
nHz (svetlanna.units.ureg attribute)
nm (svetlanna.units.ureg attribute)
NonlinearElement (class in svetlanna.elements)
(class in svetlanna.elements.nonlinear_element)
NpyFileRepr (class in svetlanna.specs)
(class in svetlanna.specs.specs)
ns (svetlanna.units.ureg attribute)
number_of_iterations (svetlanna.phase_retrieval_problem.phase_retrieval_result.PhaseRetrievalResult attribute)
(svetlanna.phase_retrieval_problem.PhaseRetrievalResult attribute)
P
Parameter (class in svetlanna)
(class in svetlanna.parameters)
ParameterSaveContext (class in svetlanna.specs)
(class in svetlanna.specs.specs)
ParameterSpecs (class in svetlanna.specs)
(class in svetlanna.specs.specs)
phase (svetlanna.Wavefront property)
(svetlanna.wavefront.Wavefront property)
PhaseRetrievalResult (class in svetlanna.phase_retrieval_problem)
(class in svetlanna.phase_retrieval_problem.phase_retrieval_result)
pHz (svetlanna.units.ureg attribute)
plane_wave() (svetlanna.Wavefront class method)
(svetlanna.wavefront.Wavefront class method)
pm (svetlanna.units.ureg attribute)
pop_feedback_queue() (svetlanna.elements.reservoir.SimpleReservoir method)
(svetlanna.elements.SimpleReservoir method)
PrettyReprRepr (class in svetlanna.specs)
(class in svetlanna.specs.specs)
process_parameter() (svetlanna.elements.Element method)
(svetlanna.elements.element.Element method)
ps (svetlanna.units.ureg attribute)
R
RectangularAperture (class in svetlanna.elements)
(class in svetlanna.elements.aperture)
register_logging_hook() (in module svetlanna.logging)
rel_filepath() (svetlanna.specs.ParameterSaveContext method)
(svetlanna.specs.specs.ParameterSaveContext method)
Representation (class in svetlanna.specs)
(class in svetlanna.specs.specs)
ReprRepr (class in svetlanna.specs)
(class in svetlanna.specs.specs)
resized_mask (svetlanna.elements.slm.SpatialLightModulator property)
(svetlanna.elements.SpatialLightModulator property)
resume (svetlanna.clerk.ClerkMode attribute)
retrieve_phase() (in module svetlanna.phase_retrieval_problem)
(in module svetlanna.phase_retrieval_problem.phase_retrieval)
reverse() (svetlanna.elements.diffractive_layer.DiffractiveLayer method)
(svetlanna.elements.DiffractiveLayer method)
(svetlanna.elements.free_space.FreeSpace method)
(svetlanna.elements.FreeSpace method)
(svetlanna.elements.lens.ThinLens method)
(svetlanna.elements.slm.SpatialLightModulator method)
(svetlanna.elements.SpatialLightModulator method)
(svetlanna.elements.ThinLens method)
(svetlanna.LinearOpticalSetup method)
(svetlanna.phase_retrieval_problem.phase_retrieval.SetupLike method)
(svetlanna.phase_retrieval_problem.SetupLike method)
(svetlanna.setup.LinearOpticalSetup method)
RoundAperture (class in svetlanna.elements)
(class in svetlanna.elements.aperture)
S
s (svetlanna.units.ureg attribute)
save_conditions() (svetlanna.Clerk method)
(svetlanna.clerk.Clerk method)
save_to_file() (svetlanna.specs.NpyFileRepr method)
(svetlanna.specs.specs.NpyFileRepr method)
set_checkpoint_targets() (svetlanna.Clerk method)
(svetlanna.clerk.Clerk method)
set_debug_logging() (in module svetlanna)
(in module svetlanna.logging)
SetupLike (class in svetlanna.phase_retrieval_problem)
(class in svetlanna.phase_retrieval_problem.phase_retrieval)
show_specs() (in module svetlanna.visualization)
(in module svetlanna.visualization.widgets)
show_stepwise_forward() (in module svetlanna.visualization)
(in module svetlanna.visualization.widgets)
show_structure() (in module svetlanna.visualization)
(in module svetlanna.visualization.widgets)
sigmoid_inv() (in module svetlanna.parameters)
SimpleReservoir (class in svetlanna.elements)
(class in svetlanna.elements.reservoir)
SimulationParameters (class in svetlanna)
(class in svetlanna.simulation_parameters)
solution (svetlanna.phase_retrieval_problem.phase_retrieval_result.PhaseRetrievalResult attribute)
(svetlanna.phase_retrieval_problem.PhaseRetrievalResult attribute)
SpatialLightModulator (class in svetlanna.elements)
(class in svetlanna.elements.slm)
Specsable (class in svetlanna.specs)
(class in svetlanna.specs.specs)
SpecsWidget (class in svetlanna.visualization.widgets)
spherical_wave() (svetlanna.Wavefront class method)
(svetlanna.wavefront.Wavefront class method)
state_dict() (svetlanna.clerk.StatefulTorchClass method)
StatefulTorchClass (class in svetlanna.clerk)
stepwise_forward() (svetlanna.LinearOpticalSetup method)
(svetlanna.setup.LinearOpticalSetup method)
StepwiseForwardWidget (class in svetlanna.visualization.widgets)
StrRepresentation (class in svetlanna.specs)
(class in svetlanna.specs.specs)
structure_html (svetlanna.visualization.widgets.SpecsWidget attribute)
(svetlanna.visualization.widgets.StepwiseForwardWidget attribute)
SubelementSpecs (class in svetlanna.specs)
(class in svetlanna.specs.specs)
svetlanna
module
svetlanna.axes_math
module
svetlanna.clerk
module
svetlanna.detector
module
svetlanna.elements
module
svetlanna.elements.aperture
module
svetlanna.elements.diffractive_layer
module
svetlanna.elements.element
module
svetlanna.elements.free_space
module
svetlanna.elements.lens
module
svetlanna.elements.nonlinear_element
module
svetlanna.elements.reservoir
module
svetlanna.elements.slm
module
svetlanna.logging
module
svetlanna.networks
module
svetlanna.networks.autoencoder
module
svetlanna.networks.diffractive_conv
module
svetlanna.networks.diffractive_rnn
module
svetlanna.parameters
module
svetlanna.phase_retrieval_problem
module
svetlanna.phase_retrieval_problem.algorithms
module
svetlanna.phase_retrieval_problem.phase_retrieval
module
svetlanna.phase_retrieval_problem.phase_retrieval_result
module
svetlanna.setup
module
svetlanna.simulation_parameters
module
svetlanna.specs
module
svetlanna.specs.specs
module
svetlanna.specs.specs_writer
module
svetlanna.transforms
module
svetlanna.units
module
svetlanna.visualization
module
svetlanna.visualization.widgets
module
svetlanna.wavefront
module
T
tensor_dot() (in module svetlanna.axes_math)
ThinLens (class in svetlanna.elements)
(class in svetlanna.elements.lens)
to() (svetlanna.detector.DetectorProcessorClf method)
(svetlanna.networks.autoencoder.LinearAutoencoder method)
(svetlanna.networks.diffractive_conv.ConvDiffNetwork4F method)
(svetlanna.networks.diffractive_rnn.DiffractiveRNN method)
(svetlanna.simulation_parameters.SimulationParameters method)
(svetlanna.SimulationParameters method)
to_html() (svetlanna.specs.HTMLRepresentation method)
(svetlanna.specs.ImageRepr method)
(svetlanna.specs.PrettyReprRepr method)
(svetlanna.specs.ReprRepr method)
(svetlanna.specs.specs.HTMLRepresentation method)
(svetlanna.specs.specs.ImageRepr method)
(svetlanna.specs.specs.PrettyReprRepr method)
(svetlanna.specs.specs.ReprRepr method)
to_markdown() (svetlanna.specs.ImageRepr method)
(svetlanna.specs.MarkdownRepresentation method)
(svetlanna.specs.NpyFileRepr method)
(svetlanna.specs.PrettyReprRepr method)
(svetlanna.specs.ReprRepr method)
(svetlanna.specs.specs.ImageRepr method)
(svetlanna.specs.specs.MarkdownRepresentation method)
(svetlanna.specs.specs.NpyFileRepr method)
(svetlanna.specs.specs.PrettyReprRepr method)
(svetlanna.specs.specs.ReprRepr method)
to_specs() (svetlanna.elements.Aperture method)
(svetlanna.elements.aperture.Aperture method)
(svetlanna.elements.aperture.RectangularAperture method)
(svetlanna.elements.aperture.RoundAperture method)
(svetlanna.elements.diffractive_layer.DiffractiveLayer method)
(svetlanna.elements.DiffractiveLayer method)
(svetlanna.elements.Element method)
(svetlanna.elements.element.Element method)
(svetlanna.elements.free_space.FreeSpace method)
(svetlanna.elements.FreeSpace method)
(svetlanna.elements.lens.ThinLens method)
(svetlanna.elements.RectangularAperture method)
(svetlanna.elements.reservoir.SimpleReservoir method)
(svetlanna.elements.RoundAperture method)
(svetlanna.elements.SimpleReservoir method)
(svetlanna.elements.ThinLens method)
(svetlanna.LinearOpticalSetup method)
(svetlanna.setup.LinearOpticalSetup method)
(svetlanna.specs.specs.Specsable method)
(svetlanna.specs.Specsable method)
to_str() (svetlanna.specs.ImageRepr method)
(svetlanna.specs.NpyFileRepr method)
(svetlanna.specs.PrettyReprRepr method)
(svetlanna.specs.ReprRepr method)
(svetlanna.specs.specs.ImageRepr method)
(svetlanna.specs.specs.NpyFileRepr method)
(svetlanna.specs.specs.PrettyReprRepr method)
(svetlanna.specs.specs.ReprRepr method)
(svetlanna.specs.specs.StrRepresentation method)
(svetlanna.specs.StrRepresentation method)
tol (svetlanna.phase_retrieval_problem.phase_retrieval.AlgorithmOptions attribute)
ToWavefront (class in svetlanna.transforms)
transmission_function (svetlanna.elements.diffractive_layer.DiffractiveLayer property)
(svetlanna.elements.DiffractiveLayer property)
(svetlanna.elements.lens.ThinLens property)
(svetlanna.elements.slm.SpatialLightModulator property)
(svetlanna.elements.SpatialLightModulator property)
(svetlanna.elements.ThinLens property)
transmission_function_axes (svetlanna.elements.Aperture property)
(svetlanna.elements.aperture.Aperture property)
(svetlanna.elements.aperture.MulElement property)
(svetlanna.elements.aperture.RectangularAperture property)
(svetlanna.elements.aperture.RoundAperture property)
(svetlanna.elements.RectangularAperture property)
(svetlanna.elements.RoundAperture property)
U
uHz (svetlanna.units.ureg attribute)
um (svetlanna.units.ureg attribute)
ureg (class in svetlanna.units)
us (svetlanna.units.ureg attribute)
V
value (svetlanna.ConstrainedParameter property)
(svetlanna.parameters.ConstrainedParameter property)
W
Wavefront (class in svetlanna)
(class in svetlanna.wavefront)
weight_segments() (svetlanna.detector.DetectorProcessorClf method)
write_checkpoint() (svetlanna.Clerk method)
(svetlanna.clerk.Clerk method)
write_elements_tree_to_markdown() (in module svetlanna.specs.specs_writer)
write_elements_tree_to_str() (in module svetlanna.specs.specs_writer)
write_log() (svetlanna.Clerk method)
(svetlanna.clerk.Clerk method)
write_specs() (in module svetlanna.specs.specs_writer)
write_specs_to_html() (in module svetlanna.specs.specs_writer)
write_specs_to_markdown() (in module svetlanna.specs.specs_writer)
write_specs_to_str() (in module svetlanna.specs.specs_writer)