class QucObservationModel : public CorBase

model of an observation

Inheritance:


Public Methods

void add ( const QucOpticalRay& aRay )
void addUV ( double anIntensity = 1, double aU = 0, double aV = 0, double aWaveLength = 550, double aTime = 0 )
void addXY ( double anIntensity = 1, double anX = 0, double aY = 0, double aWaveLength = 550, double aTime = 0 )
void clear ()
void copy ( const QucObservationModel& aRef )
const QucOpticalRay& first ()
RWCString getName ()
int getSize ()
QucUnitType getUnitI ()
QucUnitType getUnitT ()
QucUnitType getUnitU ()
QucUnitType getUnitV ()
QucUnitType getUnitW ()
QucUnitType getUnitX ()
QucUnitType getUnitY ()
int getWaveBand ( double* aLowerLimit, double* aHigherLimit )
CorBool isDone ()
const QucOpticalRay& next ()
CorBool operator!= ( const QucObservationModel& aRef )
QucObservationModel& operator= ( const QucObservationModel& aRef )
CorBool operator== ( const QucObservationModel& aRef )
QucOpticalRay operator[] ( unsigned int aRay )
QucObservationModel photons ()
QucObservationModel ( const QucObservationModel& aRef )
QucObservationModel ( int aNumber = 1, RWCString aName = "ObservationModel" )
void setUnits ( QucUnitType aUnitI = QucIntensityUnit, QucUnitType aUnitU = QucDirectionalAngleUnit, QucUnitType aUnitV = QucDirectionalAngleUnit, QucUnitType aUnitX = QucTangentialProjectionUnit, QucUnitType aUnitY = QucTangentialProjectionUnit, QucUnitType aUnitW = QucWaveLengthUnit, QucUnitType aUnitT = QucTimeUnit )
void setUnits ( RWCString aUnitI = QucIntensityUnitS, RWCString aUnitU = QucDirectionalAngleUnitS, RWCString aUnitV = QucDirectionalAngleUnitS, RWCString aUnitX = QucTangentialProjectionUnitS, RWCString aUnitY = QucTangentialProjectionUnitS, RWCString aUnitW = QucWaveLengthUnitS, RWCString aUnitT = QucTimeUnitS )
void setUnitsFrom ( const QucObservationModel& aModel )
const QucOpticalRay& start ()
void writeFile ( RWCString aFileName, char* x, char* y, RWCString aMode = "noheader" )
virtual ~QucObservationModel ()

Public


Purpose
Query the unit of the v directional angle

Purpose
Forget about the stored rays, reset any iteration

Purpose
The d'tor

Purpose
Return the first ray

Purpose
Query the number of rays stored

Purpose
Has the list been propagated to the end?

Preconditions

  • Itemize this section if necessary

Purpose
Convert this observation model from flux to photons

Purpose
Query the unit of the wave length

Purpose
Query the unit of the u directional angle

$Id: QucObservationModel

Purpose
Query the unit of the x tangent

Purpose
Query the unit of the y tangent

Purpose
Query the unit of the time

Purpose
Query the unit of the intensity

Purpose
Query the name of this observation

Purpose
Query the first optical ray stored and initiate everything for an iteration

Purpose
Query the next ray and continue in the iteration

Documentation

model of an observation
$Id: QucObservationModel.h,v 1.8 1997/04/11 14:11:09 mwiedmer Exp $

SYNOPSIS

    #include <QucObservationModel.h>
  
    QucObservationModel myObject;
  

DESCRIPTION
This class models an observation.

CAUTIONS
<optional>

EXAMPLES
<optional>

SEE ALSO
QucOpticalRay
QucEquipmentModel
CorBase

QucObservationModel( int aNumber = 1, RWCString aName = "ObservationModel" )

QucObservationModel( const QucObservationModel& aRef )

QucObservationModel& operator=( const QucObservationModel& aRef )

CorBool operator==( const QucObservationModel& aRef )

CorBool operator!=( const QucObservationModel& aRef )

virtual ~QucObservationModel()

Purpose
The d'tor.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

QucOpticalRay operator[]( unsigned int aRay )

const QucOpticalRay& first()

Purpose
Return the first ray.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns a reference to the first ray.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

int getWaveBand( double* aLowerLimit, double* aHigherLimit )

int getSize()

Purpose
Query the number of rays stored.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the number of rays held.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

CorBool isDone()

Purpose
Has the list been propagated to the end?

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns whether the last ray has been inspected.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

QucObservationModel photons()

Purpose
Convert this observation model from flux to photons.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns an observation model in photon state.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

QucUnitType getUnitW()

Purpose
Query the unit of the wave length.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit of the wave length.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

QucUnitType getUnitU()

Purpose
Query the unit of the u directional angle.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit of the u directional angle.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

QucUnitType getUnitV()

Purpose
Query the unit of the v directional angle.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit of the v directional angle.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

QucUnitType getUnitX()

Purpose
Query the unit of the x tangent.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit of the x tangent.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

QucUnitType getUnitY()

Purpose
Query the unit of the y tangent.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit of the y tangent.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

QucUnitType getUnitT()

Purpose
Query the unit of the time.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit of the time.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

QucUnitType getUnitI()

Purpose
Query the unit of the intensity.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit of the intensity.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

RWCString getName()

Purpose
Query the name of this observation.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the name of this observation.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

const QucOpticalRay& start()

Purpose
Query the first optical ray stored and initiate everything for an iteration.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns a reference to the first ray held.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

const QucOpticalRay& next()

Purpose
Query the next ray and continue in the iteration.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the next ray in the iteration.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

void copy( const QucObservationModel& aRef )

void add( const QucOpticalRay& aRay )

void addUV( double anIntensity = 1, double aU = 0, double aV = 0, double aWaveLength = 550, double aTime = 0 )

void addXY( double anIntensity = 1, double anX = 0, double aY = 0, double aWaveLength = 550, double aTime = 0 )

void clear()

Purpose
Forget about the stored rays, reset any iteration.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

void writeFile( RWCString aFileName, char* x, char* y, RWCString aMode = "noheader" )

void setUnits( QucUnitType aUnitI = QucIntensityUnit, QucUnitType aUnitU = QucDirectionalAngleUnit, QucUnitType aUnitV = QucDirectionalAngleUnit, QucUnitType aUnitX = QucTangentialProjectionUnit, QucUnitType aUnitY = QucTangentialProjectionUnit, QucUnitType aUnitW = QucWaveLengthUnit, QucUnitType aUnitT = QucTimeUnit )

void setUnits( RWCString aUnitI = QucIntensityUnitS, RWCString aUnitU = QucDirectionalAngleUnitS, RWCString aUnitV = QucDirectionalAngleUnitS, RWCString aUnitX = QucTangentialProjectionUnitS, RWCString aUnitY = QucTangentialProjectionUnitS, RWCString aUnitW = QucWaveLengthUnitS, RWCString aUnitT = QucTimeUnitS )

void setUnitsFrom( const QucObservationModel& aModel )


This class has no child classes.

alphabetic index hierarchy of classes


this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de