class QucFilter : public QucEquipmentModel

a model of a spectral filter

Inheritance:

public members:

	QucFilter ( CorString aName = "NoName", CorString aType = "Reference", CorString aCol1 = ":LAMBDA", CorString aCol2 = ":FLUX" ) CorString aName CorString aType CorString aCol1 CorString aCol2
	QucFilter ( const QucFilter & aRef ) const QucFilter & aRef
QucFilter &	operator= ( const QucFilter & aRef ) const QucFilter & aRef
virtual	~QucFilter ()
virtual QucObservationModel	leafTransform ( const QucObservationModel & anObservation, CorString aMode = "all" ) const QucObservationModel & anObservation CorString aMode
virtual void	getWaveBand ( QucUnitType aUnit, double& aLowerLimit, double& anUpperLimit ) const QucUnitType aUnit double& aLowerLimit double& anUpperLimit
double	getTrans ( double aWave ) const double aWave
void	scaleAt ( double aWave, QucUnitType aUnit, double aScale, QucUnitType anotherUnit ) double aWave QucUnitType aUnit double aScale QucUnitType anotherUnit
void	initialize ( CorString aName, CorString aType = "t", CorString aCol1 = ":LAMBDA", CorString aCol2 = ":FLUX" ) CorString aName CorString aType CorString aCol1 CorString aCol2

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 <QucFilter.h>
  

DESCRIPTION
This class models a spectral filter.

CAUTIONS
<optional>

EXAMPLES
<optional>

SEE ALSO
QucEquipmentModel

QucFilter ( CorString aName = "NoName", CorString aType = "Reference", CorString aCol1 = ":LAMBDA", CorString aCol2 = ":FLUX" )

Purpose
The default c'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aName

name of this filter

CorString aType

type name

CorString aCol1

name of first column

CorString aCol2

name of secound column

QucFilter ( const QucFilter & 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 QucFilter & aRef

the reference instance

QucFilter & operator= ( const QucFilter & 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 QucFilter & aRef

the reference instance

virtual ~QucFilter ()

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 model according to the rules of the filter.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns a transformed observation model.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucObservationModel & anObservation

observation to transform

CorString aMode

mode

virtual void getWaveBand ( QucUnitType aUnit, 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 aUnit

unit

double& aLowerLimit

lowest wave length

double& anUpperLimit

highest wave length

double getTrans ( double aWave ) const

Purpose
Query the transmission at a given wavelength.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the interpolated transmission.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aWave

wave length in nm

void scaleAt ( double aWave, QucUnitType aUnit, double aScale, QucUnitType anotherUnit )

Purpose
Scale the transmission with respect to a given wavelength.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aWave

a wave length

QucUnitType aUnit

unit

double aScale

transmission at the abovew wavelength

QucUnitType anotherUnit

transmission unit (unitless or %)

void initialize ( CorString aName, CorString aType = "t", CorString aCol1 = ":LAMBDA", CorString aCol2 = ":FLUX" )

Purpose
Initialize this instance from the calibration database.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aName

file name

CorString aType

type name ("file" or "table")

CorString aCol1

name of first column

CorString aCol2

name of secound column

generated by doc++