class QucDetector : public QucEquipmentModel

a model of a detector instrument

Inheritance:

public members:

	QucDetector ( CorString aName = "CCD" ) CorString aName
	QucDetector ( const QucDetector & aRef ) const QucDetector & aRef
QucDetector &	operator= ( const QucDetector & aRef ) const QucDetector & aRef
virtual	~QucDetector ()
void	clear ()
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
void	setReadOut ( double aTime, CorString aMode ) double aTime CorString aMode
double	getPixelSize () const
double	pixelArea ( double aPsf, QucUnitType aUnit ) double aPsf QucUnitType aUnit
double	getRON () const
double	getGain () const
void	setReference ( CorString aName ) CorString aName
void	getTime ( double* aTime, double* aS2n, int aN, QucObservationModel anObject, QucObservationModel aSky, double aPsf, QucUnitType aUnit ) double* aTime double* aS2n int aN QucObservationModel anObject QucObservationModel aSky double aPsf QucUnitType aUnit
void	getS2N ( double* aS2n, double* aTime, int aN, QucObservationModel anObject, QucObservationModel aSky, double aPsf, QucUnitType aUnit ) double* aS2n double* aTime int aN QucObservationModel anObject QucObservationModel aSky double aPsf QucUnitType aUnit
void	setParams ( double aGainS = 1, double aGainF = 1, double aDarkS = 0, double aDarkF = 0, double aBias = 0, int aSaturation = 1000000 ) double aGainS double aGainF double aDarkS double aDarkF double aBias int aSaturation
void	integrate ( QucObservationModel anObservation, double* anObject ) QucObservationModel anObservation double* anObject
void	integrateCCD ( QucObservationModel anObject, QucObservationModel aSky, double aPsf, QucUnitType aUnit, double* anObject, double* aSky, double* aPix ) QucObservationModel anObject QucObservationModel aSky double aPsf QucUnitType aUnit double* anObject double* aSky double* aPix
void	loadCCDTable ( CorString aFileName ) CorString aFileName

protected members:

virtual void

become ( const QucDetector & aRef ) const QucDetector & 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 <QucDetector.h>
  
    QucDetector myObject;
  

DESCRIPTION
This class models a detector in a telescope.

CAUTIONS
<optional>

EXAMPLES
<optional>

SEE ALSO
<optional>
QucEquipmentModel

QucDetector ( CorString aName = "CCD" )

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 detector

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

the reference instance

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

the reference instance

virtual ~QucDetector ()

Purpose
The d'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

void clear ()

Purpose
Release all resources.

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

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

void setReadOut ( double aTime, CorString aMode )

Purpose
Set the read out mode of the detector into slow or fast.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aTime

time of read out

CorString aMode

read out mode ("slow" or "fast")

double getPixelSize () const

Purpose
Query the detector pixel size in micrometres.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the pixel size attribute.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

double pixelArea ( double aPsf, QucUnitType aUnit )

Purpose
Query the pixel area covered by a circle of a given radius.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns an area.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aPsf

circle radius

QucUnitType aUnit

unit of the radius (of length type)

double getRON () const

Purpose
Query the read out noise of the detector.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the read out noise attribute.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

double getGain () const

Purpose
Query the gain of the detector. (Conversion factor from electrons to ADUs)

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the detector gain.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

void setReference ( CorString aName )

Purpose
Initialise this detector using the calibration database.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aName

CCD reference number eg, CCD25

void getTime ( double* aTime, double* aS2n, int aN, QucObservationModel anObject, QucObservationModel aSky, double aPsf, QucUnitType aUnit )

Purpose
Query the exposure time needed to reach a given signal to noise.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double* aTime

time output (array)

double* aS2n

signal/noise input (array)

int aN

numebr of elements

QucObservationModel anObject

object

QucObservationModel aSky

sky

double aPsf

seeing value

QucUnitType aUnit

unit of seeing (of length type)

void getS2N ( double* aS2n, double* aTime, int aN, QucObservationModel anObject, QucObservationModel aSky, double aPsf, QucUnitType aUnit )

Purpose
Query the signal to noise ratio.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double* aS2n

singal/noise output (array)

double* aTime

exposure time input (array)

int aN

number of elements

QucObservationModel anObject

object

QucObservationModel aSky

sky?

double aPsf

seeing value

QucUnitType aUnit

unit of seeing (of length type)

void setParams ( double aGainS = 1, double aGainF = 1, double aDarkS = 0, double aDarkF = 0, double aBias = 0, int aSaturation = 1000000 )

Purpose
Set the attributes.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aGainS

gain for slow read out

double aGainF

gain for fast read out

double aDarkS

dark current for slow read out

double aDarkF

dark current for fast read out

double aBias

bias value

int aSaturation

saturation value

void integrate ( QucObservationModel anObservation, double* anObject )

Purpose
Integrate an observation model over the wavelength range.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucObservationModel anObservation

observation to integrate

double* anObject

integrated result (output)

void integrateCCD ( QucObservationModel anObject, QucObservationModel aSky, double aPsf, QucUnitType aUnit, double* anObject, double* aSky, double* aPix )

Purpose
Integrates object and sky and comnputes psf pixel area.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucObservationModel anObject

object

QucObservationModel aSky

sky

double aPsf

seeing value

QucUnitType aUnit

unit of seeing (of length type)

double* anObject

integrated object (output)

double* aSky

integrated sky (output)

double* aPix

number of pixels for the psf area

void loadCCDTable ( CorString aFileName )

Purpose
Load a CCD table.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aFileName

file name of the table

virtual void become ( const QucDetector & 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 QucDetector & aRef

the reference instance

this class has no child classes.

generated by doc++