Optics

class esis.optics.optics.Optics(name=<factory>, wavelengths=<Quantity 0. nm>, pupil_samples=10, field_samples=10, source=<factory>, front_aperture=<factory>, central_obscuration=<factory>, primary=<factory>, field_stop=<factory>, grating=<factory>, filter=<factory>, detector=<factory>)

Bases: kgpy.mixin.Named

Add test docstring to see if this is the problem.

__init__(name=<factory>, wavelengths=<Quantity 0. nm>, pupil_samples=10, field_samples=10, source=<factory>, front_aperture=<factory>, central_obscuration=<factory>, primary=<factory>, field_stop=<factory>, grating=<factory>, filter=<factory>, detector=<factory>)

Initialize self. See help(type(self)) for accurate signature.

Parameters

• name (kgpy.Name) –

• wavelengths (astropy.units.Quantity) –

• pupil_samples (int) –

• field_samples (int) –

• source (esis.optics.source.Source) –

• front_aperture (esis.optics.front_aperture.FrontAperture) –

• central_obscuration (esis.optics.central_obscuration.CentralObscuration) –

• primary (esis.optics.primary.Primary) –

• field_stop (esis.optics.field_stop.FieldStop) –

• grating (esis.optics.grating.Grating) –

• filter (esis.optics.filter.Filter) –

• detector (esis.optics.detector.Detector) –

Return type

None

Attributes

back_focal_length	rtype astropy.units.Quantity
dataframe	rtype pandas.DataFrame
effective_focal_length	rtype astropy.units.Quantity
field_samples
magnification	rtype astropy.units.Quantity
num_channels	rtype int
pixel_subtent
pupil_samples
rays_output	rtype kgpy.optics.rays.Rays
system	rtype kgpy.optics.System
wavelengths

Methods

__init__([name, wavelengths, pupil_samples, …])	Initialize self.
apply_poletto_layout(wavelength_1, …[, …])	rtype esis.optics.optics.Optics
copy()	rtype esis.optics.optics.Optics
fit_to_images(images[, global_search, …])	rtype esis.optics.optics.Optics
rough_fit_to_images(images, spatial_samples)	rtype esis.optics.optics.Optics
update()	rtype typing.NoReturn

Inheritance Diagram

apply_poletto_layout(wavelength_1, wavelength_2, magnification, obscuration_margin, obscuration_thickness, image_margin, detector_is_opposite_grating=False, use_toroidal_grating=False, use_vls_grating=False)

Return type

esis.optics.optics.Optics

Parameters

• wavelength_1 (astropy.units.Quantity) –

• wavelength_2 (astropy.units.Quantity) –

• magnification (astropy.units.Quantity) –

• obscuration_margin (astropy.units.Quantity) –

• obscuration_thickness (astropy.units.Quantity) –

• image_margin (astropy.units.Quantity) –

• detector_is_opposite_grating (bool) –

• use_toroidal_grating (bool) –

• use_vls_grating (bool) –

copy()

Return type

esis.optics.optics.Optics

fit_to_images(images, global_search=True, local_search=True, global_samples=128, local_samples=256)

Return type

esis.optics.optics.Optics

Parameters

• images (astropy.units.Quantity) –

• global_search (bool) –

• local_search (bool) –

• global_samples (int) –

• local_samples (int) –

rough_fit_to_images(images, spatial_samples)

Return type

esis.optics.optics.Optics

Parameters

• images (astropy.units.Quantity) –

• spatial_samples (100) –

update()

Return type

typing.NoReturn

property back_focal_length

Return type

astropy.units.Quantity

central_obscuration: esis.optics.central_obscuration.CentralObscuration

property dataframe

Return type

pandas.DataFrame

detector: esis.optics.detector.Detector

property effective_focal_length

Return type

astropy.units.Quantity

field_samples: int = 10

field_stop: esis.optics.field_stop.FieldStop

filter: esis.optics.filter.Filter

front_aperture: esis.optics.front_aperture.FrontAperture

grating: esis.optics.grating.Grating

property magnification

Return type

astropy.units.Quantity

name: kgpy.Name

property num_channels

Return type

int

property pixel_subtent

primary: esis.optics.primary.Primary

pupil_samples: int = 10

property rays_output

Return type

kgpy.optics.rays.Rays

source: esis.optics.source.Source

property system

Return type

kgpy.optics.System

wavelengths: astropy.units.Quantity = <Quantity 0. nm>