class QucBlackbody

class QucBlackbody : public CorBase

a model of a celestial body

Inheritance:

public members:

QucBlackbody ( double aTemperature = 6000 )

double

aTemperature

QucBlackbody ( const QucBlackbody & aRef )

const QucBlackbody &

aRef

QucBlackbody &

operator= ( const QucBlackbody & aRef )

const QucBlackbody &

aRef

virtual

~QucBlackbody ()

void

setTemperature ( double aTemperature )

double

aTemperature

void

setMagnitude ( double aMagnitude, double wavelength = 5500, CorString aUnit = "angstrom" )

double	aMagnitude
double	wavelength
CorString	aUnit

void

setMagnitude ( double aMagnitude, CorString aBand )

double	aMagnitude
CorString	aBand

void

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

double*	aW
double*	aF
int	aN
CorString	aUnitType

double

getFNu ( double aNu, CorString aUnit = "hz" )

double	aNu
CorString	aUnit

double

getMagnitude ( double aWave, CorString aUnit = "angstrom" )

double	aWave
CorString	aUnit

CorString

getUnitFLambda ()

Documentation

SYNOPSIS
    #include <QucBlackbody.h>
  
    QucBlackbody myObject;
  
DESCRIPTION
This class models a blackbody in space.
CAUTIONS
<optional>
EXAMPLES
<optional>
SEE ALSO
<optional>
CorBase

QucBlackbody ( double aTemperature = 6000 )

Purpose
The default c'tor.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aTemperature: temperature of this body

QucBlackbody ( const QucBlackbody & 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 QucBlackbody & aRef: the reference instance

QucBlackbody & operator= ( const QucBlackbody & 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 QucBlackbody & aRef: the reference instance

virtual ~QucBlackbody ()

Purpose
The d'tor.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

void setTemperature ( double aTemperature )

Purpose
Set the temperature attribute of this instance.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aTemperature: new temperature value

void setMagnitude ( double aMagnitude, double wavelength = 5500, CorString aUnit = "angstrom" )

Purpose
Set the magnitude of this body through a magnitude and wavelength.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aMagnitude: new magnitude value
double wavelength: wavelength
CorString aUnit

void setMagnitude ( double aMagnitude, CorString aBand )

Purpose
Set the magnitude of this body through a magnitude and broad band.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aMagnitude: new magnitude value
CorString aBand: broad band

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

Purpose
Query the 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 of wavelengths to consider
double* aF: array of flux
int aN: number of elements in arrays
CorString aUnitType: unit of the wavelengths

double getFNu ( double aNu, CorString aUnit = "hz" )

Purpose
Query the flux per unit of frequency.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the flux.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aNu: frequency
CorString aUnit: unit of frequency

double getMagnitude ( double aWave, CorString aUnit = "angstrom" )

Purpose
Query the magnitude of this blackbody.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns a monochromatic magnitude.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aWave: wavelength to consider
CorString aUnit: unit of the wavelength

CorString getUnitFLambda ()

Purpose
Query the unit of the flux per unit of wavelength.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the flux unit attribute.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

this class has no child classes.

alphabetic index hierarchy of classes

VLT-DFS Subsystem Core - User Manual 1.1

VLT-MAN-ESO-19000-0001

generated by doc++