Description for optical components added
This commit is contained in:
parent
c8a6ae9c24
commit
a5cec39d2c
109
README.md
109
README.md
@ -54,14 +54,119 @@ component-specific attributes.
|
||||
* **`type`:** The type of the optical component. This can be one of the following types.
|
||||
|
||||
##### Atmosphere
|
||||
<optical_component type="Atmosphere" transmittance="PathToTransmittanceFile" emission="PathToEmissionFile"/>`
|
||||
`<optical_component type="Atmosphere" transmittance="PathToTransmittanceFile" emission="PathToEmissionFile"/>`
|
||||
|
||||
This components models the behaviour of an atmosphere which has a spectral transmittance and a spectral emission.
|
||||
This component models the behaviour of an atmosphere which has a spectral transmittance and a spectral emission.
|
||||
* **`transmittance`:** The path to the file containing the spectral transmittance coefficients. For details on the
|
||||
required structure see section _Reading spectral quantities from files_.
|
||||
* **`emission` _optional_:** The path to the file containing the spectral radiance of the emission. For details on the
|
||||
required structure see section _Reading spectral quantities from files_.
|
||||
|
||||
##### StrayLight
|
||||
`<optical_component type="StrayLight" emission="PathToEmissionFile"/>`
|
||||
This component allows to model generic noise sources like stray light or zodiacal light from a file containing the
|
||||
spectral radiance of the emission.
|
||||
* **`emission` _optional_:** The path to the file containing the spectral radiance of the emission. For details on the
|
||||
required structure see section _Reading spectral quantities from files_.
|
||||
|
||||
##### Mirror
|
||||
`<optical_component type="Mirror" reflectance="PathToReflectance" emissivity="PathToEmissivity" temp="70" temp_unit="K"
|
||||
obstruction="0.2" obstructor_temp="70" obstructor_temp_unit="K" obstructor_emissivity="0.9"/>`
|
||||
|
||||
Model a mirror including the mirror's thermal emission as well as possible obstruction of the mirror and the thermal
|
||||
emission of the obstructing component.
|
||||
* **`reflectance`:** The path to the file containing the spectral reflectance coefficients. For details on the
|
||||
required structure see section _Reading spectral quantities from files_.
|
||||
* **`emissivity`:** The path to the file containing the spectral emissivity coefficients. For details on the
|
||||
required structure see section _Reading spectral quantities from files_.
|
||||
* **`temp` _optional_:** The temperature of the mirror for the thermal emission.
|
||||
* **`temp_unit` _optional_:** The unit of the mirror's temperature. This has to be one of [`K`, `Celsius`].
|
||||
The default is `K`.
|
||||
* **`obstruction` _optional_:** The obstruction factor of the mirror as ratio of the areas
|
||||
A<sub>obstructor</sub> / A<sub>mirror</sub>.
|
||||
* **`obstructor_temp` _optional_:** The temperature of the obstructing component for the thermal emission.
|
||||
* **`obstructor_temp_unit` _optional_:** The unit of the obstructing component's temperature. This has to be one of
|
||||
[`K`, `Celsius`]. The default is `K`.
|
||||
* **`obstructor_emissivity` _optional_:** The emissivity of the obstructing component for the thermal emission.
|
||||
Valid ranges are 0.0 - 1.0. The default is 1.
|
||||
|
||||
##### Lens
|
||||
`<optical_component type="Lens" transmittance="PathToTransmittance" emissivity="PathToEmissivity" temp="70"
|
||||
temp_unit="K" obstruction="0.2" obstructor_temp="70" obstructor_temp_unit="K" obstructor_emissivity="0.9"/>`
|
||||
|
||||
Model a lens including the lens' thermal emission as well as possible obstruction of the lens and the thermal
|
||||
emission of the obstructing component.
|
||||
* **`transmittance`:** The path to the file containing the spectral transmittance coefficients. For details on the
|
||||
required structure see section _Reading spectral quantities from files_.
|
||||
* **`emissivity`:** The path to the file containing the spectral emissivity coefficients. For details on the
|
||||
required structure see section _Reading spectral quantities from files_.
|
||||
* **`temp` _optional_:** The temperature of the lens for the thermal emission.
|
||||
* **`temp_unit` _optional_:** The unit of the lens' temperature. This has to be one of [`K`, `Celsius`].
|
||||
The default is `K`.
|
||||
* **`obstruction` _optional_:** The obstruction factor of the lens as ratio of the areas
|
||||
A<sub>obstructor</sub> / A<sub>lens</sub>.
|
||||
* **`obstructor_temp` _optional_:** The temperature of the obstructing component for the thermal emission.
|
||||
* **`obstructor_temp_unit` _optional_:** The unit of the obstructing component's temperature. This has to be one of
|
||||
[`K`, `Celsius`]. The default is `K`.
|
||||
* **`obstructor_emissivity` _optional_:** The emissivity of the obstructing component for the thermal emission.
|
||||
Valid ranges are 0.0 - 1.0. The default is 1.
|
||||
|
||||
##### BeamSplitter
|
||||
`<optical_component type="BeamSplitter" transmittance="PathToTransmittance" emissivity="PathToEmissivity" temp="70"
|
||||
temp_unit="K" obstruction="0.2" obstructor_temp="70" obstructor_temp_unit="K" obstructor_emissivity="0.9"/>`
|
||||
|
||||
Model a beam splitter including the beam splitter's thermal emission as well as possible obstruction of the beam
|
||||
splitter and the thermal emission of the obstructing component.
|
||||
* **`transmittance`:** The path to the file containing the spectral transmittance coefficients. For details on the
|
||||
required structure see section _Reading spectral quantities from files_.
|
||||
* **`emissivity`:** The path to the file containing the spectral emissivity coefficients. For details on the
|
||||
required structure see section _Reading spectral quantities from files_.
|
||||
* **`temp` _optional_:** The temperature of the beam splitter for the thermal emission.
|
||||
* **`temp_unit` _optional_:** The unit of the beam splitter's temperature. This has to be one of [`K`, `Celsius`].
|
||||
The default is `K`.
|
||||
* **`obstruction` _optional_:** The obstruction factor of the beam splitter as ratio of the areas
|
||||
A<sub>obstructor</sub> / A<sub>beam splitter</sub>.
|
||||
* **`obstructor_temp` _optional_:** The temperature of the obstructing component for the thermal emission.
|
||||
* **`obstructor_temp_unit` _optional_:** The unit of the obstructing component's temperature. This has to be one of
|
||||
[`K`, `Celsius`]. The default is `K`.
|
||||
* **`obstructor_emissivity` _optional_:** The emissivity of the obstructing component for the thermal emission.
|
||||
Valid ranges are 0.0 - 1.0. The default is 1.
|
||||
|
||||
##### Filter
|
||||
`<optical_component type="Filter" transmittance="PathToTransmittance" emissivity="PathToEmissivity"
|
||||
temp="70" temp_unit="K" obstruction="0.2" obstructor_temp="70" obstructor_temp_unit="K" obstructor_emissivity="0.9"/>`
|
||||
|
||||
`<optical_component type="Filter" band="M" emissivity="PathToEmissivity" temp="70"
|
||||
temp_unit="K" obstruction="0.2" obstructor_temp="70" obstructor_temp_unit="K" obstructor_emissivity="0.9"/>`
|
||||
|
||||
`<optical_component type="Filter" start="400" start_unit="nm" end="480" end_unit="nm" emissivity="PathToEmissivity"
|
||||
temp="70" temp_unit="K" obstruction="0.2" obstructor_temp="70" obstructor_temp_unit="K" obstructor_emissivity="0.9"/>`
|
||||
|
||||
Model a beam splitter including the beam splitter's thermal emission as well as possible obstruction of the beam
|
||||
splitter and the thermal emission of the obstructing component.
|
||||
* **`transmittance`:** The path to the file containing the spectral transmittance coefficients. For details on the
|
||||
required structure see section _Reading spectral quantities from files_.
|
||||
* **`band`:** The spectral Band of the filter. This has to be one of [`U`, `B`, `V`, `R`, `I`, `J`, `H`, `K`, `L`, `M`,
|
||||
`N`]
|
||||
* **`start`:** The start wavelength of the pass band of the filter.
|
||||
* **`start_unit`:** The unit of the start wavelength. This has to be one of [`m`, `cm`, `mm`, `um`, `nm`, `pm`].
|
||||
The default is `m`.
|
||||
* **`end`:** The end wavelength of the pass band of the filter.
|
||||
* **`end_unit`:** The unit of the end wavelength. This has to be one of [`m`, `cm`, `mm`, `um`, `nm`, `pm`].
|
||||
The default is `m`.
|
||||
* **`emissivity`:** The path to the file containing the spectral emissivity coefficients. For details on the
|
||||
required structure see section _Reading spectral quantities from files_.
|
||||
* **`temp` _optional_:** The temperature of the beam splitter for the thermal emission.
|
||||
* **`temp_unit` _optional_:** The unit of the beam splitter's temperature. This has to be one of [`K`, `Celsius`].
|
||||
The default is `K`.
|
||||
* **`obstruction` _optional_:** The obstruction factor of the beam splitter as ratio of the areas
|
||||
A<sub>obstructor</sub> / A<sub>beam splitter</sub>.
|
||||
* **`obstructor_temp` _optional_:** The temperature of the obstructing component for the thermal emission.
|
||||
* **`obstructor_temp_unit` _optional_:** The unit of the obstructing component's temperature. This has to be one of
|
||||
[`K`, `Celsius`]. The default is `K`.
|
||||
* **`obstructor_emissivity` _optional_:** The emissivity of the obstructing component for the thermal emission.
|
||||
Valid ranges are 0.0 - 1.0. The default is 1.
|
||||
|
||||
#### Detectors
|
||||
|
||||
#### Other Features
|
||||
|
||||
Loading…
Reference in New Issue
Block a user