esbo_ds/ESBO-ETC
esbo_ds
/
ESBO-ETC
11
0
Fork 1
Code Issues 1 Pull Requests Releases 1 Wiki Activity

fix types

This commit is contained in:
Lukas Klass 2020-05-27 10:21:27 +02:00
parent 943929678d
commit 60b04acef6
4 changed files with 41 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/source/configuration/common.rst
View File

@ -9,7 +9,7 @@ The minimal wavelength to consider in the computations.
<wl_min val="3" val_unit="um"/>
Attributes:
* | **val:** str
* | **val:** float
| The value of the minimal wavelength.
* | **val_unit:** str, *optional* = "m"
| The unit of the minimal wavelength. This has to be one of [``m``, ``cm``, ``mm``, ``um``, ``nm``, ``pm``]. The default is ``m``.
@ -23,7 +23,7 @@ The maximal wavelength to consider in the computations.
<wl_max val="5" val_unit="um"/>
Attributes:
* | **val:** str
* | **val:** float
| The value of the maximal wavelength.
* | **val_unit:** str, *optional* = "m"
| The unit of the maximal wavelength. This has to be one of [``m``, ``cm``, ``mm``, ``um``, ``nm``, ``pm``]. The default is ``m``.
@ -39,7 +39,7 @@ wl_delta
<wl_delta val="5" val_unit="um"/>
Attributes:
* | **val:** str
* | **val:** float
| The value of the wavelength grid size.
* | **val_unit:** str, *optional* = "m"
| The unit of the wavelength grid size. This has to be one of [``m``, ``cm``, ``mm``, ``um``, ``nm``, ``pm``]. The default is ``m``.
@ -55,7 +55,7 @@ res
<res val="1000" val_unit=""/>
Attributes:
* | **val:** str
* | **val:** float
| The value of the spectral resolution.
* | **val_unit:** str, *optional* = ""
| The unit of the spectral resolution. This has to be emtpy (dimensionless). The default is ``dimensionless``.
@ -72,7 +72,7 @@ The diameter of the telescope aperture.
<d_aperture val="2.3" val_unit="m"/>
Attributes:
* | **val:** str
* | **val:** float
| The value of the telescope aperture diameter.
* | **val_unit:** str, *optional* = "m"
| The unit of the telescope aperture diameter. This has to be one of [``m``, ``cm``, ``mm``, ``um``, ``nm``, ``pm``]. The default is ``m``.
@ -110,7 +110,7 @@ jitter_sigma
<jitter_sigma val="2" val_unit="arcsec"/>
Attributes:
* | **val:** str
* | **val:** float
| The value of the pointing jitter sigma.
* | **val_unit:** str, *optional* = "arcsec"
| The unit of the pointing jitter sigma. This has to be one of [``arcsec``, ``arcmin``, ``degree``, ``radians``]. The default is ``arcsec``.
@ -148,7 +148,7 @@ exposure_time
<exposure_time val="data/exposure_time.csv"/>
Attributes:
* | **val:** str
* | **val:** (float, str)
| The exposure time(s) to be used for the computations. This can be either a single value, a comma separated list of values or the path to a CSV-file containing a single column of exposure time values. For details on the required file structure see also :ref:`reading_csv`.
* | **val_unit:** str, *optional* = "s"
| The unit of the exposure time. This has to be one of [``ns``, ``us``, ``ms``, ``s``, ``min``, ``h``]. If the path to a file is provided, this parameter must be omitted. The default is ``s``.
@ -172,7 +172,7 @@ snr
<snr val="data/snr.csv"/>
Attributes:
* | **val:** str
* | **val:** (float, str)
| The SNR(s) to be used for the computations. This can be either a single value, a comma separated list of values or the path to a CSV-file containing a single column of SNR values. For details on the required file structure see also :ref:`reading_csv`.
* | **val_unit:** str, *optional* = ""
| The unit of the exposure time. This has to be emtpy (dimensionless). If the path to a file is provided, this parameter must be omitted. The default is ``dimensionless``.

36
docs/source/configuration/optical_components.rst
View File

@ -48,17 +48,17 @@ Attributes:
| The path to the file containing the spectral reflectance coefficients. For details on the required file structure see also :ref:`reading_csv`.
* | **emissivity:** str, *optional*
| The path to the file containing the spectral emissivity coefficients. For details on the required file structure see also :ref:`reading_csv`.
* | **temp:** str, *optional*
* | **temp:** float, *optional*
| The temperature of the mirror for the thermal emission.
* | **temp_unit:** str, *optional*
| The unit of the mirror's temperature. This has to be one of [``K``, ``Celsius``]. The default is ``K``.
* | **obstruction:** str, *optional*
* | **obstruction:** float, *optional*
| The obstruction factor of the mirror as ratio of the areas A\ :sub:`obstructor` / A\ :sub:`mirror`.
* | **obstructor_temp:** str, *optional*
* | **obstructor_temp:** float, *optional*
| The temperature of the obstructing component for the thermal emission.
* | **obstructor_temp_unit:** str, *optional*
| The unit of the obstructing component's temperature. This has to be one of [``K``, ``Celsius``]. The default is ``K``.
* | **obstructor_emissivity:** str, *optional*
* | **obstructor_emissivity:** float, *optional*
| The emissivity of the obstructing component for the thermal emission. Valid ranges are 0.0 - 1.0. The default is 1.0.
Lens
@ -74,17 +74,17 @@ Attributes:
| The path to the file containing the spectral transmittance coefficients. For details on the required file structure see also :ref:`reading_csv`.
* | **emissivity:** str, *optional*
| The path to the file containing the spectral emissivity coefficients. For details on the required file structure see also :ref:`reading_csv`.
* | **temp:** str, *optional*
* | **temp:** float, *optional*
| The temperature of the lens for the thermal emission.
* | **temp_unit:** str, *optional*
| The unit of the lens' temperature. This has to be one of [``K``, ``Celsius``]. The default is ``K``.
* | **obstruction:** str, *optional*
* | **obstruction:** float, *optional*
| The obstruction factor of the lens as ratio of the areas A\ :sub:`obstructor` / A\ :sub:`lens`.
* | **obstructor_temp:** str, *optional*
* | **obstructor_temp:** float, *optional*
| The temperature of the obstructing component for the thermal emission.
* | **obstructor_temp_unit:** str, *optional*
| The unit of the obstructing component's temperature. This has to be one of [``K``, ``Celsius``]. The default is ``K``.
* | **obstructor_emissivity:** str, *optional*
* | **obstructor_emissivity:** float, *optional*
| The emissivity of the obstructing component for the thermal emission. Valid ranges are 0.0 - 1.0. The default is 1.0.
BeamSplitter
@ -100,17 +100,17 @@ Attributes:
| The path to the file containing the spectral transmittance coefficients. For details on the required file structure see also :ref:`reading_csv`.
* | **emissivity:** str, *optional*
| The path to the file containing the spectral emissivity coefficients. For details on the required file structure see also :ref:`reading_csv`.
* | **temp:** str, *optional*
* | **temp:** float, *optional*
| The temperature of the beam splitter for the thermal emission.
* | **temp_unit:** str, *optional*
| The unit of the beam splitter's temperature. This has to be one of [``K``, ``Celsius``]. The default is ``K``.
* | **obstruction:** str, *optional*
* | **obstruction:** float, *optional*
| The obstruction factor of the beam splitter as ratio of the areas A\ :sub:`obstructor` / A\ :sub:`beam splitter`.
* | **obstructor_temp:** str, *optional*
* | **obstructor_temp:** float, *optional*
| The temperature of the obstructing component for the thermal emission.
* | **obstructor_temp_unit:** str, *optional*
| The unit of the obstructing component's temperature. This has to be one of [``K``, ``Celsius``]. The default is ``K``.
* | **obstructor_emissivity:** str, *optional*
* | **obstructor_emissivity:** float, *optional*
| The emissivity of the obstructing component for the thermal emission. Valid ranges are 0.0 - 1.0. The default is 1.0.
Filter
@ -134,25 +134,25 @@ Attributes:
| The path to the file containing the spectral transmittance coefficients. For details on the required file structure see also :ref:`reading_csv`.
* | **band:** str
| The spectral Band of the filter. This has to be one of [``U``, ``B``, ``V``, ``R``, ``I``, ``J``, ``H``, ``K``, ``L``, ``M``, ``N``]
* | **start:** str
* | **start:** float
| The start wavelength of the pass band of the filter.
* | **start_unit:** str
| The unit of the start wavelength. This has to be one of [``m``, ``cm``, ``mm``, ``um``, ``nm``, ``pm``]. The default is ``m``.
* | **end:** str
* | **end:** float
| The end wavelength of the pass band of the filter.
* | **end_unit:** str
| The unit of the end wavelength. This has to be one of [``m``, ``cm``, ``mm``, ``um``, ``nm``, ``pm``]. The default is ``m``.
* | **emissivity:** str, *optional*
| The path to the file containing the spectral emissivity coefficients. For details on the required file structure see also :ref:`reading_csv`.
* | **temp:** str
* | **temp:** float
| The temperature of the beam splitter for the thermal emission.
* | **temp_unit:** str, *optional*
| The unit of the beam splitter's temperature. This has to be one of [``K``, ``Celsius``]. The default is ``K``.
* | **obstruction:** str, *optional*
* | **obstruction:** float, *optional*
| The obstruction factor of the beam splitter as ratio of the areas A\ :sub:`obstructor` / A\ :sub:`filter`.
* | **obstructor_temp:** str, *optional*
* | **obstructor_temp:** float, *optional*
| The temperature of the obstructing component for the thermal emission.
* | **obstructor_temp_unit:** str, *optional*
| The unit of the obstructing component's temperature. This has to be one of [``K``, ``Celsius``]. The default is ``K``.
* | **obstructor_emissivity:** str, *optional*
* | **obstructor_emissivity:** float, *optional*
| The emissivity of the obstructing component for the thermal emission. Valid ranges are 0.0 - 1.0. The default is 1.0.

24
docs/source/configuration/sensor.rst
View File

@ -44,7 +44,7 @@ The working focal number of the instrument.
<f_number val="13" val_unit=""/>
Attributes:
* | **val:** str
* | **val:** float
| The value of the working focal number of the instrument.
* | **val_unit:** str, *optional* = ""
| The unit of the working focal number of the instrument. This has to be emtpy (dimensionless).
@ -60,7 +60,7 @@ The geometry of the sensor's pixel array.
<pixel_geometry val="1024, 1024" val_unit="pix"/>
Attributes:
* | **val:** str
* | **val:** float
| The geometry of the sensor's pixel array as a comma separated list of the number of pixels per dimension (X, Y).
* | **val_unit:** str, *optional* = "pix"
| The unit of the geometry of the sensor's pixel array. This has to be ``pix``.
@ -76,7 +76,7 @@ The PSF's center offset from the arithmetical center of the detector array which
<center_offset val="0.0, 0.0" val_unit="pix"/>
Attributes:
* | **val:** str
* | **val:** float
| PSF's center offset as a comma separated list of the offset in pixels per dimension (X, Y).
* | **val_unit:** str, *optional* = "pix"
| The unit of the PSF's center offset. This has to be ``pix``.
@ -105,8 +105,10 @@ The quantum efficiency of a detector pixel.
<quantum_efficiency val="data/ccd/QE.txt"/>
Attributes:
* | **val:** str
| The path to the file containing the quantum efficiency values. For details on the required file structure see also :ref:`reading_csv`.
* | **val:** (float, str)
| Either the value of the quantum efficiency or the path to the file containing the quantum efficiency values. For details on the required file structure see also :ref:`reading_csv`.
* | **val_unit:** str, *optional* = "electron / photon"
| The unit of the edge length of a detector pixel. This has to be ``electron / photon``.
pixel_size
""""""""""
@ -117,7 +119,7 @@ The spatial size of each detector pixel. Each pixel is assumed to be of quadrati
<pixel_size val="6.5" val_unit="um"/>
Attributes:
* | **val:** str
* | **val:** float
| The value of the edge length of a detector pixel.
* | **val_unit:** str, *optional* = "m"
| The unit of the edge length of a detector pixel. This has to be one of [``m``, ``cm``, ``mm``, ``um``, ``nm``, ``pm``]. The default is ``m``.
@ -131,7 +133,7 @@ The dark current of a detector pixel.
<dark_current val="0.6" val_unit="electron / (pix * s)"/>
Attributes:
* | **val:** str
* | **val:** float
| The value of the dark current of a detector pixel.
* | **val_unit:** str, *optional* = "electron / (pix * s)"
| The unit of the dark current of a detector pixel. This has to be ``electron / (pix * s)``.
@ -145,7 +147,7 @@ The read out noise of a detector pixel.
<sigma_read_out val="1.4" val_unit="electron(1/2) / pix"/>
Attributes:
* | **val:** str
* | **val:** float
| The value of the read out noise of a detector pixel.
* | **val_unit:** str, *optional* = "electron(1/2) / pix"
| The unit of the read out noise of a detector pixel. This has to be ``electron(1/2) / pix``.
@ -159,7 +161,7 @@ The well capacity of a detector pixel.
<well_capacity val="30000" val_unit="electron"/>
Attributes:
* | **val:** str
* | **val:** float
| The value of the well capacity of a detector pixel.
* | **val_unit:** str, *optional* = "electron"
| The unit of the well capacity of a detector pixel. This has to be ``electron``.
@ -204,7 +206,7 @@ The energy to be contained within the photometric aperture. This value will used
<contained_energy val="80"/>
Attributes:
* | **val:** str
* | **val:** (float, str)
| The energy to be contained within the photometric aperture. This can be either the percentage of contained energy or one of [``Peak``, ``FWHM``, ``Min``].
contained_pixels
@ -218,7 +220,7 @@ The number of pixels to be contained within the photometric aperture. If this pa
<contained_pixels val="100" val_unit="pix"/>
Attributes:
* | **val:** str
* | **val:** float
| The number of pixels to be contained within the photometric aperture.
* | **val_unit:** str, *optional* = "pix"
| The unit of the number of pixels to be contained within the photometric aperture. This has to be ``pix``.

4
docs/source/configuration/target.rst
View File

@ -23,11 +23,11 @@ Model a target as a black body of a given temperature and apparent magnitude.
<target type="BlackBodyTarget" temp="5778" temp_unit="K" mag="10" mag_unit="mag" band="B" size="point"/>
Attributes:
* | **temp:** str
* | **temp:** float
| The temperature of the black body.
* | **temp_unit:** str, *optional* = "K"
| The unit of the black body's temperature. This has to be one of [``K``, ``Celsius``]. The default is ``K``.
* | **mag:** str
* | **mag:** float
| The apparent magnitude of the black body in magnitudes.
* | **mag_unit:** str, *optional* = "mag"
| The unit of the black body's magnitude. This has to be ``mag``. The default is ``mag``.