.. skcomponents documentation master file, created by sphinx-quickstart on Fri Jan 8 18:26:34 2021. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to skcomponents's documentation! ======================================== .. toctree:: :maxdepth: 2 :caption: Contents: usage/installation usage/overview api/modules Overview -------- :mod:`skcomponents` is used to transform radiance into a level 1 product. The general processing chain is: .. figure:: _static/images/api_overview.png :width: 100 % :align: center Processing chain of a hypothetical instrument. Optical and processing components can be easily stacked if multiple elements are required. `sensors` are currently part of the `skretrieval` package. This mimics the processes that would take place in the physical instrument and is broken into four components: 1. **Front End Radiance**: The radiance at the front aperture of the instrument. This is typically produced by a radiative transfer engine such as :py:mod:`sasktran`, but could come from MODTRAN, stored values, etc. 2. **Optics**: Components tranform the radiance before reaching the sensor. These are typically filters, polarizers, etc. 3. **Sensor**: The sensor integrates radiance over wavelength and solid angle based on the sensors spectral and spatial point spread functions. The returned quantity is in photons at each pixel. A variety of sensors are available in the :py:mod:`skretrieval` package. 4. **Processors**: After the signal has been integrated by the sensor the processors transform the signal into the Level 1 data product that the instrument would produce. These are typically electronic and physical processes such as dark current, poisson counting error, thermal noise, etc. However they can also include calibration and numerical processing steps such as dark current removal, or inverting an interferogram. Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search`