telescope-sim
Getting Started
Getting started
User guide
Architecture & concepts
Configuration reference
Tutorials
1. Canonical mini-ELF
2. Vortex coronagraph
3. Custom pupil + Zernike DM (VAMPIRES)
4. Fiber MMF coupling
5. Extending telescope-sim with custom components
6. Actuator-grid DM with baked-in misalignment
API reference
API reference
telescope-sim
Index
Index
A
|
B
|
C
|
E
|
F
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
V
|
W
|
Z
A
ActuatorGridCorrector (class in telescope_sim.correctors.actuator_grid)
actuators (telescope_sim.abc.Corrector property)
(telescope_sim.abc.corrector.Corrector property)
(telescope_sim.correctors.actuator_grid.ActuatorGridCorrector property)
(telescope_sim.correctors.segmented_ptt.SegmentedPTTCorrector property)
(telescope_sim.correctors.zernike.ZernikeCorrector property)
AngularFocalPlane (class in telescope_sim.focal_planes.angular)
Aperture (class in telescope_sim.abc)
(class in telescope_sim.abc.aperture)
aperture (telescope_sim.config.schema.SimConfig attribute)
(telescope_sim.pipeline.TelescopeSim property)
(telescope_sim.TelescopeSim property)
ApertureResult (class in telescope_sim.abc)
(class in telescope_sim.abc.aperture)
apply() (telescope_sim.abc.Coronagraph method)
(telescope_sim.abc.coronagraph.Coronagraph method)
(telescope_sim.abc.Corrector method)
(telescope_sim.abc.corrector.Corrector method)
(telescope_sim.coronagraphs.standard.IdentityCoronagraph method)
(telescope_sim.coronagraphs.standard.VectorVortexCoronagraphImpl method)
(telescope_sim.coronagraphs.standard.VortexCoronagraphImpl method)
(telescope_sim.correctors.actuator_grid.ActuatorGridCorrector method)
(telescope_sim.correctors.segmented_ptt.SegmentedPTTCorrector method)
(telescope_sim.correctors.zernike.ZernikeCorrector method)
area (telescope_sim.abc.aperture.ApertureResult attribute)
,
[1]
(telescope_sim.abc.ApertureResult attribute)
,
[1]
(telescope_sim.apertures.external_pupil.ExternalPupilAperture attribute)
available() (in module telescope_sim.registry)
B
build() (in module telescope_sim.config.loader)
(telescope_sim.abc.Aperture method)
(telescope_sim.abc.aperture.Aperture method)
(telescope_sim.apertures.external_pupil.ExternalPupilAperture method)
(telescope_sim.apertures.segmented_circular.SegmentedCircularAperture method)
(telescope_sim.focal_planes.angular.AngularFocalPlane method)
(telescope_sim.focal_planes.physical.PhysicalFocalPlane method)
build_from_preset() (in module telescope_sim.config.loader)
build_from_yaml() (in module telescope_sim.config.loader)
build_strehl_estimator() (in module telescope_sim.strehl)
C
ChannelsFirst (class in telescope_sim.post.normalization)
compute() (telescope_sim.strehl.StrehlEstimator method)
compute_reference_psf() (telescope_sim.focal_planes.angular.AngularFocalPlane method)
(telescope_sim.focal_planes.physical.PhysicalFocalPlane method)
ConvolveImagePostProcessor (class in telescope_sim.post.convolve)
Coronagraph (class in telescope_sim.abc)
(class in telescope_sim.abc.coronagraph)
coronagraph (telescope_sim.config.schema.SimConfig attribute)
Corrector (class in telescope_sim.abc)
(class in telescope_sim.abc.corrector)
corrector_chain (telescope_sim.config.schema.SimConfig attribute)
CorrectorConfig (class in telescope_sim.config.schema)
correctors (telescope_sim.config.schema.SimConfig attribute)
(telescope_sim.pipeline.TelescopeSim property)
(telescope_sim.TelescopeSim property)
E
extent (telescope_sim.config.schema.PupilConfig attribute)
ExternalPupilAperture (class in telescope_sim.apertures.external_pupil)
extract() (telescope_sim.abc.output_tap.OutputTap method)
(telescope_sim.abc.OutputTap method)
(telescope_sim.outputs.fiber_dual.FiberDualOutputTap method)
(telescope_sim.outputs.intensity.IntensityOutputTap method)
extras (telescope_sim.abc.PipelineContext attribute)
(telescope_sim.abc.post_processor.PipelineContext attribute)
F
FiberDualOutputTap (class in telescope_sim.outputs.fiber_dual)
field (telescope_sim.abc.aperture.ApertureResult attribute)
,
[1]
(telescope_sim.abc.ApertureResult attribute)
,
[1]
fit_source (telescope_sim.abc.Corrector attribute)
(telescope_sim.abc.corrector.Corrector attribute)
(telescope_sim.config.schema.CorrectorConfig attribute)
fit_surface() (telescope_sim.abc.Corrector method)
(telescope_sim.abc.corrector.Corrector method)
(telescope_sim.correctors.actuator_grid.ActuatorGridCorrector method)
(telescope_sim.correctors.segmented_ptt.SegmentedPTTCorrector method)
(telescope_sim.correctors.zernike.ZernikeCorrector method)
flatten() (telescope_sim.abc.Corrector method)
(telescope_sim.abc.corrector.Corrector method)
(telescope_sim.correctors.actuator_grid.ActuatorGridCorrector method)
(telescope_sim.correctors.segmented_ptt.SegmentedPTTCorrector method)
(telescope_sim.correctors.zernike.ZernikeCorrector method)
focal_plane_name (telescope_sim.abc.PipelineContext attribute)
(telescope_sim.abc.post_processor.PipelineContext attribute)
focal_planes (telescope_sim.config.schema.SimConfig attribute)
(telescope_sim.pipeline.TelescopeSim property)
(telescope_sim.TelescopeSim property)
FocalPlane (class in telescope_sim.abc)
(class in telescope_sim.abc.focal_plane)
FocalPlaneResult (class in telescope_sim.focal_planes.physical)
from_components() (telescope_sim.pipeline.TelescopeSim class method)
(telescope_sim.TelescopeSim class method)
from_preset() (telescope_sim.pipeline.TelescopeSim class method)
(telescope_sim.TelescopeSim class method)
from_yaml() (telescope_sim.pipeline.TelescopeSim class method)
(telescope_sim.TelescopeSim class method)
function (telescope_sim.apertures.external_pupil.ExternalPupilAperture attribute)
I
IdentityCoronagraph (class in telescope_sim.coronagraphs.standard)
integrate() (telescope_sim.abc.focal_plane.FocalPlane method)
(telescope_sim.abc.FocalPlane method)
intensity (telescope_sim.focal_planes.physical.FocalPlaneResult attribute)
IntensityOutputTap (class in telescope_sim.outputs.intensity)
K
kwargs (telescope_sim.apertures.external_pupil.ExternalPupilAperture attribute)
L
lam_setup (telescope_sim.focal_planes.angular.AngularFocalPlane property)
(telescope_sim.focal_planes.physical.PhysicalFocalPlane property)
layout (telescope_sim.apertures.segmented_circular.SegmentedCircularAperture attribute)
load_yaml() (in module telescope_sim.config.loader)
LoaderBindable (class in telescope_sim.abc)
(class in telescope_sim.abc.post_processor)
lookup() (in module telescope_sim.registry)
M
MaxImageNorm (class in telescope_sim.post.normalization)
MaxIntensityNorm (class in telescope_sim.post.normalization)
metadata (telescope_sim.abc.aperture.ApertureResult attribute)
(telescope_sim.abc.ApertureResult attribute)
mode (telescope_sim.apertures.external_pupil.ExternalPupilAperture attribute)
model_config (telescope_sim.config.schema.CorrectorConfig attribute)
(telescope_sim.config.schema.OutputConfig attribute)
(telescope_sim.config.schema.PostProcessorConfig attribute)
(telescope_sim.config.schema.PupilConfig attribute)
(telescope_sim.config.schema.SimConfig attribute)
(telescope_sim.config.schema.StageConfig attribute)
module
telescope_sim
telescope_sim.abc
telescope_sim.abc.aperture
telescope_sim.abc.coronagraph
telescope_sim.abc.corrector
telescope_sim.abc.focal_plane
telescope_sim.abc.output_tap
telescope_sim.abc.post_processor
telescope_sim.apertures.external_pupil
telescope_sim.apertures.segmented_circular
telescope_sim.config.loader
telescope_sim.config.schema
telescope_sim.coronagraphs.standard
telescope_sim.correctors.actuator_grid
telescope_sim.correctors.segmented_ptt
telescope_sim.correctors.zernike
telescope_sim.focal_planes.angular
telescope_sim.focal_planes.physical
telescope_sim.helpers.diagnostics
telescope_sim.outputs.fiber_dual
telescope_sim.outputs.intensity
telescope_sim.pipeline
telescope_sim.post.convolve
telescope_sim.post.noisy_detector
telescope_sim.post.normalization
telescope_sim.registry
telescope_sim.strehl
module (telescope_sim.apertures.external_pupil.ExternalPupilAperture attribute)
N
n_actuators (telescope_sim.abc.Corrector property)
(telescope_sim.abc.corrector.Corrector property)
(telescope_sim.correctors.actuator_grid.ActuatorGridCorrector property)
(telescope_sim.correctors.segmented_ptt.SegmentedPTTCorrector property)
(telescope_sim.correctors.zernike.ZernikeCorrector property)
n_segments (telescope_sim.apertures.segmented_circular.SegmentedCircularAperture attribute)
name (telescope_sim.abc.Coronagraph attribute)
(telescope_sim.abc.coronagraph.Coronagraph attribute)
(telescope_sim.abc.Corrector attribute)
(telescope_sim.abc.corrector.Corrector attribute)
(telescope_sim.abc.focal_plane.FocalPlane attribute)
(telescope_sim.abc.FocalPlane attribute)
(telescope_sim.abc.output_tap.OutputTap attribute)
(telescope_sim.abc.OutputTap attribute)
(telescope_sim.abc.post_processor.PostProcessor attribute)
(telescope_sim.abc.PostProcessor attribute)
(telescope_sim.coronagraphs.standard.IdentityCoronagraph attribute)
(telescope_sim.coronagraphs.standard.VectorVortexCoronagraphImpl attribute)
(telescope_sim.coronagraphs.standard.VortexCoronagraphImpl attribute)
(telescope_sim.post.convolve.ConvolveImagePostProcessor attribute)
(telescope_sim.post.noisy_detector.NoisyDetectorPostProcessor attribute)
(telescope_sim.post.normalization.ChannelsFirst attribute)
(telescope_sim.post.normalization.MaxImageNorm attribute)
(telescope_sim.post.normalization.MaxIntensityNorm attribute)
(telescope_sim.post.normalization.PerSampleNorm attribute)
NoisyDetectorPostProcessor (class in telescope_sim.post.noisy_detector)
O
output_name (telescope_sim.abc.PipelineContext attribute)
(telescope_sim.abc.post_processor.PipelineContext attribute)
OutputConfig (class in telescope_sim.config.schema)
outputs (telescope_sim.config.schema.SimConfig attribute)
OutputTap (class in telescope_sim.abc)
(class in telescope_sim.abc.output_tap)
overrides (telescope_sim.abc.PipelineContext attribute)
(telescope_sim.abc.post_processor.PipelineContext attribute)
P
PerSampleNorm (class in telescope_sim.post.normalization)
PhysicalFocalPlane (class in telescope_sim.focal_planes.physical)
PipelineContext (class in telescope_sim.abc)
(class in telescope_sim.abc.post_processor)
plot_opd_and_psfs() (in module telescope_sim.helpers.diagnostics)
positions (telescope_sim.apertures.segmented_circular.SegmentedCircularAperture attribute)
post_processing (telescope_sim.config.schema.OutputConfig attribute)
PostProcessor (class in telescope_sim.abc)
(class in telescope_sim.abc.post_processor)
PostProcessorConfig (class in telescope_sim.config.schema)
propagate() (telescope_sim.abc.focal_plane.FocalPlane method)
(telescope_sim.abc.FocalPlane method)
(telescope_sim.focal_planes.angular.AngularFocalPlane method)
(telescope_sim.focal_planes.physical.PhysicalFocalPlane method)
pupil (telescope_sim.config.schema.SimConfig attribute)
PupilConfig (class in telescope_sim.config.schema)
R
reference_peak_intensity (telescope_sim.abc.PipelineContext attribute)
(telescope_sim.abc.post_processor.PipelineContext attribute)
(telescope_sim.focal_planes.angular.AngularFocalPlane property)
(telescope_sim.focal_planes.physical.PhysicalFocalPlane property)
reference_psf (telescope_sim.focal_planes.angular.AngularFocalPlane property)
(telescope_sim.focal_planes.physical.PhysicalFocalPlane property)
reference_psf_sum (telescope_sim.abc.PipelineContext attribute)
(telescope_sim.abc.post_processor.PipelineContext attribute)
(telescope_sim.focal_planes.angular.AngularFocalPlane property)
(telescope_sim.focal_planes.physical.PhysicalFocalPlane property)
register() (in module telescope_sim)
(in module telescope_sim.registry)
resolution (telescope_sim.config.schema.PupilConfig attribute)
ring_radius (telescope_sim.apertures.segmented_circular.SegmentedCircularAperture attribute)
S
sample() (telescope_sim.pipeline.TelescopeSim method)
(telescope_sim.TelescopeSim method)
segment_coords (telescope_sim.abc.aperture.ApertureResult attribute)
,
[1]
(telescope_sim.abc.ApertureResult attribute)
,
[1]
(telescope_sim.correctors.segmented_ptt.SegmentedPTTCorrector property)
segment_diameter (telescope_sim.apertures.segmented_circular.SegmentedCircularAperture attribute)
SegmentedCircularAperture (class in telescope_sim.apertures.segmented_circular)
SegmentedPTTCorrector (class in telescope_sim.correctors.segmented_ptt)
segments (telescope_sim.abc.aperture.ApertureResult attribute)
,
[1]
(telescope_sim.abc.ApertureResult attribute)
,
[1]
set_actuators() (telescope_sim.abc.Corrector method)
(telescope_sim.abc.corrector.Corrector method)
(telescope_sim.correctors.actuator_grid.ActuatorGridCorrector method)
(telescope_sim.correctors.segmented_ptt.SegmentedPTTCorrector method)
(telescope_sim.correctors.zernike.ZernikeCorrector method)
SimConfig (class in telescope_sim.config.schema)
source (telescope_sim.abc.output_tap.OutputTap attribute)
(telescope_sim.abc.OutputTap attribute)
spider (telescope_sim.apertures.segmented_circular.SegmentedCircularAperture attribute)
StageConfig (class in telescope_sim.config.schema)
strehl_core_rad (telescope_sim.config.schema.SimConfig attribute)
strehl_method (telescope_sim.config.schema.SimConfig attribute)
StrehlEstimator (class in telescope_sim.strehl)
supersample (telescope_sim.apertures.external_pupil.ExternalPupilAperture attribute)
(telescope_sim.apertures.segmented_circular.SegmentedCircularAperture attribute)
T
tap (telescope_sim.config.schema.OutputConfig attribute)
target (telescope_sim.abc.Corrector attribute)
(telescope_sim.abc.corrector.Corrector attribute)
(telescope_sim.config.schema.CorrectorConfig attribute)
target_strategy (telescope_sim.abc.Corrector attribute)
(telescope_sim.abc.corrector.Corrector attribute)
(telescope_sim.config.schema.CorrectorConfig attribute)
telescope_sim
module
telescope_sim.abc
module
telescope_sim.abc.aperture
module
telescope_sim.abc.coronagraph
module
telescope_sim.abc.corrector
module
telescope_sim.abc.focal_plane
module
telescope_sim.abc.output_tap
module
telescope_sim.abc.post_processor
module
telescope_sim.apertures.external_pupil
module
telescope_sim.apertures.segmented_circular
module
telescope_sim.config.loader
module
telescope_sim.config.schema
module
telescope_sim.coronagraphs.standard
module
telescope_sim.correctors.actuator_grid
module
telescope_sim.correctors.segmented_ptt
module
telescope_sim.correctors.zernike
module
telescope_sim.focal_planes.angular
module
telescope_sim.focal_planes.physical
module
telescope_sim.helpers.diagnostics
module
telescope_sim.outputs.fiber_dual
module
telescope_sim.outputs.intensity
module
telescope_sim.pipeline
module
telescope_sim.post.convolve
module
telescope_sim.post.noisy_detector
module
telescope_sim.post.normalization
module
telescope_sim.registry
module
telescope_sim.strehl
module
TelescopeSim (class in telescope_sim)
(class in telescope_sim.pipeline)
type (telescope_sim.config.schema.PostProcessorConfig attribute)
(telescope_sim.config.schema.StageConfig attribute)
V
VectorVortexCoronagraphImpl (class in telescope_sim.coronagraphs.standard)
VortexCoronagraphImpl (class in telescope_sim.coronagraphs.standard)
W
wavefront_role (telescope_sim.abc.Corrector attribute)
(telescope_sim.abc.corrector.Corrector attribute)
(telescope_sim.config.schema.CorrectorConfig attribute)
wavefronts (telescope_sim.focal_planes.physical.FocalPlaneResult attribute)
Z
ZernikeCorrector (class in telescope_sim.correctors.zernike)