esbo_etc.classes.target package

Submodules

esbo_etc.classes.target.ATarget module

class esbo_etc.classes.target.ATarget.ATarget(**func_kwargs)

Bases: esbo_etc.classes.IRadiant.IRadiant

Abstract super class for target models

calcBackground() → esbo_etc.classes.SpectralQty.SpectralQty

Calculate the spectral radiance of the target’s background

Returns

background (SpectralQty) – The spectral radiance of the target’s 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) → bool

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.target.BlackBodyTarget module

class esbo_etc.classes.target.BlackBodyTarget.BlackBodyTarget(**func_kwargs)

Bases: esbo_etc.classes.target.ATarget.ATarget

This class models the spectral flux density of a star of given magnitude using 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.target.FileTarget module

class esbo_etc.classes.target.FileTarget.FileTarget(**func_kwargs)

Bases: esbo_etc.classes.target.ATarget.ATarget

A class to create a target from a file containing the spectral flux densities

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.target.TargetFactory module

class esbo_etc.classes.target.TargetFactory.TargetFactory(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.target.ATarget.ATarget

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 (ATarget) – The created target object

Module contents