class QucGrism : public QucEquipmentModel

a model of a grism

Inheritance:

public members:

	QucGrism ( CorString aName = "Grism" ) CorString aName
	QucGrism ( const QucGrism & aRef ) const QucGrism & aRef
QucGrism &	operator= ( const QucGrism & aRef ) const QucGrism & aRef
virtual	~QucGrism ()
void	setDirection ( QucDirection anInNormal, QucDirection anOutNormal ) QucDirection anInNormal QucDirection anOutNormal
void	setOrder ( int anOrder ) int anOrder
void	fitIndexIn ( int aNumber, double* aLambda, double* anIndex ) int aNumber double* aLambda double* anIndex
double	getIndexIn ( double aLambda ) const double aLambda
void	setIndexIn ( double aLamda ) double aLamda
void	setIndexOut ( double aLamda ) double aLamda
void	setGroove ( double aNumberOfGrooves ) double aNumberOfGrooves
QucDirection	disperse ( QucDirection aDirection, double aLambda = 550.0, int aK = 1 ) QucDirection aDirection double aLambda int aK
void	print ()
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

protected members:

virtual void

become ( const QucGrism & aRef ) const QucGrism & aRef

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 <QucGrism.h>
  
    QucGrism myObject;
  

DESCRIPTION
This class models a grism, a prism with an engraved grating on one side.

CAUTIONS
<optional>

EXAMPLES
<optional>

SEE ALSO
QucEquipmentModel
QucGrating
QucPlane

QucGrism ( CorString aName = "Grism" )

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

the name of this instance

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

the reference instance

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

the reference instance

virtual ~QucGrism ()

Purpose
The d'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

void setDirection ( QucDirection anInNormal, QucDirection anOutNormal )

Purpose
Set the refraction directions of the grism.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucDirection anInNormal

the normal of the input plane

QucDirection anOutNormal

the normal of the output plane

void setOrder ( int anOrder )

Purpose
Set some order.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

int anOrder

number of indices

void fitIndexIn ( int aNumber, double* aLambda, double* anIndex )

Purpose
Fit the indices.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

int aNumber

number of indices

double* aLambda

array of wavelength values (in nm)

double* anIndex

array of refraction indices (in nm)

double getIndexIn ( double aLambda ) const

Purpose
Query the refraction index of the input plane.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the refraction index of the grism material at the supplied wavelength.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aLambda

wavelength to consider (in nm)

void setIndexIn ( double aLamda )

Purpose
Set the refraction index of the input plane.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aLamda

new index

void setIndexOut ( double aLamda )

Purpose
Set the refraction index of the output plane.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aLamda

new refraction index index

void setGroove ( double aNumberOfGrooves )

Purpose
Set th number of grooves per mm on the exit face of the grism.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aNumberOfGrooves

number of grooves

QucDirection disperse ( QucDirection aDirection, double aLambda = 550.0, int aK = 1 )

Purpose
Apply disperion equation of the grism.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the dispersion of a light beam of given direction, wavelength and order.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucDirection aDirection

beam's direction

double aLambda

beam's wavelength

int aK

beam's order

void print ()

Purpose
Print the refraction indices of the grism.

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 euipment.

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

defines in which unit the wavelengths are returned

double& aLowerLimit

lowest wave length

double& anUpperLimit

highest wave length

virtual void become ( const QucGrism & aRef )

Purpose
This instance will look like a reference instance.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucGrism & aRef

the reference instance

this class has no child classes.

generated by doc++