esbo_etc.classes.optical_component package

Submodules

esbo_etc.classes.optical_component.AHotOpticalComponent module

class esbo_etc.classes.optical_component.AHotOpticalComponent.AHotOpticalComponent(**func_kwargs)

Bases: esbo_etc.classes.optical_component.AOpticalComponent.AOpticalComponent

Abstract super class for an optical component with thermal emission

abstract static check_config(conf: esbo_etc.classes.Entry.Entry) → Union[None, str]

Check the configuration for this class

Parameters

conf (Entry) – The configuration entry to be checked.

Returns

mes (Union[None, str]) – The error message of the check. This will be None if the check was successful.

esbo_etc.classes.optical_component.AOpticalComponent module

class esbo_etc.classes.optical_component.AOpticalComponent.AOpticalComponent(**func_kwargs)

Bases: esbo_etc.classes.IRadiant.IRadiant

Abstract super class for an optical component

calcBackground() → esbo_etc.classes.SpectralQty.SpectralQty

Calculate the spectral radiance of the background

Returns

background (SpectralQty) – The spectral radiance of the background

calcSignal() → Tuple[esbo_etc.classes.SpectralQty.SpectralQty, float]

Calculate the spectral flux density of the target’s signal

Returns

• signal (SpectralQty) – The spectral flux density of the target’s signal

• obstruction (float) – The obstruction factor as A_ob / A_ap.

abstract static check_config(conf: esbo_etc.classes.Entry.Entry) → Union[None, str]

Check the configuration for this class

Parameters

conf (Entry) – The configuration entry to be checked.

Returns

mes (Union[None, str]) – The error message of the check. This will be None if the check was successful.

esbo_etc.classes.optical_component.ATRAN module

class esbo_etc.classes.optical_component.ATRAN.ATRAN(**func_kwargs)

Bases: esbo_etc.classes.optical_component.Atmosphere.Atmosphere

A class to model the atmosphere including the atmosphere’s spectral transmittance and emission.

ATRAN = 'https://atran.arc.nasa.gov'

static check_config(conf: esbo_etc.classes.Entry.Entry) → Union[None, str]

Check the configuration for this class

Parameters

conf (Entry) – The configuration entry to be checked.

Returns

mes (Union[None, str]) – The error message of the check. This will be None if the check was successful.

esbo_etc.classes.optical_component.Atmosphere module

class esbo_etc.classes.optical_component.Atmosphere.Atmosphere(**func_kwargs)

Bases: esbo_etc.classes.optical_component.AOpticalComponent.AOpticalComponent

A class to model the atmosphere including the atmosphere’s spectral transmittance and emission.

static check_config(conf: esbo_etc.classes.Entry.Entry) → Union[None, str]

Check the configuration for this class

Parameters

conf (Entry) – The configuration entry to be checked.

Returns

mes (Union[None, str]) – The error message of the check. This will be None if the check was successful.

esbo_etc.classes.optical_component.BeamSplitter module

class esbo_etc.classes.optical_component.BeamSplitter.BeamSplitter(**func_kwargs)

Bases: esbo_etc.classes.optical_component.AHotOpticalComponent.AHotOpticalComponent

A class to model the optical characteristics of a beam splitter.

static check_config(conf: esbo_etc.classes.Entry.Entry) → Union[None, str]

Check the configuration for this class

Parameters

conf (Entry) – The configuration entry to be checked.

Returns

mes (Union[None, str]) – The error message of the check. This will be None if the check was successful.

esbo_etc.classes.optical_component.CosmicBackground module

class esbo_etc.classes.optical_component.CosmicBackground.CosmicBackground(**func_kwargs)

Bases: esbo_etc.classes.optical_component.AOpticalComponent.AOpticalComponent

This class models the spectral radiance of the cosmic background as black body radiator

static check_config(conf: esbo_etc.classes.Entry.Entry) → Union[None, str]

Check the configuration for this class

Parameters

conf (Entry) – The configuration entry to be checked.

Returns

mes (Union[None, str]) – The error message of the check. This will be None if the check was successful.

esbo_etc.classes.optical_component.Filter module

class esbo_etc.classes.optical_component.Filter.Filter(**kwargs)

Bases: esbo_etc.classes.optical_component.AHotOpticalComponent.AHotOpticalComponent

A class to model a filter component and its thermal emission. The model can be created from a file, the name of a band or a custom spectral range.

__init__(**kwargs)

Instantiate a new filter model

Parameters

• parent (IRadiant) – The parent element of the optical component from which the electromagnetic radiation is received.

• transmittance (str) – Path to the file containing the spectral transmittance-coefficients of the filter element. The format of the file will be guessed by astropy.io.ascii.read().

• band (str) – The spectral band of the filter. Can be one of [U, B, V, R, I, J, H, K].

• start (length-quantity) – Start wavelength of the pass-band

• end (length-quantity) – End wavelength of the pass-band

• emissivity (Union[str, float]) – The spectral emissivity coefficient for the optical surface.

• temp (Quantity in Kelvin / Celsius) – Temperature of the optical component

• obstruction (float) – The additional obstruction factor of the optical component. 0 means the component is not obstructed, 1 denotes a completely obstructed component with therefore no incoming flux. It is important to note, that the obstruction factor reflects the obstruction of the optical component additionally to the obstruction factors of the prior elements in the beam.

• obstructor_temp (Quantity in Kelvin / Celsius) – Temperature of the obstructing component.

• obstructor_emissivity (float) – Emissivity of the obstructing component.

static check_config(conf: esbo_etc.classes.Entry.Entry) → Union[None, str]

Check the configuration for this class

Parameters

conf (Entry) – The configuration entry to be checked.

Returns

mes (Union[None, str]) – The error message of the check. This will be None if the check was successful.

esbo_etc.classes.optical_component.Lens module

class esbo_etc.classes.optical_component.Lens.Lens(**func_kwargs)

Bases: esbo_etc.classes.optical_component.AHotOpticalComponent.AHotOpticalComponent

A class to model the optical characteristics of a lens.

static check_config(conf: esbo_etc.classes.Entry.Entry) → Union[None, str]

Check the configuration for this class

Parameters

conf (Entry) – The configuration entry to be checked.

Returns

mes (Union[None, str]) – The error message of the check. This will be None if the check was successful.

esbo_etc.classes.optical_component.Mirror module

class esbo_etc.classes.optical_component.Mirror.Mirror(**func_kwargs)

Bases: esbo_etc.classes.optical_component.AHotOpticalComponent.AHotOpticalComponent

A class to model the optical characteristics of a mirror.

static check_config(conf: esbo_etc.classes.Entry.Entry) → Union[None, str]

Check the configuration for this class

Parameters

conf (Entry) – The configuration entry to be checked.

Returns

mes (Union[None, str]) – The error message of the check. This will be None if the check was successful.

esbo_etc.classes.optical_component.OpticalComponentFactory module

class esbo_etc.classes.optical_component.OpticalComponentFactory.OpticalComponentFactory(common_conf: esbo_etc.classes.Entry.Entry)

Bases: esbo_etc.classes.ARadiantFactory.ARadiantFactory

A Factory creating objects of the type IRadiant

__init__(common_conf: esbo_etc.classes.Entry.Entry)

Instantiate a new factory object

Parameters

common_conf (Entry) – The common configuration of the configuration file

create(options: esbo_etc.classes.Entry.Entry, parent: esbo_etc.classes.IRadiant.IRadiant = None) → esbo_etc.classes.optical_component.AOpticalComponent.AOpticalComponent

Create a new object of the type IRadiant

Parameters

• options (Entry) – The options to be used as parameters for the instantiation of the new object.

• parent (IRadiant) – The optional parent element of the object (necessary for subclasses of AOpticalComponent).

Returns

obj (AOpticalComponent) – The created optical component

fromConfigBatch(conf: esbo_etc.classes.Entry.Entry, parent: esbo_etc.classes.IRadiant.IRadiant) → esbo_etc.classes.optical_component.AOpticalComponent.AOpticalComponent

Initialize a decorated target from a configuration.

Parameters

• conf (Entry) – The configuration defining the target and the decorators.

• parent (IRadiant) – The optional parent element of the object

Returns

parent (AOpticalComponent) – The decorated parent object.

esbo_etc.classes.optical_component.StrayLight module

class esbo_etc.classes.optical_component.StrayLight.StrayLight(parent: esbo_etc.classes.IRadiant.IRadiant, emission: str)

Bases: esbo_etc.classes.optical_component.AOpticalComponent.AOpticalComponent

A class to model additional stray light sources e.g. zodiacal light

__init__(parent: esbo_etc.classes.IRadiant.IRadiant, emission: str)

Initialize a new stray light source

Parameters

• parent (IRadiant) – The parent element from which the electromagnetic radiation is received. This element is usually of type Target or StrayLight.

• emission (str) – Path to the file containing the spectral radiance of the stray light source. The format of the file will be guessed by astropy.io.ascii.read().

static check_config(conf: esbo_etc.classes.Entry.Entry) → Union[None, str]

Check the configuration for this class

Parameters

conf (Entry) – The configuration entry to be checked.

Returns

mes (Union[None, str]) – The error message of the check. This will be None if the check was successful.

Module contents