#
# stub class definition file for docstring parsing
#
[docs]class atmosphere:
"""
Atmosphere model
"""
[docs] def atmosphere(self):
"""
Construct an atmosphere tool
This is used to construct an {\tt atmosphere} tool.
"""
pass
[docs] def close(self):
"""
Destroy the atmosphere tool
"""
pass
[docs] def done(self):
"""
Destroy the atmosphere tool
"""
pass
[docs] def getAtmVersion(self):
"""
Returns the version of ATM library.
Returns the version of ATM library implemented to this tool.
"""
pass
[docs] def listAtmosphereTypes(self):
"""
Returns a list of atmospheric types used by ATM.
Returns a list of index numbers and corresponding atmosphere types
used by the ATM library.
"""
pass
[docs] def initAtmProfile(self, altitude=5000., temperature=270.0, pressure=560.0, maxAltitude=48.0, humidity=20.0, dTem_dh=-5.6, dP=10.0, dPm=1.2, h0=2.0, atmType=1, layerBoundaries=[''], layerTemperature=['']):
"""
Set initial atmospheric profile for atmosphere tool
An atmospheric profile is composed of 4 quantities as a function of
altitude z:
* the layer thickness
* the pressure P
* the temperature T and
* the gas densities for H2O, O3, CO and N2O.
This method is needed for computing the absorption and phase
coefficients, as well as for performing radiative transfer
calculations (only layer thickness/T are needed).
This method builds an atmospheric profile that can be used to calculate
absorption and phase coefficients, as well as to perform forward
and/or retrieval radiative transfer calculations. It is composed of a
set of parameters needed to build a layer thickness/P/T/gas densities
densities profile from simple parameters currently available at
observatories (from weather stations for example) using functions from
the ATM library. The set of input parameters consists of the pressure
P, the temperature T and the relative humidity at the ground, the
altitude of the site, the tropospheric temperature lapse rate,... The
profile is built as: thickness of the considered atmospheric layers
above the site, and mean P,T,H2O,O3,CO,N2O in them. The total number
of atmospheric layers in the particular profile is also available (a
negative value indicates an error). The zenith column of water vapor
can be calculated by simply integrating the H2O profile.
.. rubric:: Parameters
- ``altitude (double=5000.)`` - Site altitude - Quantity with units of altitude, meter
- ``temperature (double=270.0)`` - Ambient Temperature - Quantity with units of temperature, K
- ``pressure (double=560.0)`` - Ambient pressure - Quantity with units of pressure, mbar
- ``maxAltitude (double=48.0)`` - altitude of the top pf the modelled atmosphere -
Quantity with dimension of length, and units of kilometer
- ``humidity (double=20.0)`` - used to guess water (0-100)
- ``dTem_dh (double=-5.6)`` - the derivative of temperature with respect to height
- Quantity with units of K/km
- ``dP (double=10.0)`` - initial pressure step -
Quantity with the units of pressure, mb
- ``dPm (double=1.2)`` - pressure multiplicative factor for steps
- ``h0 (double=2.0)`` - scale height for water( exp distribution ) -
Quantity with the dimension of length, and units of kilometer
- ``atmType (int=1)`` - atmospheric type
1(tropical),2(mid latitude summer),3(mid latitude winter),
4(subarctic summer),5(subarctic winter), dimensionless
- ``layerBoundaries (doubleArray=[''])`` - Altitude of user-defined temperature profile,
a double array in unit of meter
- ``layerTemperature (doubleArray=[''])`` - User-defined temperature profile, a double
array in unit of Kelvin
"""
pass
[docs] def updateAtmProfile(self, altitude=5000., temperature=270.0, pressure=560.0, humidity=20.0, dTem_dh=-5.6, h0=2.0):
"""
Update basic atmospheric parameters of atmosphere tool
This is used to update the {\tt atmosphere} tool when basic
atmospheric parameters.change.
.. rubric:: Parameters
- ``altitude (double=5000.)`` - Site altitude - Quantity with units of altitude, meter
- ``temperature (double=270.0)`` - Ambient ground temperature - Quantity with units of temperature, K
- ``pressure (double=560.0)`` - Ambient ground pressure - Quantity with units of pressure, mbar
- ``humidity (double=20.0)`` - Relative humidy used to guess water (0-100)
- ``dTem_dh (double=-5.6)`` - Tropospheric Lapse Rate - the derivative of temperature with respect to height
- Quantity with units of K/km
- ``h0 (double=2.0)`` - scale height for water( exp distribution ) -
Quantity with the dimension of length, and units of kilometer
"""
pass
[docs] def getBasicAtmParms(self):
"""
Gets the current basic atmospheric parameters of the model.
"""
pass
[docs] def getNumLayers(self):
"""
Returns the number of layers in the atmospheric profile.
"""
pass
[docs] def getGroundWH2O(self):
"""
get the zenith column of water vapor
Method to get the zenith column of water vapor. It is computed by
simply integrating the H2O profile:
"""
pass
[docs] def getProfile(self):
"""
get atmospheric profile
Get the atmospheric profile.
"""
pass
[docs] def initSpectralWindow(self, nbands=1, fCenter=90, fWidth=0.64, fRes=0.0):
"""
initialize spectral window
function that defines a spectral window, computes absorption and emmision coefficients for this window,
using the atmospheric model profile.
NOTE: This method should be invoked after setting atmospheric profile model by initAtmProfile.
.. rubric:: Parameters
- ``nbands (int=1)`` - number of spectral windows/bands. The value must be > 0.
- ``fCenter (double=90)`` - center frequencies -
Quantum with a vector value and unit of frequency, GHz
- ``fWidth (double=0.64)`` - frequency width of band - Quantum with a vector value and unit of frequency, GHz
- ``fRes (double=0.0)`` - resolution inside band -
Quantum with a vector value and unit frequency, GHz.
Default is for a single frequency.
"""
pass
[docs] def addSpectralWindow(self, fCenter=350, fWidth=0.008, fRes=0.002):
"""
add a new spectral window
Add a new spectral window, uniformly sampled, this spectral window
having no sideband.
.. rubric:: Parameters
- ``fCenter (double=350)`` - frequencies -
Quantum with a double value and unit of frequency, GHz
- ``fWidth (double=0.008)`` - frequency width of band - Quantum with a double value and unit of frequency, GHz
- ``fRes (double=0.002)`` - resolution inside band -
Quantum with a double value and unit frequency, GHz
"""
pass
[docs] def getNumSpectralWindows(self):
"""
Get number of spectral windows
"""
pass
[docs] def getNumChan(self, spwid=0):
"""
return the number of channels of ith band
Return the number of channels of ith band ( passes in as parameter ).
.. rubric:: Parameters
- ``spwid (int=0)`` - Int standing for identifier of bands (0-based). The value must be >= 0.
"""
pass
[docs] def getRefChan(self, spwid=0):
"""
Get the reference channel of a given spectral window
Return the reference channel of the given spectral window
.. rubric:: Parameters
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getRefFreq(self, spwid=0):
"""
Get the reference frequency of given spectral window
Return the reference frequency of the given spectral window
.. rubric:: Parameters
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getChanSep(self, spwid=0):
"""
Get the channel separation for regularly spaced grid for spectral window
Return the channel separation of the given spectral window
.. rubric:: Parameters
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getChanFreq(self, chanNum=0, spwid=0):
"""
Get the channel frequency for a given grid point for the specified spectral window.
Return the channel frequency for a given grid point for the specified spectral window.
.. rubric:: Parameters
- ``chanNum (int=0)`` - Int standing for channel number (0-based). The value must be >= 0.
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getSpectralWindow(self, spwid=0):
"""
Get the spectral grid for the specified spectral window.
Return the spectral grid for the specified spectral window.
.. rubric:: Parameters
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getChanNum(self, freq='', spwid=0):
"""
Get the grid position for a given frequency in the specified spectral window.
Return the channel number for given frequency in the specified
spectral window relative to the reference channel number.
.. rubric:: Parameters
- ``freq (double='')`` - Frequency
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getBandwidth(self, spwid=0):
"""
Get the frequency range encompassing the list of frequency grid points for the specified spectral window.
.. rubric:: Parameters
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getMinFreq(self, spwid=0):
"""
Get lowest frequency channel for the specified spectral window.
.. rubric:: Parameters
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getMaxFreq(self, spwid=0):
"""
Get highest frequency channel for the specified spectral window.
.. rubric:: Parameters
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getDryOpacity(self, nc=-1, spwid=0):
"""
get the integrated Dry Opacity along the atmospheric path for channel nc in spectral window swpId
Get the integrated Dry Opacity for one channel in a band.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getDryContOpacity(self, nc=-1, spwid=0):
"""
get the integrated Dry Continuum Opacity along the atmospheric path for channel nc in spectral window spwid
Get the integrated Dry Continuum Opacity for one channel in a band.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getO2LinesOpacity(self, nc=-1, spwid=0):
"""
get the integrated O2 Lines Opacity along the atmospheric path for channel nc in spectral window spwid
Get the integrated O2 Lines Opacity for one channel in a band.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getO3LinesOpacity(self, nc=-1, spwid=0):
"""
get the integrated O3 Lines Opacity along the atmospheric path for channel nc in spectral window spwid
Get the integrated O3 Lines Opacity for one channel in a band.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getCOLinesOpacity(self, nc=-1, spwid=0):
"""
get the integrated CO Lines Opacity along the atmospheric path for channel nc in spectral window spwid
Get the integrated CO Lines Opacity for one channel in a band.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getN2OLinesOpacity(self, nc=-1, spwid=0):
"""
get the integrated N2O Lines Opacity along the atmospheric path for channel nc in spectral window spwid
Get the integrated N2O Lines Opacity for one channel in a band.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getWetOpacity(self, nc=-1, spwid=0):
"""
get the integrated zenith Wet Opacity along the atmospheric path for channel nc in spectral window spwid
Get the integrated zenith Wet Opacity for one channel in a band.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getH2OLinesOpacity(self, nc=-1, spwid=0):
"""
get the integrated zenith H2O Lines Opacity along the atmospheric path for channel nc in spectral window spwid
Get the integrated zenith H2O Lines Opacity for one channel in a band.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getH2OContOpacity(self, nc=-1, spwid=0):
"""
get the integrated zenith H2O Continuum Opacity along the atmospheric path for channel nc in spectral window spwid
Get the integrated zenith H2O Continuum Opacity for one channel in a band.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getDryOpacitySpec(self, spwid=0):
"""
get the integrated Dry opacity along the atmospheric path on each channel of a band
Get the integrated Dry opacity along the atmospheric path on each channel in a band.
.. rubric:: Parameters
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getWetOpacitySpec(self, spwid=0):
"""
get the integrated zenith Wet Opacity along the atmospheric path on each channel of a band
Getthe integrated zenith Wet Opacity along the atmospheric path on each channel in a band.
.. rubric:: Parameters
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getDispersivePhaseDelay(self, nc=-1, spwid=0):
"""
get the integrated zenith H2O Atmospheric Phase Delay
Get the integrated zenith H2O Atmospheric Phase Delay (Dispersive part)
for the current conditions, for channel number nc of spectral window spwid.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getDispersiveWetPhaseDelay(self, nc=-1, spwid=0):
"""
get the integrated dispersive wet Atmospheric Phase Delay
Function to retrievethe the integrated Atmospheric Phase Delay
(Dispersive part) along the atmospheric path corresponding to the 1st
guess water column.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getNonDispersiveWetPhaseDelay(self, nc=-1, spwid=0):
"""
get the integrated nondispersive wet Atmospheric Phase Delay
Function to retrieve the integrated wet Atmospheric Phase Delay
(NonDispersive part) along the atmospheric path corresponding to the 1st
guess water column.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getNonDispersiveDryPhaseDelay(self, nc=-1, spwid=0):
"""
get the integrated nondispersive dry Atmospheric Phase Delay
Function to retrieve the integrated dry Atmospheric Phase Delay
(NonDispersive part) along the atmospheric path corresponding to the 1st
guess water column.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getNonDispersivePhaseDelay(self, nc=-1, spwid=0):
"""
get the integrated zenith H2O Atmospheric Phase Delay (Non-Dispersive part)
Get the integrated zenith H2O Atmospheric Phase Delay (Non-Dispersive
part) for the current conditions, for channel number nc of spectral
window spwid.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getDispersivePathLength(self, nc=-1, spwid=0):
"""
get the integrated zenith Atmospheric Dispersive Path
Retrieve the integrated zenith H2O Atmospheric Path length (Dispersive part)
along the atmospheric path corresponding to the user water column
for channel nc in spectral window spwid.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getDispersiveWetPathLength(self, nc=-1, spwid=0):
"""
get the integrated wet Atmospheric Dispersive Path
Retrieve the integrated wet Atmospheric Path length (Dispersive part)
along the atmospheric path corresponding to the 1st guess water column
for channel nc in spectral window spwid.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getNonDispersiveWetPathLength(self, nc=-1, spwid=0):
"""
get the integrated wet Atmospheric NonDispersive Path
Retrieve the integrated wet Atmospheric Path length (NonDispersive part)
along the atmospheric path corresponding to the 1st guess water column
for channel nc in spectral window spwid.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getNonDispersiveDryPathLength(self, nc=-1, spwid=0):
"""
get the integrated dry Atmospheric NonDispersive Path
Retrieve the integrated dry Atmospheric Path length (NonDispersive part)
along the atmospheric path corresponding to the 1st guess water column
for channel nc in spectral window spwid.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getO2LinesPathLength(self, nc=-1, spwid=0):
"""
get the integrated O2 lines Path
Retrieve the integrated Atmospheric Path length (due to O2 Lines) along
the atmospheric path corresponding to the 1st guess water column
for channel nc in spectral window spwid.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getO3LinesPathLength(self, nc=-1, spwid=0):
"""
get the integrated O3 lines Path
Retrieve the integrated Atmospheric Path length (due to O3 Lines) along
the atmospheric path corresponding to the 1st guess water column
for channel nc in spectral window spwid.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getCOLinesPathLength(self, nc=-1, spwid=0):
"""
get the integrated CO lines Path
Retrieve the integrated Atmospheric Path length (due to CO Lines)
along the atmospheric path corresponding to the 1st guess water column
for channel nc in spectral window spwid.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getN2OLinesPathLength(self, nc=-1, spwid=0):
"""
get the integrated N2O lines Path
Retrieve the integrated Atmospheric Path length (due to N2O Lines)
along the atmospheric path corresponding to the 1st guess water column
for channel nc in spectral window spwid.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getNonDispersivePathLength(self, nc=-1, spwid=0):
"""
get the integrated zenith H2O Atmospheric Non-Dispersive Path
Get the integrated zenith H2O Atmospheric Path length (Non-Dispersive part)
for the current conditions, for channel nc in spectral window spwid.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based; defaults to reference channel)
- ``spwid (int=0)`` - Int standing for spectral window id (0-based). The value must be >= 0.
"""
pass
[docs] def getAbsH2OLines(self, nl='', nf=0, spwid=0):
"""
Get H2O lines Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
Accessor to get H2O lines Absorption Coefficient at layer nl,
spectral window spwid and channel nf.
.. rubric:: Parameters
- ``nl (int='')`` - atmospheric layer number. The value must be >= 0.
- ``nf (int=0)`` - frequency channnel number. The value must be >= 0.
- ``spwid (int=0)`` - spectral window id. The value must be >= 0.
"""
pass
[docs] def getAbsH2OCont(self, nl='', nf=0, spwid=0):
"""
Get H2O continuum Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
Get H2O continuum Absorption Coefficient at layer nl,
spectral window spwid and frequency channel nf
.. rubric:: Parameters
- ``nl (int='')`` - atmospheric layer number. The value must be >= 0.
- ``nf (int=0)`` - frequency channnel number. The value must be >= 0.
- ``spwid (int=0)`` - spectral window id. The value must be >= 0.
"""
pass
[docs] def getAbsO2Lines(self, nl='', nf=0, spwid=0):
"""
Get O2 lines Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
Get O2 lines Absorption Coefficient at layer nl,
spectral window spwid and frequency channel nf
.. rubric:: Parameters
- ``nl (int='')`` - atmospheric layer number. The value must be >= 0.
- ``nf (int=0)`` - frequency channnel number. The value must be >= 0.
- ``spwid (int=0)`` - spectral window id. The value must be >= 0.
"""
pass
[docs] def getAbsDryCont(self, nl='', nf=0, spwid=0):
"""
Get Dry Continuum Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
Get Dry Continuum Absorption Coefficient at layer nl,
spectral window spwid and frequency channel nf
.. rubric:: Parameters
- ``nl (int='')`` - atmospheric layer number. The value must be >= 0.
- ``nf (int=0)`` - frequency channnel number. The value must be >= 0.
- ``spwid (int=0)`` - spectral window id. The value must be >= 0.
"""
pass
[docs] def getAbsO3Lines(self, nl='', nf=0, spwid=0):
"""
Get O3 lines Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
Get O3 lines Absorption Coefficient at layer nl,
spectral window spwid and frequency channel nf
.. rubric:: Parameters
- ``nl (int='')`` - atmospheric layer number. The value must be >= 0.
- ``nf (int=0)`` - frequency channnel number. The value must be >= 0.
- ``spwid (int=0)`` - spectral window id. The value must be >= 0.
"""
pass
[docs] def getAbsCOLines(self, nl='', nf=0, spwid=0):
"""
Get CO lines Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
Get CO lines Absorption Coefficient at layer nl,
spectral window spwid and frequency channel nf
.. rubric:: Parameters
- ``nl (int='')`` - atmospheric layer number. The value must be >= 0.
- ``nf (int=0)`` - frequency channnel number. The value must be >= 0.
- ``spwid (int=0)`` - spectral window id. The value must be >= 0.
"""
pass
[docs] def getAbsN2OLines(self, nl='', nf=0, spwid=0):
"""
Get N2O lines Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
Get N2O lines Absorption Coefficient at layer nl,
spectral window spwid and frequency channel nf
.. rubric:: Parameters
- ``nl (int='')`` - atmospheric layer number. The value must be >= 0.
- ``nf (int=0)`` - frequency channnel number. The value must be >= 0.
- ``spwid (int=0)`` - spectral window id. The value must be >= 0.
"""
pass
[docs] def getAbsTotalDry(self, nl='', nf=0, spwid=0):
"""
Get Total Dry Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
Get total dry Absorption Coefficient at layer nl,
spectral window spwid and frequency channel nf
.. rubric:: Parameters
- ``nl (int='')`` - atmospheric layer number. The value must be >= 0.
- ``nf (int=0)`` - frequency channnel number. The value must be >= 0.
- ``spwid (int=0)`` - spectral window id. The value must be >= 0.
"""
pass
[docs] def getAbsTotalWet(self, nl='', nf=0, spwid=0):
"""
Get total wet absorption coefficient at layer nl and frequency channel nf in spectral window spwid
Get total wet absorption coefficient at layer nl,
spectral window spwid and frequency channel nf
.. rubric:: Parameters
- ``nl (int='')`` - atmospheric layer number. The value must be >= 0.
- ``nf (int=0)`` - frequency channnel number. The value must be >= 0.
- ``spwid (int=0)`` - spectral window id. The value must be >= 0.
"""
pass
[docs] def setUserWH2O(self, wh2o=0.0):
"""
set the user zenith water vapor column
Set user zenith water vapor column for forward radiative transfer
calculations.
.. rubric:: Parameters
- ``wh2o (double=0.0)`` - User water vapor column
"""
pass
[docs] def getUserWH2O(self):
"""
get the user zenith water vapor column
Get user zenith water vapor column for forward radiative transfer
calculations.
"""
pass
[docs] def setAirMass(self, airmass=''):
"""
Set the air mass
Setter for air mass in SkyStatus without performing water vapor retrieval.
.. rubric:: Parameters
- ``airmass (double='')`` - Air Mass
"""
pass
[docs] def getAirMass(self):
"""
Get the air mass
Accessor to get airmass.
"""
pass
[docs] def setSkyBackgroundTemperature(self, tbgr=2.73):
"""
Set the sky background temperature
Set sky background temperature in SkyStatus without performing water vapor retrieval
.. rubric:: Parameters
- ``tbgr (double=2.73)`` - sky background temperature
"""
pass
[docs] def getSkyBackgroundTemperature(self):
"""
Get the sky background temperature
"""
pass
[docs] def getAverageTebbSky(self, spwid=0, wh2o=-1):
"""
Returns average equiv. BB Temp
Returns the average Equivalent Blackbody Temperature in spectral
window spwid, for the current conditions and a perfect sky coupling.
.. rubric:: Parameters
- ``spwid (int=0)`` - Spectral window (0-based). The value must be >= 0.
- ``wh2o (double=-1)`` - User specified water column length in mm. Default is not to use wh2o.
"""
pass
[docs] def getTebbSky(self, nc=-1, spwid=0, wh2o=-1):
"""
Returns equiv. BB Temp
Gets the Equivalent Blackbody Temperature in spectral window spwid and
channel nc, for the current (user) Water Vapor Column wh2o,
the current Air Mass, and perfect Sky Coupling to the sky.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based) - defaults to reference channel
- ``spwid (int=0)`` - Spectral window (0-based). The value must be >= 0.
- ``wh2o (double=-1)`` - User specified water column length in mm. Default is not to use wh2o.
"""
pass
[docs] def getTebbSkySpec(self, spwid=0, wh2o=-1):
"""
Returns equiv. BB Temp on each channel of a band
Gets the Equivalent Blackbody Temperatures in a spectral window spwid
for the current (user) Water Vapor Column wh2o, the current Air Mass, and
perfect Sky Coupling to the sky.
.. rubric:: Parameters
- ``spwid (int=0)`` - Spectral window (0-based). The value must be >= 0.
- ``wh2o (double=-1)`` - User specified water column length in mm. Default is not to use wh2o.
"""
pass
[docs] def getAverageTrjSky(self, spwid=0, wh2o=-1):
"""
Returns the average Rayleigh-Jeans Temperature in spectral
window spwid, for the current (user) Water Vapor Column wh2o,
the current Air Mass, and perfect Sky Coupling to the sky.
.. rubric:: Parameters
- ``spwid (int=0)`` - Spectral window (0-based). The value must be >= 0.
- ``wh2o (double=-1)`` - User specified water column length in mm. Default is not to use wh2o.
"""
pass
[docs] def getTrjSky(self, nc=-1, spwid=0, wh2o=-1):
"""
Returns the Rayleigh-Jeans Temperature
Gets the Rayleigh-Jeans Temperature in spectral window spwid and
channel nc, for the current (user) Water Vapor Column wh2o, the
current Air Mass, and perfect Sky Coupling to the sky.
.. rubric:: Parameters
- ``nc (int=-1)`` - Channel number (0-based) - defaults to reference channel
- ``spwid (int=0)`` - Spectral window (0-based). The value must be >= 0.
- ``wh2o (double=-1)`` - User specified water column length in mm. Default is not to use wh2o.
"""
pass
[docs] def getTrjSkySpec(self, spwid=0, wh2o=-1):
"""
Returns the Rayleigh-Jeans Temperatures on each channel of a band
Gets the Rayleigh-Jeans Temperatures in a spectral window spwid
for the current (user) Water Vapor Column wh2o, the current Air
Mass, and perfect Sky Coupling to the sky.
.. rubric:: Parameters
- ``spwid (int=0)`` - Spectral window (0-based). The value must be >= 0.
- ``wh2o (double=-1)`` - User specified water column length in mm. Default is not to use wh2o.
"""
pass