class QucAtmosphere : public QucEquipmentModel

a model of the atmosphere

Inheritance:

public members:

	QucAtmosphere ()
	QucAtmosphere ( const QucAtmosphere & aRef ) const QucAtmosphere & aRef
QucAtmosphere &	operator= ( const QucAtmosphere & aRef ) const QucAtmosphere & aRef
virtual	~QucAtmosphere ()
virtual QucObservationModel	leafTransform ( const QucObservationModel & anObservation, CorString aMode = "all" ) const QucObservationModel & anObservation CorString aMode
virtual void	getWaveBand ( QucUnitType aUnitType, double& aLowerLimit, double& anUpperLimit ) const QucUnitType aUnitType double& aLowerLimit double& anUpperLimit
void	getContBand ( CorString aUnitType, double& aLowerLimit, double& anUpperLimit ) const CorString aUnitType double& aLowerLimit double& anUpperLimit
void	getFLambda ( double* aW, double* aF, int aN = 1, CorString aUnitType = "nm" ) double* aW double* aF int aN CorString aUnitType
void	setAirmass ( double aMass ) double aMass
void	scaleAt ( double anIndex, QucUnitType aUnit, double aFactor ) double anIndex QucUnitType aUnit double aFactor
void	setSpectrum ( CorString aSky, CorString aLine ) CorString aSky CorString aLine
QucObservationModel	getContinuum ( double* aWave, int n ) double* aWave int n
QucUnitType	getUnitW () const
QucUnitType	getUnitI () const

Inherited from QucEquipmentModel:

public members:

QucEquipmentModel & operator=( const QucEquipmentModel & aRef )

const QucEquipmentModel &

aRef

virtual QucObservationModel transform( const QucObservationModel & anObservation, CorString aMode = "all" )

const QucObservationModel &	anObservation
CorString	aMode

CorString getName() const

void setName( CorString aName )

CorString

aName

CorString getType() const

void setType( CorString aType )

CorString

aType

void setWaveBand( double aLowerBound, double anUpperBound )

double	aLowerBound
double	anUpperBound

void getWaveBand( double& aLowerLimit, double& anUpperLimit ) const

double&	aLowerLimit
double&	anUpperLimit

virtual void getWaveBand( QucUnitType aUnit, double& aLowerLimit, double& anUpperLimit ) const

QucUnitType	aUnit
double&	aLowerLimit
double&	anUpperLimit

void setTransform( QucTransform aType )

QucTransform

aType

void setDirection( const QucDirection & aDir )

const QucDirection &

aDir

QucDirection getDirection() const

virtual CorStream& operator>>( CorStream& aStream )

CorStream&

aStream

virtual CorStream& operator<<( CorStream& aStream ) const

CorStream&

aStream

CorBool loadIDF( CorStream& aStream )

CorStream&

aStream

CorBool saveIDF( CorStream& aStream ) const

CorStream&

aStream

protected members:

virtual QucObservationModel leafTransform( const QucObservationModel & anObservation, CorString aMode = "all" )

const QucObservationModel &	anObservation
CorString	aMode

DfcSignature& getSig()

const DfcSignature& getSig() const

SYNOPSIS

    #include <QucAtmosphere.h>
  
    QucAtmosphere myObject;
  

DESCRIPTION
This class models the atmosphere of this planet.

CAUTIONS
<optional>

EXAMPLES
<optional>

SEE ALSO
<optional>
QucEquipmentModel

QucAtmosphere ()

Purpose
The default c'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

QucAtmosphere ( const QucAtmosphere & aRef )

Purpose
The copy c'tor creates a new instance from a reference.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucAtmosphere & aRef

the reference instance

QucAtmosphere & operator= ( const QucAtmosphere & aRef )

Purpose
The assignment operator makes this instance look like another one.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
A reference to this instance.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucAtmosphere & aRef

the reference instance

virtual ~QucAtmosphere ()

Purpose
The d'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

virtual QucObservationModel leafTransform ( const QucObservationModel & anObservation, CorString aMode = "all" )

Purpose
Transform an observation.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the transformed observation.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucObservationModel & anObservation

observation to transform

CorString aMode

mode

virtual void getWaveBand ( QucUnitType aUnitType, double& aLowerLimit, double& anUpperLimit ) const

Purpose
Query the waveband of this instance.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucUnitType aUnitType

defines in which unit the wavelengths are returned

double& aLowerLimit

lower band limit

double& anUpperLimit

upper limit

void getContBand ( CorString aUnitType, double& aLowerLimit, double& anUpperLimit ) const

Purpose
Query the band over which the sky continuum is defined.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aUnitType

defines in which unit the wavelengths are returned

double& aLowerLimit

lower band limit

double& anUpperLimit

upper limit

void getFLambda ( double* aW, double* aF, int aN = 1, CorString aUnitType = "nm" )

Purpose
Query the (sky) flux per unit of wavelength at a given wavelength.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double* aW

array wavelengths to consider

double* aF

array of flux

int aN

number of elements in arrays

CorString aUnitType

unit of supplied wavelength

void setAirmass ( double aMass )

Purpose
Set the airmass attribute of this instance.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aMass

new airmass value

void scaleAt ( double anIndex, QucUnitType aUnit, double aFactor )

Purpose
Scale this instance at a specific position for a given unit.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double anIndex

a position

QucUnitType aUnit

unit

double aFactor

scaling factor

void setSpectrum ( CorString aSky, CorString aLine )

Purpose
Set the sky spectrum attribute of this instance.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aSky

"dark" or "bright"

CorString aLine

"none" or "lines"

QucObservationModel getContinuum ( double* aWave, int n )

Purpose
Query the sky continuum attribute of this instance.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the continuum as an observation.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double* aWave

array wavelength

int n

number of elements in supplied array

QucUnitType getUnitW () const

Purpose
Query the wavelength unit (default unit).

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit type of the wavelength.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

QucUnitType getUnitI () const

Purpose
Query the flux unit.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit type of the intensity.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

generated by doc++