atmosphere¶

class atmosphere[source]¶

Atmosphere model

Methods Summary

`addSpectralWindow`	add a new spectral window
`atmosphere`	Construct an atmosphere tool
`close`	Destroy the atmosphere tool
`done`	Destroy the atmosphere tool
`getAbsCOLines`	Get CO lines Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
`getAbsDryCont`	Get Dry Continuum Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
`getAbsH2OCont`	Get H2O continuum Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
`getAbsH2OLines`	Get H2O lines Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
`getAbsN2OLines`	Get N2O lines Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
`getAbsO2Lines`	Get O2 lines Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
`getAbsO3Lines`	Get O3 lines Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
`getAbsTotalDry`	Get Total Dry Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
`getAbsTotalWet`	Get total wet absorption coefficient at layer nl and frequency channel nf in spectral window spwid
`getAirMass`	Get the air mass
`getAtmVersion`	Returns the version of ATM library.
`getAverageTebbSky`	Returns average equiv.
`getAverageTrjSky`	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.
`getBandwidth`	Get the frequency range encompassing the list of frequency grid points for the specified spectral window.
`getBasicAtmParms`	Gets the current basic atmospheric parameters of the model.
`getCOLinesOpacity`	get the integrated CO Lines Opacity along the atmospheric path for channel nc in spectral window spwid
`getCOLinesPathLength`	get the integrated CO lines Path
`getChanFreq`	Get the channel frequency for a given grid point for the specified spectral window.
`getChanNum`	Get the grid position for a given frequency in the specified spectral window.
`getChanSep`	Get the channel separation for regularly spaced grid for spectral window
`getDispersivePathLength`	get the integrated zenith Atmospheric Dispersive Path
`getDispersivePhaseDelay`	get the integrated zenith H2O Atmospheric Phase Delay
`getDispersiveWetPathLength`	get the integrated wet Atmospheric Dispersive Path
`getDispersiveWetPhaseDelay`	get the integrated dispersive wet Atmospheric Phase Delay
`getDryContOpacity`	get the integrated Dry Continuum Opacity along the atmospheric path for channel nc in spectral window spwid
`getDryOpacity`	get the integrated Dry Opacity along the atmospheric path for channel nc in spectral window swpId
`getDryOpacitySpec`	get the integrated Dry opacity along the atmospheric path on each channel of a band
`getGroundWH2O`	get the zenith column of water vapor
`getH2OContOpacity`	get the integrated zenith H2O Continuum Opacity along the atmospheric path for channel nc in spectral window spwid
`getH2OLinesOpacity`	get the integrated zenith H2O Lines Opacity along the atmospheric path for channel nc in spectral window spwid
`getMaxFreq`	Get highest frequency channel for the specified spectral window.
`getMinFreq`	Get lowest frequency channel for the specified spectral window.
`getN2OLinesOpacity`	get the integrated N2O Lines Opacity along the atmospheric path for channel nc in spectral window spwid
`getN2OLinesPathLength`	get the integrated N2O lines Path
`getNonDispersiveDryPathLength`	get the integrated dry Atmospheric NonDispersive Path
`getNonDispersiveDryPhaseDelay`	get the integrated nondispersive dry Atmospheric Phase Delay
`getNonDispersivePathLength`	get the integrated zenith H2O Atmospheric Non-Dispersive Path
`getNonDispersivePhaseDelay`	get the integrated zenith H2O Atmospheric Phase Delay (Non-Dispersive part)
`getNonDispersiveWetPathLength`	get the integrated wet Atmospheric NonDispersive Path
`getNonDispersiveWetPhaseDelay`	get the integrated nondispersive wet Atmospheric Phase Delay
`getNumChan`	return the number of channels of ith band
`getNumLayers`	Returns the number of layers in the atmospheric profile.
`getNumSpectralWindows`	Get number of spectral windows
`getO2LinesOpacity`	get the integrated O2 Lines Opacity along the atmospheric path for channel nc in spectral window spwid
`getO2LinesPathLength`	get the integrated O2 lines Path
`getO3LinesOpacity`	get the integrated O3 Lines Opacity along the atmospheric path for channel nc in spectral window spwid
`getO3LinesPathLength`	get the integrated O3 lines Path
`getProfile`	get atmospheric profile
`getRefChan`	Get the reference channel of a given spectral window
`getRefFreq`	Get the reference frequency of given spectral window
`getSkyBackgroundTemperature`	Get the sky background temperature
`getSpectralWindow`	Get the spectral grid for the specified spectral window.
`getTebbSky`	Returns equiv.
`getTebbSkySpec`	Returns equiv.
`getTrjSky`	Returns the Rayleigh-Jeans Temperature
`getTrjSkySpec`	Returns the Rayleigh-Jeans Temperatures on each channel of a band
`getUserWH2O`	get the user zenith water vapor column
`getWetOpacity`	get the integrated zenith Wet Opacity along the atmospheric path for channel nc in spectral window spwid
`getWetOpacitySpec`	get the integrated zenith Wet Opacity along the atmospheric path on each channel of a band
`initAtmProfile`	Set initial atmospheric profile for atmosphere tool
`initSpectralWindow`	initialize spectral window
`listAtmosphereTypes`	Returns a list of atmospheric types used by ATM.
`setAirMass`	Set the air mass
`setSkyBackgroundTemperature`	Set the sky background temperature
`setUserWH2O`	set the user zenith water vapor column
`updateAtmProfile`	Update basic atmospheric parameters of atmosphere tool

addSpectralWindow(fCenter=350, fWidth=0.008, fRes=0.002)[source]¶

add a new spectral window

Add a new spectral window, uniformly sampled, this spectral window having no sideband.

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

atmosphere()[source]¶

Construct an atmosphere tool

This is used to construct an { t atmosphere} tool.

close()[source]¶: Destroy the atmosphere tool

done()[source]¶: Destroy the atmosphere tool

getAbsCOLines(nl='', nf=0, spwid=0)[source]¶

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

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.

getAbsDryCont(nl='', nf=0, spwid=0)[source]¶

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

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.

getAbsH2OCont(nl='', nf=0, spwid=0)[source]¶

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

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.

getAbsH2OLines(nl='', nf=0, spwid=0)[source]¶

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.

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.

getAbsN2OLines(nl='', nf=0, spwid=0)[source]¶

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

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.

getAbsO2Lines(nl='', nf=0, spwid=0)[source]¶

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

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.

getAbsO3Lines(nl='', nf=0, spwid=0)[source]¶

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

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.

getAbsTotalDry(nl='', nf=0, spwid=0)[source]¶

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

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.

getAbsTotalWet(nl='', nf=0, spwid=0)[source]¶

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

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.

getAirMass()[source]¶

Get the air mass

Accessor to get airmass.

getAtmVersion()[source]¶

Returns the version of ATM library.

Returns the version of ATM library implemented to this tool.

getAverageTebbSky(spwid=0, wh2o=- 1)[source]¶

Returns average equiv. BB Temp

Returns the average Equivalent Blackbody Temperature in spectral window spwid, for the current conditions and a perfect sky coupling.

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.

getAverageTrjSky(spwid=0, wh2o=- 1)[source]¶

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.

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.

getBandwidth(spwid=0)[source]¶

Get the frequency range encompassing the list of frequency grid points for the specified spectral window.

Parameters

spwid (int=0) - Int standing for spectral window id (0-based). The value must be >= 0.

getBasicAtmParms()[source]¶: Gets the current basic atmospheric parameters of the model.

getCOLinesOpacity(nc=- 1, spwid=0)[source]¶

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.

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.

getCOLinesPathLength(nc=- 1, spwid=0)[source]¶

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.

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.

getChanFreq(chanNum=0, spwid=0)[source]¶

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.

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.

getChanNum(freq='', spwid=0)[source]¶

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.

Parameters

freq (double='') - Frequency
spwid (int=0) - Int standing for spectral window id (0-based). The value must be >= 0.

getChanSep(spwid=0)[source]¶

Get the channel separation for regularly spaced grid for spectral window

Return the channel separation of the given spectral window

Parameters

spwid (int=0) - Int standing for spectral window id (0-based). The value must be >= 0.

getDispersivePathLength(nc=- 1, spwid=0)[source]¶

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.

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.

getDispersivePhaseDelay(nc=- 1, spwid=0)[source]¶

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.

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.

getDispersiveWetPathLength(nc=- 1, spwid=0)[source]¶

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.

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.

getDispersiveWetPhaseDelay(nc=- 1, spwid=0)[source]¶

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.

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.

getDryContOpacity(nc=- 1, spwid=0)[source]¶

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.

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.

getDryOpacity(nc=- 1, spwid=0)[source]¶

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.

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.

getDryOpacitySpec(spwid=0)[source]¶

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.

Parameters

spwid (int=0) - Int standing for spectral window id (0-based). The value must be >= 0.

getGroundWH2O()[source]¶

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:

getH2OContOpacity(nc=- 1, spwid=0)[source]¶

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.

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.

getH2OLinesOpacity(nc=- 1, spwid=0)[source]¶

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.

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.

getMaxFreq(spwid=0)[source]¶

Get highest frequency channel for the specified spectral window.

Parameters

spwid (int=0) - Int standing for spectral window id (0-based). The value must be >= 0.

getMinFreq(spwid=0)[source]¶

Get lowest frequency channel for the specified spectral window.

Parameters

spwid (int=0) - Int standing for spectral window id (0-based). The value must be >= 0.

getN2OLinesOpacity(nc=- 1, spwid=0)[source]¶

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.

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.

getN2OLinesPathLength(nc=- 1, spwid=0)[source]¶

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.

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.

getNonDispersiveDryPathLength(nc=- 1, spwid=0)[source]¶

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.

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.

getNonDispersiveDryPhaseDelay(nc=- 1, spwid=0)[source]¶

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.

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.

getNonDispersivePathLength(nc=- 1, spwid=0)[source]¶

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.

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.

getNonDispersivePhaseDelay(nc=- 1, spwid=0)[source]¶

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.

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.

getNonDispersiveWetPathLength(nc=- 1, spwid=0)[source]¶

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.

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.

getNonDispersiveWetPhaseDelay(nc=- 1, spwid=0)[source]¶

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.

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.

getNumChan(spwid=0)[source]¶

return the number of channels of ith band

Return the number of channels of ith band ( passes in as parameter ).

Parameters

spwid (int=0) - Int standing for identifier of bands (0-based). The value must be >= 0.

getNumLayers()[source]¶: Returns the number of layers in the atmospheric profile.

getNumSpectralWindows()[source]¶: Get number of spectral windows

getO2LinesOpacity(nc=- 1, spwid=0)[source]¶

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.

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.

getO2LinesPathLength(nc=- 1, spwid=0)[source]¶

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.

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.

getO3LinesOpacity(nc=- 1, spwid=0)[source]¶

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.

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.

getO3LinesPathLength(nc=- 1, spwid=0)[source]¶

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.

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.

getProfile()[source]¶

get atmospheric profile

Get the atmospheric profile.

getRefChan(spwid=0)[source]¶

Get the reference channel of a given spectral window

Return the reference channel of the given spectral window

Parameters

spwid (int=0) - Int standing for spectral window id (0-based). The value must be >= 0.

getRefFreq(spwid=0)[source]¶

Get the reference frequency of given spectral window

Return the reference frequency of the given spectral window

Parameters

spwid (int=0) - Int standing for spectral window id (0-based). The value must be >= 0.

getSkyBackgroundTemperature()[source]¶: Get the sky background temperature

getSpectralWindow(spwid=0)[source]¶

Get the spectral grid for the specified spectral window.

Return the spectral grid for the specified spectral window.

Parameters

spwid (int=0) - Int standing for spectral window id (0-based). The value must be >= 0.

getTebbSky(nc=- 1, spwid=0, wh2o=- 1)[source]¶

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.

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.

getTebbSkySpec(spwid=0, wh2o=- 1)[source]¶

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.

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.

getTrjSky(nc=- 1, spwid=0, wh2o=- 1)[source]¶

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.

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.

getTrjSkySpec(spwid=0, wh2o=- 1)[source]¶

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.

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.

getUserWH2O()[source]¶

get the user zenith water vapor column

Get user zenith water vapor column for forward radiative transfer calculations.

getWetOpacity(nc=- 1, spwid=0)[source]¶

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.

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.

getWetOpacitySpec(spwid=0)[source]¶

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.

Parameters

spwid (int=0) - Int standing for spectral window id (0-based). The value must be >= 0.

initAtmProfile(altitude=5000.0, 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=[''])[source]¶

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.

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

initSpectralWindow(nbands=1, fCenter=90, fWidth=0.64, fRes=0.0)[source]¶

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.

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.

listAtmosphereTypes()[source]¶

Returns a list of atmospheric types used by ATM.

Returns a list of index numbers and corresponding atmosphere types used by the ATM library.

setAirMass(airmass='')[source]¶

Set the air mass

Setter for air mass in SkyStatus without performing water vapor retrieval.

Parameters

airmass (double='') - Air Mass

setSkyBackgroundTemperature(tbgr=2.73)[source]¶

Set the sky background temperature

Set sky background temperature in SkyStatus without performing water vapor retrieval

Parameters

tbgr (double=2.73) - sky background temperature

setUserWH2O(wh2o=0.0)[source]¶

set the user zenith water vapor column

Set user zenith water vapor column for forward radiative transfer calculations.

Parameters

wh2o (double=0.0) - User water vapor column

updateAtmProfile(altitude=5000.0, temperature=270.0, pressure=560.0, humidity=20.0, dTem_dh=- 5.6, h0=2.0)[source]¶

Update basic atmospheric parameters of atmosphere tool

This is used to update the { t atmosphere} tool when basic atmospheric parameters.change.

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