casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables
Public Member Functions | Public Attributes | Static Private Attributes
__casac__.atmosphere.atmosphere Class Reference
Inheritance diagram for __casac__.atmosphere.atmosphere:
__casac__.atmosphere._object

List of all members.

Public Member Functions

def __init__
def getAtmVersion
def listAtmosphereTypes
def initAtmProfile
def updateAtmProfile
def getBasicAtmParms
def getNumLayers
def getGroundWH2O
def getProfile
def initSpectralWindow
def addSpectralWindow
def getNumSpectralWindows
def getNumChan
def getRefChan
def getRefFreq
def getChanSep
def getChanFreq
def getSpectralWindow
def getChanNum
def getBandwidth
def getMinFreq
def getMaxFreq
def getDryOpacity
def getDryContOpacity
def getO2LinesOpacity
def getO3LinesOpacity
def getCOLinesOpacity
def getN2OLinesOpacity
def getWetOpacity
def getH2OLinesOpacity
def getH2OContOpacity
def getDryOpacitySpec
def getWetOpacitySpec
def getDispersivePhaseDelay
def getDispersiveWetPhaseDelay
def getNonDispersiveWetPhaseDelay
def getNonDispersiveDryPhaseDelay
def getNonDispersivePhaseDelay
def getDispersivePathLength
def getDispersiveWetPathLength
def getNonDispersiveWetPathLength
def getNonDispersiveDryPathLength
def getO2LinesPathLength
def getO3LinesPathLength
def getCOLinesPathLength
def getN2OLinesPathLength
def getNonDispersivePathLength
def getAbsH2OLines
def getAbsH2OCont
def getAbsO2Lines
def getAbsDryCont
def getAbsO3Lines
def getAbsCOLines
def getAbsN2OLines
def getAbsTotalDry
def getAbsTotalWet
def setUserWH2O
def getUserWH2O
def setAirMass
def getAirMass
def setSkyBackgroundTemperature
def getSkyBackgroundTemperature
def getAverageTebbSky
def getTebbSky
def getTebbSkySpec

Public Attributes

 this

Static Private Attributes

dictionary __swig_setmethods__
tuple __setattr__
dictionary __swig_getmethods__
tuple __getattr__
 __repr__
 __swig_destroy__
 __del__

Detailed Description

Proxy of C++ casac::atmosphere class

Definition at line 70 of file atmosphere.py.

Constructor & Destructor Documentation

def __casac__.atmosphere.atmosphere.__init__ (   self) 
__init__(self) -> atmosphere

Definition at line 140 of file atmosphere.py.

Member Function Documentation

def __casac__.atmosphere.atmosphere.addSpectralWindow (   self,
  args,
  kwargs 
) 
addSpectralWindow(self, fCenter=Quantity(std::vector<double>(1, 350),"GHz"), fWidth=Quantity(std::vector<double>(1, 0.008),"GHz"), 
    fRes=Quantity(std::vector<double>(1, 0.002),"GHz")) -> int

Summary
add a new spectral window

Input Parameters:
fCenter          frequencies - Quantum with a double value and unit of frequency, GHz 350 
fWidth           frequency width of band - Quantum with a double value and unit of frequency, GHz 0.008 
fRes             resolution inside band - Quantum with a double value and unit frequency, GHz 0.002 

--------------------------------------------------------------------------------

Definition at line 320 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getAbsCOLines (   self,
  args,
  kwargs 
) 
getAbsCOLines(self, nl, nf=0, spwid=0) -> Quantity

Summary

Get CO lines Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
   

Input Parameters:
nl               atmospheric layer number 
nf               frequency channnel number 0 
spwid            spectral window id 0 

--------------------------------------------------------------------------------

Definition at line 1014 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getAbsDryCont (   self,
  args,
  kwargs 
) 
getAbsDryCont(self, nl, nf=0, spwid=0) -> Quantity

Summary

Get Dry Continuum Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
   

Input Parameters:
nl               atmospheric layer number 
nf               frequency channnel number 0 
spwid            spectral window id 0 

--------------------------------------------------------------------------------

Definition at line 976 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getAbsH2OCont (   self,
  args,
  kwargs 
) 
getAbsH2OCont(self, nl, nf=0, spwid=0) -> Quantity

Summary

Get H2O continuum Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
   

Input Parameters:
nl               atmospheric layer number 
nf               frequency channnel number 0 
spwid            spectral window id 0 

--------------------------------------------------------------------------------

Definition at line 938 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getAbsH2OLines (   self,
  args,
  kwargs 
) 
getAbsH2OLines(self, nl, nf=0, spwid=0) -> Quantity

Summary

Get H2O lines Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
   

Input Parameters:
nl               atmospheric layer number 
nf               frequency channnel number 0 
spwid            spectral window id 0 

--------------------------------------------------------------------------------

Definition at line 919 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getAbsN2OLines (   self,
  args,
  kwargs 
) 
getAbsN2OLines(self, nl, nf=0, spwid=0) -> Quantity

Summary

Get N2O lines Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
   

Input Parameters:
nl               atmospheric layer number 
nf               frequency channnel number 0 
spwid            spectral window id 0 

--------------------------------------------------------------------------------

Definition at line 1033 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getAbsO2Lines (   self,
  args,
  kwargs 
) 
getAbsO2Lines(self, nl, nf=0, spwid=0) -> Quantity

Summary

Get O2 lines Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
   

Input Parameters:
nl               atmospheric layer number 
nf               frequency channnel number 0 
spwid            spectral window id 0 

--------------------------------------------------------------------------------

Definition at line 957 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getAbsO3Lines (   self,
  args,
  kwargs 
) 
getAbsO3Lines(self, nl, nf=0, spwid=0) -> Quantity

Summary

Get O3 lines Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
   

Input Parameters:
nl               atmospheric layer number 
nf               frequency channnel number 0 
spwid            spectral window id 0 

--------------------------------------------------------------------------------

Definition at line 995 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getAbsTotalDry (   self,
  args,
  kwargs 
) 
getAbsTotalDry(self, nl, nf=0, spwid=0) -> Quantity

Summary

Get Total Dry Absorption Coefficient at layer nl and frequency channel nf in spectral window spwid
   

Input Parameters:
nl               atmospheric layer number 
nf               frequency channnel number 0 
spwid            spectral window id 0 

--------------------------------------------------------------------------------

Definition at line 1052 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getAbsTotalWet (   self,
  args,
  kwargs 
) 
getAbsTotalWet(self, nl, nf=0, spwid=0) -> Quantity

Summary

Get total wet absorption coefficient at layer nl and frequency channel nf in spectral window spwid
   

Input Parameters:
nl               atmospheric layer number 
nf               frequency channnel number 0 
spwid            spectral window id 0 

--------------------------------------------------------------------------------

Definition at line 1071 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getAirMass (   self) 
getAirMass(self) -> double

Summary
Get the air mass
--------------------------------------------------------------------------------

Definition at line 1131 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getAtmVersion (   self) 
getAtmVersion(self) -> string

Summary
Returns the version of ATM library.
   
--------------------------------------------------------------------------------

Definition at line 147 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getAverageTebbSky (   self,
  args,
  kwargs 
) 
getAverageTebbSky(self, spwid=0, wh2o=Quantity(std::vector<double>(1, -1),"mm")) -> Quantity

Summary
Returns average equiv. BB Temp

Input Parameters:
spwid            Spectral window (0-based) 0 
wh2o             User specified water column length in mm. Default is not to use wh2o. -1 

--------------------------------------------------------------------------------

Definition at line 1168 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getBandwidth (   self,
  spwid = 0 
) 
getBandwidth(self, spwid=0) -> Quantity

Summary

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

Input Parameters:
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 462 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getBasicAtmParms (   self,
  args,
  kwargs 
) 
getBasicAtmParms(self, _altitude=_altitude_getBasicAtmParms, _temperature=_temperature_getBasicAtmParms, 
    _pressure=_pressure_getBasicAtmParms, _maxAltitude=_maxAltitude_getBasicAtmParms, 
    _humidity=_humidity_getBasicAtmParms, _dTem_dh=_dTem_dh_getBasicAtmParms, 
    _dP=_dP_getBasicAtmParms, _dPm=_dPm_getBasicAtmParms, _h0=_h0_getBasicAtmParms, 
    _atmType=_atmType_getBasicAtmParms) -> string

Summary
Gets the current basic atmospheric parameters of the model.
   

Output Parameters:
_altitude        Site altitude - Quantity with units of altitude, meter 
_temperature     Ambient ground temperature - Quantity with units of temperature, K 
_pressure        Ambient pressure - Quantity with units of pressure, mbar 
_maxAltitude     altitude of the top pf the modelled atmosphere - Quantity with dimension of length, and units of kilometer 
_humidity        Ground relative humidity used to guess water (0-100) 
_dTem_dh         Current Tropospheric Lapse Rate (the derivative of temperature with respect to height) - Quantity with units of K/km 
_dP              initial pressure step - Quantity with the units of pressure, mb 
_dPm             pressure multiplicative factor for steps 
_h0              Water vapor scale height ( exp distribution ) - Quantity with the dimension of length, and units of kilometer 
_atmType         atmospheric type used to describe the behaviour above the tropopause. 1(tropical),2(mid latitude summer),3(mid latitude winter), 4(subarctic summer),5(subarctic winter), dimensionless 

--------------------------------------------------------------------------------

Definition at line 225 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getChanFreq (   self,
  chanNum = 0,
  spwid = 0 
) 
getChanFreq(self, chanNum=0, spwid=0) -> Quantity

Summary
Get the channel frequency for a given grid point for the specified spectral window.
   

Input Parameters:
chanNum          Int standing for channel number (0-based) 0 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 412 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getChanNum (   self,
  args,
  kwargs 
) 
getChanNum(self, freq, spwid=0) -> double

Summary
Get the grid position for a given frequency in the specified spectral window.
   

Input Parameters:
freq             Frequency 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 445 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getChanSep (   self,
  spwid = 0 
) 
getChanSep(self, spwid=0) -> Quantity

Summary
Get the channel separation for regularly spaced grid for spectral window
   

Input Parameters:
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 396 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getCOLinesOpacity (   self,
  args,
  kwargs 
) 
getCOLinesOpacity(self, nc=-1, spwid=0) -> double

Summary
get the integrated CO Lines Opacity along the atmospheric path for channel nc in spectral window spwid

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 577 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getCOLinesPathLength (   self,
  args,
  kwargs 
) 
getCOLinesPathLength(self, nc=-1, spwid=0) -> Quantity

Summary
get the integrated CO lines Path

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 871 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getDispersivePathLength (   self,
  args,
  kwargs 
) 
getDispersivePathLength(self, nc=-1, spwid=0) -> Quantity

Summary
get the integrated Atmospheric Dispersive Path

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 775 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getDispersivePhaseDelay (   self,
  args,
  kwargs 
) 
getDispersivePhaseDelay(self, nc=-1, spwid=0) -> Quantity

Summary
get the integrated zenith H2O Atmospheric Phase Delay

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 695 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getDispersiveWetPathLength (   self,
  args,
  kwargs 
) 
getDispersiveWetPathLength(self, nc=-1, spwid=0) -> Quantity

Summary
get the integrated wet Atmospheric Dispersive Path

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 791 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getDispersiveWetPhaseDelay (   self,
  args,
  kwargs 
) 
getDispersiveWetPhaseDelay(self, nc=-1, spwid=0) -> Quantity

Summary
get the integrated dispersive wet Atmospheric Phase Delay

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 711 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getDryContOpacity (   self,
  args,
  kwargs 
) 
getDryContOpacity(self, nc=-1, spwid=0) -> double

Summary
get the integrated Dry Continuum Opacity along the atmospheric path for channel nc in spectral window spwid

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 529 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getDryOpacity (   self,
  args,
  kwargs 
) 
getDryOpacity(self, nc=-1, spwid=0) -> double

Summary
get the integrated Dry Opacity along the atmospheric path for channel nc in spectral window swpId

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 513 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getDryOpacitySpec (   self,
  args,
  kwargs 
) 
getDryOpacitySpec(self, spwid=0, _dryOpacity=_dryOpacity_getDryOpacitySpec) -> int

Summary
get the integrated Dry optical depth along the atmospheric path on each channel of a band

Input Parameters:
spwid            Int standing for spectral window id (0-based) 0 


Output Parameters:
_dryOpacity      dry opacity for each channel 

--------------------------------------------------------------------------------

Definition at line 657 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getGroundWH2O (   self) 
getGroundWH2O(self) -> Quantity

Summary
get the zenith column of water vapor
--------------------------------------------------------------------------------

Definition at line 266 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getH2OContOpacity (   self,
  args,
  kwargs 
) 
getH2OContOpacity(self, nc=-1, spwid=0) -> double

Summary
get the integrated H2O Continuum Opacity along the atmospheric path for channel nc in spectral window spwid

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 641 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getH2OLinesOpacity (   self,
  args,
  kwargs 
) 
getH2OLinesOpacity(self, nc=-1, spwid=0) -> double

Summary
get the integrated H2O Lines Opacity along the atmospheric path for channel nc in spectral window spwid

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 625 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getMaxFreq (   self,
  spwid = 0 
) 
getMaxFreq(self, spwid=0) -> Quantity

Summary

Get highest frequency channel for the specified spectral window.
   

Input Parameters:
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 496 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getMinFreq (   self,
  spwid = 0 
) 
getMinFreq(self, spwid=0) -> Quantity

Summary

Get lowest frequency channel for the specified spectral window.
   

Input Parameters:
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 479 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getN2OLinesOpacity (   self,
  args,
  kwargs 
) 
getN2OLinesOpacity(self, nc=-1, spwid=0) -> double

Summary
get the integrated N2O Lines Opacity along the atmospheric path for channel nc in spectral window spwid

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 593 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getN2OLinesPathLength (   self,
  args,
  kwargs 
) 
getN2OLinesPathLength(self, nc=-1, spwid=0) -> Quantity

Summary
get the integrated N2O lines Path

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 887 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getNonDispersiveDryPathLength (   self,
  args,
  kwargs 
) 
getNonDispersiveDryPathLength(self, nc=-1, spwid=0) -> Quantity

Summary
get the integrated dry Atmospheric NonDispersive Path

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 823 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getNonDispersiveDryPhaseDelay (   self,
  args,
  kwargs 
) 
getNonDispersiveDryPhaseDelay(self, nc=-1, spwid=0) -> Quantity

Summary
get the integrated nondispersive dry Atmospheric Phase Delay

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 743 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getNonDispersivePathLength (   self,
  args,
  kwargs 
) 
getNonDispersivePathLength(self, nc=-1, spwid=0) -> Quantity

Summary
get the integrated Atmospheric Non-Dispersive Path

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 903 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getNonDispersivePhaseDelay (   self,
  args,
  kwargs 
) 
getNonDispersivePhaseDelay(self, nc=-1, spwid=0) -> Quantity

Summary
get the integrated zenith H2O Atmospheric Phase Delay (Non-Dispersive part)

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 759 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getNonDispersiveWetPathLength (   self,
  args,
  kwargs 
) 
getNonDispersiveWetPathLength(self, nc=-1, spwid=0) -> Quantity

Summary
get the integrated wet Atmospheric NonDispersive Path

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 807 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getNonDispersiveWetPhaseDelay (   self,
  args,
  kwargs 
) 
getNonDispersiveWetPhaseDelay(self, nc=-1, spwid=0) -> Quantity

Summary
get the integrated nondispersive wet Atmospheric Phase Delay

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 727 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getNumChan (   self,
  spwid = 0 
) 
getNumChan(self, spwid=0) -> int

Summary
return the number of channels of ith band

Input Parameters:
spwid            Int standing for identifier of bands (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 349 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getNumLayers (   self) 
getNumLayers(self) -> int

Summary
Returns the number of layers in the atmospheric profile.
   
--------------------------------------------------------------------------------

Definition at line 254 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getNumSpectralWindows (   self) 
getNumSpectralWindows(self) -> int

Summary
Get number of spectral windows
--------------------------------------------------------------------------------

Definition at line 338 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getO2LinesOpacity (   self,
  args,
  kwargs 
) 
getO2LinesOpacity(self, nc=-1, spwid=0) -> double

Summary
get the integrated O2 Lines Opacity along the atmospheric path for channel nc in spectral window spwid

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 545 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getO2LinesPathLength (   self,
  args,
  kwargs 
) 
getO2LinesPathLength(self, nc=-1, spwid=0) -> Quantity

Summary
get the integrated O2 lines Path

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 839 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getO3LinesOpacity (   self,
  args,
  kwargs 
) 
getO3LinesOpacity(self, nc=-1, spwid=0) -> double

Summary
get the integrated O3 Lines Opacity along the atmospheric path for channel nc in spectral window spwid

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 561 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getO3LinesPathLength (   self,
  args,
  kwargs 
) 
getO3LinesPathLength(self, nc=-1, spwid=0) -> Quantity

Summary
get the integrated O3 lines Path

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 855 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getProfile (   self,
  args,
  kwargs 
) 
getProfile(self, _thickness=_thickness_getProfile, _temperature=_temperature_getProfile, _watermassdensity=_watermassdensity_getProfile, 
    _water=_water_getProfile, _pressure=_pressure_getProfile, 
    _O3=_O3_getProfile, _CO=_CO_getProfile, _N2O=_N2O_getProfile) -> string

Summary
get atmospheric profile

Output Parameters:
_thickness       thickness of every atmospheric layer - Quantum with a vector value and unit of length, m 
_temperature     temperature of every atmospheric layer - Quantum with a vector value and unit of temperature, K 
_watermassdensity        water vapor mass density content of every atmospheric layer - Quantum with a vector value and unit of kg.m-3 
_water           water vapor content of every atmospheric layer - Quantum with a vector value and unit of m-3 
_pressure        pressure of every atmospheric layer - Quantum with a vector value and unit of Pascal 
_O3              O3 of every atmospheric layer - Quantum with a vector value and unit of m-3 
_CO              CO of every atmospheric layer - Quantum with a vector value and unit of m-3 
_N2O             N2O of every atmospheric layer - Quantum with a vector value and unit of m-3 

--------------------------------------------------------------------------------

Definition at line 277 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getRefChan (   self,
  spwid = 0 
) 
getRefChan(self, spwid=0) -> int

Summary
Get the reference channel of a given spectral window
   

Input Parameters:
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 364 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getRefFreq (   self,
  spwid = 0 
) 
getRefFreq(self, spwid=0) -> Quantity

Summary
Get the reference frequency of given spectral window
   

Input Parameters:
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 380 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getSkyBackgroundTemperature (   self) 
getSkyBackgroundTemperature(self) -> Quantity

Summary
Get the sky background temperature
--------------------------------------------------------------------------------

Definition at line 1157 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getSpectralWindow (   self,
  spwid = 0 
) 
getSpectralWindow(self, spwid=0) -> Quantity

Summary
Get the spectral grid for the specified spectral window.
   

Input Parameters:
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 429 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getTebbSky (   self,
  args,
  kwargs 
) 
getTebbSky(self, nc=-1, spwid=0, wh2o=Quantity(std::vector<double>(1, -1),"mm")) -> Quantity

Summary
Returns equiv. BB Temp

Input Parameters:
nc               Channel number (0-based) - defaults to reference channel -1 
spwid            Spectral window (0-based) 0 
wh2o             User specified water column length in mm. Default is not to use wh2o. -1 

--------------------------------------------------------------------------------

Definition at line 1184 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getTebbSkySpec (   self,
  args,
  kwargs 
) 
getTebbSkySpec(self, spwid=0, wh2o=Quantity(std::vector<double>(1, -1),"mm"), _tebbSky=_tebbSky_getTebbSkySpec) -> int

Summary
Returns equiv. BB Temp on each channel of a band

Input Parameters:
spwid            Spectral window (0-based) 0 
wh2o             User specified water column length in mm. Default is not to use wh2o. -1 


Output Parameters:
_tebbSky         the Equivalent Blackbody Temperatures in a band - Quantum with a vector value and unit of K 

--------------------------------------------------------------------------------

Definition at line 1201 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getUserWH2O (   self) 
getUserWH2O(self) -> Quantity

Summary
get the user zenith water vapor column
--------------------------------------------------------------------------------

Definition at line 1105 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getWetOpacity (   self,
  args,
  kwargs 
) 
getWetOpacity(self, nc=-1, spwid=0) -> Quantity

Summary
get the integrated Wet Opacity along the atmospheric path for channel nc in spectral window spwid

Input Parameters:
nc               Channel number (0-based; defaults to reference channel) -1 
spwid            Int standing for spectral window id (0-based) 0 

--------------------------------------------------------------------------------

Definition at line 609 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.getWetOpacitySpec (   self,
  args,
  kwargs 
) 
getWetOpacitySpec(self, spwid=0, _wetOpacity=_wetOpacity_getWetOpacitySpec) -> int

Summary
get the integrated Wet optical depth along the atmospheric path on each channel of a band

Input Parameters:
spwid            Int standing for spectral window id (0-based) 0 


Output Parameters:
_wetOpacity      wet opacity for each channel in band - Quantum with a vector value and unit of mm-1 

--------------------------------------------------------------------------------

Definition at line 676 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.initAtmProfile (   self,
  args,
  kwargs 
) 
initAtmProfile(self, altitude=Quantity(std::vector<double>(1, 5000.),"m"), temperature=Quantity(std::vector<double>(1, 270.0),"K"), 
    pressure=Quantity(std::vector<double>(1, 560.0),"mbar"), 
    maxAltitude=Quantity(std::vector<double>(1, 48.0),"km"), humidity=20.0, 
    dTem_dh=Quantity(std::vector<double>(1, -5.6),"K/km"), dP=Quantity(std::vector<double>(1, 10.0),"mbar"), 
    dPm=1.2, h0=Quantity(std::vector<double>(1, 2.0),"km"), 
    atmType=1) -> string

Summary
Set initial atmospheric profile for atmosphere tool
   

Input Parameters:
altitude         Site altitude - Quantity with units of altitude, meter 5000. 
temperature      Ambient Temperature - Quantity with units of temperature, K 270.0 
pressure         Ambient pressure - Quantity with units of pressure, mbar 560.0 
maxAltitude      altitude of the top pf the modelled atmosphere - Quantity with dimension of length, and units of kilometer 48.0 
humidity         used to guess water (0-100) 20.0 
dTem_dh          the derivative of temperature with respect to height - Quantity with units of K/km -5.6 
dP               initial pressure step - Quantity with the units of pressure, mb 10.0 
dPm              pressure multiplicative factor for steps 1.2 
h0               scale height for water( exp distribution ) - Quantity with the dimension of length, and units of kilometer 2.0 
atmType          atmospheric type 1(tropical),2(mid latitude summer),3(mid latitude winter), 4(subarctic summer),5(subarctic winter), dimensionless 1 

--------------------------------------------------------------------------------

Definition at line 171 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.initSpectralWindow (   self,
  args,
  kwargs 
) 
initSpectralWindow(self, nbands=1, fCenter=Quantity(std::vector<double>(1, 90),"GHz"), fWidth=Quantity(std::vector<double>(1, 0.64),"GHz"), 
    fRes=Quantity(std::vector<double>(1, 0.0),"GHz")) -> int

Summary
initialize spectral window

Input Parameters:
nbands           number of spectral windows/bands 1 
fCenter          center frequencies - Quantum with a vector value and unit of frequency, GHz 90 
fWidth           frequency width of band - Quantum with a vector value and unit of frequency, GHz 0.64 
fRes             resolution inside band - Quantum with a vector value and unit frequency, GHz. Default is for a single frequency. 0.0 

--------------------------------------------------------------------------------

Definition at line 301 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.listAtmosphereTypes (   self) 
listAtmosphereTypes(self) -> std::vector< std::string >

Summary
Returns a list of atmospheric types used by ATM.
   
--------------------------------------------------------------------------------

Definition at line 159 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.setAirMass (   self,
  args,
  kwargs 
) 
setAirMass(self, airmass) -> bool

Summary
Set the air mass

Input Parameters:
airmass          Air Mass 

--------------------------------------------------------------------------------

Definition at line 1116 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.setSkyBackgroundTemperature (   self,
  args,
  kwargs 
) 
setSkyBackgroundTemperature(self, tbgr=Quantity(std::vector<double>(1, 2.73),"K")) -> bool

Summary
Set the sky background temperature

Input Parameters:
tbgr             sky background temperature 2.73 

--------------------------------------------------------------------------------

Definition at line 1142 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.setUserWH2O (   self,
  args,
  kwargs 
) 
setUserWH2O(self, wh2o=Quantity(std::vector<double>(1, 0.0),"mm")) -> bool

Summary
set the user zenith water vapor column

Input Parameters:
wh2o             User water vapor column 0.0 

--------------------------------------------------------------------------------

Definition at line 1090 of file atmosphere.py.

def __casac__.atmosphere.atmosphere.updateAtmProfile (   self,
  args,
  kwargs 
) 
updateAtmProfile(self, altitude=Quantity(std::vector<double>(1, 5000.),"m"), temperature=Quantity(std::vector<double>(1, 270.0),"K"), 
    pressure=Quantity(std::vector<double>(1, 560.0),"mbar"), 
    humidity=20.0, dTem_dh=Quantity(std::vector<double>(1, -5.6),"K/km"), 
    h0=Quantity(std::vector<double>(1, 2.0),"km")) -> string

Summary
Update basic atmospheric parameters of atmosphere tool
   

Input Parameters:
altitude         Site altitude - Quantity with units of altitude, meter 5000. 
temperature      Ambient ground temperature - Quantity with units of temperature, K 270.0 
pressure         Ambient ground pressure - Quantity with units of pressure, mbar 560.0 
humidity         Relative humidy used to guess water (0-100) 20.0 
dTem_dh          Tropospheric Lapse Rate - the derivative of temperature with respect to height - Quantity with units of K/km -5.6 
h0               scale height for water( exp distribution ) - Quantity with the dimension of length, and units of kilometer 2.0 

--------------------------------------------------------------------------------

Definition at line 201 of file atmosphere.py.

Member Data Documentation

__casac__.atmosphere.atmosphere.__del__ [static, private]

Definition at line 146 of file atmosphere.py.

tuple __casac__.atmosphere.atmosphere.__getattr__ [static, private]

Definition at line 75 of file atmosphere.py.

__casac__.atmosphere.atmosphere.__repr__ [static, private]

Definition at line 76 of file atmosphere.py.

tuple __casac__.atmosphere.atmosphere.__setattr__ [static, private]

Definition at line 73 of file atmosphere.py.

__casac__.atmosphere.atmosphere.__swig_destroy__ [static, private]

Definition at line 145 of file atmosphere.py.

dictionary __casac__.atmosphere.atmosphere.__swig_getmethods__ [static, private]

Definition at line 74 of file atmosphere.py.

dictionary __casac__.atmosphere.atmosphere.__swig_setmethods__ [static, private]

Definition at line 72 of file atmosphere.py.

__casac__.atmosphere.atmosphere.this

Definition at line 144 of file atmosphere.py.

The documentation for this class was generated from the following file:
Generated on Thu Nov 15 2012 15:57:14 for casa by   doxygen 1.8.0