RetrievalQuantity Class Reference

Contains the data for one retrieval quantity. More...

#include <jacobian.h>

Public Member Functions
	RetrievalQuantity ()
	Default constructor. More...
	RetrievalQuantity (const RetrievalQuantity &x)
	Copy constructor. More...
	RetrievalQuantity (const String &maintag, const String &subtag, const String &mode, const Index &analytical, const Numeric &perturbation, const MakeArray< Vector > &grids)
	Constructor that sets the values. More...
const String &	MainTag () const
	Main tag. More...
void	MainTag (const String &mt)
const String &	Subtag () const
	Subtag. More...
void	Subtag (const String &st)
const String &	Mode () const
	Calculation mode. More...
void	Mode (const String &m)
const Index &	Analytical () const
	Boolean to make analytical calculations (if possible). More...
void	Analytical (const Index &m)
const Numeric &	Perturbation () const
	Size of perturbation used for perturbation calculations. More...
void	Perturbation (const Numeric &p)
const ArrayOfVector &	Grids () const
	Grids. More...
void	Grids (const ArrayOfVector &g)

Private Attributes
String	mmaintag
String	msubtag
String	mmode
Index	manalytical
Numeric	mperturbation
ArrayOfVector	mgrids

Detailed Description

Contains the data for one retrieval quantity.

Author

Mattias Ekstrom

Definition at line 45 of file jacobian.h.

Constructor & Destructor Documentation

RetrievalQuantity() [1/3]

RetrievalQuantity::RetrievalQuantity ( )

inline

Default constructor.

Needed by make_array.

Definition at line 49 of file jacobian.h.

RetrievalQuantity() [2/3]

RetrievalQuantity::RetrievalQuantity ( const RetrievalQuantity &  x )

inline

Copy constructor.

We need this, since operator= does not work correctly for Arrays. (Target Array has to be resized first.)

Definition at line 60 of file jacobian.h.

RetrievalQuantity() [3/3]

RetrievalQuantity::RetrievalQuantity ( const String &  maintag, const String &  subtag, const String &  mode, const Index &  analytical, const Numeric &  perturbation, const MakeArray< Vector > &  grids  )

inline

Constructor that sets the values.

Definition at line 70 of file jacobian.h.

Member Function Documentation

Analytical() [1/2]

const Index& RetrievalQuantity::Analytical ( ) const

inline

Boolean to make analytical calculations (if possible).

Definition at line 96 of file jacobian.h.

References manalytical.

Referenced by jacobianAddAbsSpecies(), jacobianAddFreqShiftAndStretch(), jacobianAddPointingZa(), jacobianAddPolyfit(), jacobianAddTemperature(), jacobianCalcAbsSpeciesPerturbations(), jacobianCalcTemperaturePerturbations(), operator<<(), and xml_write_to_stream().

Analytical() [2/2]

void RetrievalQuantity::Analytical ( const Index &  m )

inline

Definition at line 97 of file jacobian.h.

References manalytical.

Grids() [1/2]

const ArrayOfVector& RetrievalQuantity::Grids ( ) const

inline

Grids.

Definition grids for the jacobian, eg. p, lat and lon.

Definition at line 102 of file jacobian.h.

References mgrids.

Referenced by diy_from_path_to_rgrids(), jacobianAddAbsSpecies(), jacobianAddFreqShiftAndStretch(), jacobianAddPointingZa(), jacobianAddPolyfit(), jacobianAddTemperature(), jacobianCalcAbsSpeciesPerturbations(), jacobianCalcFreqShiftAndStretchInterp(), jacobianCalcPointingZaInterp(), jacobianCalcPointingZaRecalc(), jacobianCalcTemperaturePerturbations(), and xml_write_to_stream().

Grids() [2/2]

void RetrievalQuantity::Grids ( const ArrayOfVector &  g )

inline

Definition at line 103 of file jacobian.h.

References mgrids.

MainTag() [1/2]

const String& RetrievalQuantity::MainTag ( ) const

inline

Main tag.

Definition at line 87 of file jacobian.h.

References mmaintag.

Referenced by jacobianAddAbsSpecies(), jacobianAddFreqShiftAndStretch(), jacobianAddPointingZa(), jacobianAddPolyfit(), jacobianAddTemperature(), operator<<(), and xml_write_to_stream().

MainTag() [2/2]

void RetrievalQuantity::MainTag ( const String &  mt )

inline

Definition at line 88 of file jacobian.h.

References mmaintag.

Mode() [1/2]

const String& RetrievalQuantity::Mode ( ) const

inline

Calculation mode.

Eg. "abs", "rel", "vmr" and "nd".

Definition at line 93 of file jacobian.h.

References mmode.

Referenced by jacobianAddAbsSpecies(), jacobianAddFreqShiftAndStretch(), jacobianAddPointingZa(), jacobianAddPolyfit(), jacobianAddTemperature(), jacobianCalcAbsSpeciesPerturbations(), operator<<(), and xml_write_to_stream().

Mode() [2/2]

void RetrievalQuantity::Mode ( const String &  m )

inline

Definition at line 94 of file jacobian.h.

References mmode.

Perturbation() [1/2]

const Numeric& RetrievalQuantity::Perturbation ( ) const

inline

Size of perturbation used for perturbation calculations.

Definition at line 99 of file jacobian.h.

References mperturbation.

Referenced by jacobianAddAbsSpecies(), jacobianAddFreqShiftAndStretch(), jacobianAddPointingZa(), jacobianAddPolyfit(), jacobianAddTemperature(), jacobianCalcAbsSpeciesPerturbations(), jacobianCalcFreqShiftAndStretchInterp(), jacobianCalcPointingZaInterp(), jacobianCalcPointingZaRecalc(), jacobianCalcTemperaturePerturbations(), and xml_write_to_stream().

Perturbation() [2/2]

void RetrievalQuantity::Perturbation ( const Numeric &  p )

inline

Definition at line 100 of file jacobian.h.

References mperturbation.

Subtag() [1/2]

const String& RetrievalQuantity::Subtag ( ) const

inline

Subtag.

Eg. for gas species: O3, ClO.

Definition at line 90 of file jacobian.h.

References msubtag.

Referenced by jacobianAddAbsSpecies(), jacobianAddFreqShiftAndStretch(), jacobianAddPointingZa(), jacobianAddPolyfit(), jacobianAddTemperature(), jacobianCalcTemperaturePerturbations(), operator<<(), and xml_write_to_stream().

Subtag() [2/2]

void RetrievalQuantity::Subtag ( const String &  st )

inline

Definition at line 91 of file jacobian.h.

References msubtag.

Member Data Documentation

manalytical

Index RetrievalQuantity::manalytical

private

Definition at line 110 of file jacobian.h.

Referenced by Analytical().

mgrids

ArrayOfVector RetrievalQuantity::mgrids

private

Definition at line 112 of file jacobian.h.

Referenced by Grids().

mmaintag

String RetrievalQuantity::mmaintag

private

Definition at line 107 of file jacobian.h.

Referenced by MainTag().

mmode

String RetrievalQuantity::mmode

private

Definition at line 109 of file jacobian.h.

Referenced by Mode().

mperturbation

Numeric RetrievalQuantity::mperturbation

private

Definition at line 111 of file jacobian.h.

Referenced by Perturbation().

msubtag

String RetrievalQuantity::msubtag

private

Definition at line 108 of file jacobian.h.

Referenced by Subtag().

---

The documentation for this class was generated from the following file:

• jacobian.h