Command reference

• svetlanna
  • Subpackages
    • svetlanna.elements package
      • Submodules
      • 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
      • Module contents
    • svetlanna.networks package
      • Submodules
      • svetlanna.networks.autoencoder module
      • svetlanna.networks.diffractive_conv module
      • svetlanna.networks.diffractive_rnn module
      • Module contents
    • svetlanna.phase_retrieval_problem package
      • Submodules
      • svetlanna.phase_retrieval_problem.algorithms module
      • svetlanna.phase_retrieval_problem.phase_retrieval module
      • svetlanna.phase_retrieval_problem.phase_retrieval_result module
      • Module contents
    • svetlanna.specs package
      • Submodules
      • svetlanna.specs.specs module
      • svetlanna.specs.specs_writer module
      • Module contents
    • svetlanna.visualization package
      • Submodules
      • svetlanna.visualization.widgets module
      • Module contents
  • Submodules
  • svetlanna.axes_math module
    • cast_tensor()
    • is_scalar()
    • tensor_dot()
  • svetlanna.clerk module
    • Clerk
      • Clerk.begin()
      • Clerk.clean_backup_checkpoints()
      • Clerk.clean_checkpoints()
      • Clerk.load_checkpoint()
      • Clerk.load_conditions()
      • Clerk.load_logs()
      • Clerk.load_logs_to_pandas()
      • Clerk.save_conditions()
      • Clerk.set_checkpoint_targets()
      • Clerk.write_checkpoint()
      • Clerk.write_log()
    • ClerkMode
      • ClerkMode.new_run
      • ClerkMode.resume
    • StatefulTorchClass
      • StatefulTorchClass.load_state_dict()
      • StatefulTorchClass.state_dict()
  • svetlanna.detector module
    • Detector
      • Detector.forward()
    • DetectorProcessorClf
      • DetectorProcessorClf.batch_forward()
      • DetectorProcessorClf.batch_zone_integral()
      • DetectorProcessorClf.detector_segmentation()
      • DetectorProcessorClf.device
      • DetectorProcessorClf.forward()
      • DetectorProcessorClf.to()
      • DetectorProcessorClf.weight_segments()
  • svetlanna.logging module
    • agr_short_description()
    • forward_logging_hook()
    • log_message()
    • register_logging_hook()
    • set_debug_logging()
  • svetlanna.parameters module
    • ConstrainedParameter
      • ConstrainedParameter.value
    • InnerParameterStorageModule
      • InnerParameterStorageModule.expand()
    • Parameter
    • sigmoid_inv()
  • svetlanna.setup module
    • LinearOpticalSetup
      • LinearOpticalSetup.forward()
      • LinearOpticalSetup.reverse()
      • LinearOpticalSetup.stepwise_forward()
      • LinearOpticalSetup.to_specs()
  • svetlanna.simulation_parameters module
    • Axes
      • Axes.index()
      • Axes.names
    • AxisNotFound
    • SimulationParameters
      • SimulationParameters.axes_size()
      • SimulationParameters.device
      • SimulationParameters.meshgrid()
      • SimulationParameters.to()
  • svetlanna.transforms module
    • GaussModulation
      • GaussModulation.forward()
      • GaussModulation.get_gauss()
    • ToWavefront
      • ToWavefront.forward()
  • svetlanna.units module
    • ureg
      • ureg.GHz
      • ureg.Gm
      • ureg.Gs
      • ureg.Hz
      • ureg.MHz
      • ureg.Mm
      • ureg.Ms
      • ureg.cHz
      • ureg.cm
      • ureg.cs
      • ureg.dHz
      • ureg.dm
      • ureg.ds
      • ureg.fs
      • ureg.kHz
      • ureg.km
      • ureg.ks
      • ureg.m
      • ureg.mHz
      • ureg.mm
      • ureg.ms
      • ureg.nHz
      • ureg.nm
      • ureg.ns
      • ureg.pHz
      • ureg.pm
      • ureg.ps
      • ureg.s
      • ureg.uHz
      • ureg.um
      • ureg.us
  • svetlanna.wavefront module
    • Wavefront
      • Wavefront.fwhm()
      • Wavefront.gaussian_beam()
      • Wavefront.intensity
      • Wavefront.max_intensity
      • Wavefront.phase
      • Wavefront.plane_wave()
      • Wavefront.spherical_wave()
    • mul()
  • Module contents
    • Clerk
      • Clerk.begin()
      • Clerk.clean_backup_checkpoints()
      • Clerk.clean_checkpoints()
      • Clerk.load_checkpoint()
      • Clerk.load_conditions()
      • Clerk.load_logs()
      • Clerk.load_logs_to_pandas()
      • Clerk.save_conditions()
      • Clerk.set_checkpoint_targets()
      • Clerk.write_checkpoint()
      • Clerk.write_log()
    • ConstrainedParameter
      • ConstrainedParameter.value
    • LinearOpticalSetup
      • LinearOpticalSetup.forward()
      • LinearOpticalSetup.reverse()
      • LinearOpticalSetup.stepwise_forward()
      • LinearOpticalSetup.to_specs()
    • Parameter
    • SimulationParameters
      • SimulationParameters.axes_size()
      • SimulationParameters.device
      • SimulationParameters.meshgrid()
      • SimulationParameters.to()
    • Wavefront
      • Wavefront.fwhm()
      • Wavefront.gaussian_beam()
      • Wavefront.intensity
      • Wavefront.max_intensity
      • Wavefront.phase
      • Wavefront.plane_wave()
      • Wavefront.spherical_wave()
    • set_debug_logging()