electronic
==========

AutoExposure
++++++++++++


Determine DIT and NDIT automatically from ImagePlane.

DIT is determined such that the maximum value in the incident photon flux
(including astronomical source, sky and thermal backgrounds) fills
the full well of the detector (``!DET.full_well``) to a given fraction
(``!OBS.autoexposure.fill_frac``). NDIT is determined such that
``DIT`` * ``NDIT`` results in the requested exposure time.

The requested exposure time is taken from ``!OBS.exptime``.

The effects sets the parameters `!OBS.dit` and `!OBS.ndit`.

Examples
--------
The parameters `!OBS.exptime`, `!DET.full_well` and `!DET.mindit` should
be defined as properties in the respective subsections.
::

   name: auto_exposure
   description: automatic determination of DIT and NDIT
   class: AutoExposure
   include: True
   kwargs:
       fill_frac: "!OBS.auto_exposure.fill_frac"



BasicReadoutNoise
+++++++++++++++++

Readout noise computed as: ron * sqrt(NDIT).

Bias
++++

Adds a constant bias level to readout.

BinnedImage
+++++++++++

.. warning: Empty docstring

DarkCurrent
+++++++++++


required: dit, ndit, value


DetectorModePropertiesSetter
++++++++++++++++++++++++++++


Set mode specific curr_sys properties for different detector readout modes.

A little class (``DetectorModePropertiesSetter``) that allows different
``"!DET"`` properties to be set on the fly.

Parameters
----------
mode_properties : dict
    A dictionary containing the DET parameters to be changed for each mode.
    See below for an example yaml entry.

Examples
--------
Add the values for the different detector readout modes to all the relevant
detector yaml files. In this case the METIS HAWAII (L, M band) and GeoSnap
(N band) detectors: METIS_DET_IMG_LM.yaml , METIS_DET_IMG_N.yaml
::

    - name: lm_detector_readout_parameters
      class: DetectorModePropertiesSetter
      kwargs:
        mode_properties:
          fast:
            mindit: 0.04
            full_well: !!float 1e5
            ron: 70
          slow:
            mindit: 1.3
            full_well: !!float 1e5
            ron: 14

Add the OBS dict entry !OBS.detector_readout_mode to the properties section
of the mode_yamls descriptions in the default.yaml files.
::

    mode_yamls:
      - object: observation
        alias: OBS
        name: lss_l
        yamls:
          ...
        properties:
          ...
          detector_readout_mode: slow



LinearityCurve
++++++++++++++


Detector linearity effect.

The detector linearity curve is set in terms of `incident` flux (e/s) and
`measured` detector values (ADU).

Examples
--------

The effect can be instantiated in various ways.::

    - name: detector_linearity
      class: LinearityCurve
      kwargs:
        filename: FPA_linearity.dat

    - name: detector_linearity
      class: LinearityCurve
      kwargs:
        array_dict: {incident: [0, 77000, 999999999999],
                     measured: [0, 77000, 77000]}

    - name: detector_linearity
      class: LinearityCurve
      kwargs:
        incident: [0, 77000, 99999999]
        measured: [0, 77000, 77000]



PoorMansHxRGReadoutNoise
++++++++++++++++++++++++

.. warning: Empty docstring

Quantization
++++++++++++

Converts raw data to whole photons.

ReferencePixelBorder
++++++++++++++++++++

.. warning: Empty docstring

ShotNoise
+++++++++

.. warning: Empty docstring

SummedExposure
++++++++++++++

Simulates a summed stack of ``ndit`` exposures.

UnequalBinnedImage
++++++++++++++++++

.. warning: Empty docstring