isofit.core.units
=================

.. py:module:: isofit.core.units


Functions
---------

.. autoapisummary::

   isofit.core.units.E_to_L
   isofit.core.units.L_to_E
   isofit.core.units.transm_to_rdn
   isofit.core.units.rdn_to_transm
   isofit.core.units.wavenumber_to_nm
   isofit.core.units.nm_to_wavenumber
   isofit.core.units.vis_to_aod
   isofit.core.units.aod_to_vis
   isofit.core.units.rfl_to_rrs
   isofit.core.units.rrs_to_rfl
   isofit.core.units.W_to_uW
   isofit.core.units.uW_to_W
   isofit.core.units.Wm2_to_uWcm2
   isofit.core.units.uWcm2_to_Wm2
   isofit.core.units.micron_to_nm
   isofit.core.units.nm_to_micron
   isofit.core.units.cm_to_nm
   isofit.core.units.nm_to_cm
   isofit.core.units.m_to_km
   isofit.core.units.mm_to_cm
   isofit.core.units.cm_to_mm
   isofit.core.units.km_to_m
   isofit.core.units.m_to_ft
   isofit.core.units.ft_to_m


Module Contents
---------------

.. py:function:: E_to_L(E, coszen)

   Convert irradiance to radiance.

   :param E: input irradiance vector
   :param coszen: cosine of solar zenith angle

   :returns: Data vector converted to radiance


.. py:function:: L_to_E(L, coszen)

   Convert radiance to irradiance.

   :param L: input radiance vector
   :param coszen: cosine of solar zenith angle

   :returns: Data vector converted to irradiance


.. py:function:: transm_to_rdn(transm, coszen, solar_irr)

   Function to convert a unitless atmospheric vector to radiance units.

   :param transm: input data vector in unitless atmospheric units
   :param coszen: cosine of solar zenith angle
   :param solar_irr: solar irradiance vector

   :returns: Data vector converted to radiance


.. py:function:: rdn_to_transm(rdn, coszen, solar_irr)

   Function to convert a radiance vector to transmittance.

   :param rdn: input data vector in radiance
   :param coszen: cosine of solar zenith angle
   :param solar_irr: solar irradiance vector

   :returns: Data vector converted to unitless atmospheric units


.. py:function:: wavenumber_to_nm(wavenumber)

   Function to convert wavenumber to nm.

   :param wavenumber: value(s) in wavenumber in 1/cm

   :returns: value(s) in nanometers


.. py:function:: nm_to_wavenumber(nm)

   Function to convert nm to wavenumber.


.. py:function:: vis_to_aod(vis)

   Converts VIS modtran parameter to the AOD550 .
   This formula comes from page 50 of the MODTRAN 6 user manual,
   which relates ViS to the extinction coefficient at 550 nm.
   The constant, 0.01159 is the Rayleigh scattering coefficient at
   550 nm in 1/km.

   :param vis: visibility

   :returns: Data vector converted to exctinction at 550 nm


.. py:function:: aod_to_vis(aod)

   Converts AOD550 to VIS modtran parameter.
   Formula comes from page 50 of the MODTRAN 6 users manual,
   which relates ViS to the extinction coefficient at 550 nm.
   The constant, 0.01159 is the Rayleigh scattering coefficient at
   550 nm in 1/km.

   :param aod: extinction at 550 nm

   :returns: Data vector converted to visibility


.. py:function:: rfl_to_rrs(rfl)

   Converts unitless reflectance to remote sensing reflectance

   :param rfl: unitless reflectance

   :returns: Data vector of remote sensing reflectance in units 1/sr


.. py:function:: rrs_to_rfl(rrs)

   Converts remote sensing reflectance to unitless reflectance

   :param rrs: remote sensing reflectance in 1/sr

   :returns: Data vector of unitless reflectance


.. py:function:: W_to_uW(w)

   Converts value of units watts to units microwatts

   :param w: value(s) in units of Watts

   :returns: Value(s) in units of microwatts


.. py:function:: uW_to_W(uw)

   Converts value of units microwatts to units watts

   :param uw: value(s) in units of Microwatts

   :returns: Value(s) in units of microwatts


.. py:function:: Wm2_to_uWcm2(wm)

   Converts value of units Watts / square meter to units
   of micro-watts / square centimeter

   :param wm: value(s) in units of W/m2

   :returns: Value(s) in units of uW/cm2


.. py:function:: uWcm2_to_Wm2(uwcm)

   Converts value of micro-watts / square centimeter to units Watts / square meter

   :param uwcm: value(s) in units of uW/cm2

   :returns: Value(s) in units of W/m2


.. py:function:: micron_to_nm(micron)

   Function to convert microns to nanometers

   :param micron: value(s) in microns

   :returns: value(s) in nanometers


.. py:function:: nm_to_micron(nm)

   Function to convert nanometers to microns

   :param nm: value(s) in nanometers

   :returns: value(s) in microns


.. py:function:: cm_to_nm(cm)

   Function to convert microns to nanometers

   :param cm: value(s) in centimeters

   :returns: value(s) in nanometers


.. py:function:: nm_to_cm(nm)

   Function to convert nanometers to microns

   :param nm: value(s) in nanometers

   :returns: value(s) in microns


.. py:function:: m_to_km(m)

   Converts value of units meters to units kilometer

   :param m: value(s) in units of meters

   :returns: Value(s) in units of kilometers


.. py:function:: mm_to_cm(mm)

   Converts value of units mm to unit centimeters

   :param mm: value(s) in units of millimeters

   :returns: Value(s) in units of centimeters


.. py:function:: cm_to_mm(cm)

   Converts value of units mm to unit millimeters

   :param cm: value(s) in units of centimeters

   :returns: Value(s) in units of millimeters


.. py:function:: km_to_m(km)

   Converts value of units kilometers to unit meters

   :param km: value(s) in units of kilometers

   :returns: Value(s) in units of meters


.. py:function:: m_to_ft(m)

   Converts value of units meters to units feet

   :param m: value(s) in units of meters

   :returns: Value(s) in units of feet


.. py:function:: ft_to_m(ft)

   Converts value of units ft to units m

   :param ft: value(s) in units of feet

   :returns: Value(s) in units of meters