Enumerators common to the ComponentsModels module. More...

#include <ComponentType.h>

Public Types
enum	Shape { POINT, GAUSSIAN, DISK, LDISK, UNKNOWN_SHAPE, NUMBER_SHAPES }
	The shapes of all the components. More...

enum	Polarisation { STOKES, LINEAR, CIRCULAR, UNKNOWN_POLARISATION, NUMBER_POLARISATIONS }
	The ways the Flux polarisation can be represented. More...

enum	SpectralShape { CONSTANT_SPECTRUM, SPECTRAL_INDEX, TABULAR_SPECTRUM, UNKNOWN_SPECTRAL_SHAPE, NUMBER_SPECTRAL_SHAPES }
	The different functional forms for the spectral variation. More...

Static Public Member Functions
static casacore::String	name (ComponentType::Shape shapeEnum)
	Convert the Shape enumerator to a string. More...

static ComponentType::Shape	shape (const casacore::String &shapeName)
	Convert a given casacore::String to a Shape enumerator (min match active) More...

static casacore::String	name (ComponentType::Polarisation fluxEnum)
	Convert the Polarisation enumerator to a string. More...

static ComponentType::Polarisation	polarisation (const casacore::String &polarisationName)
	Convert a given casacore::String to a Polarisation enumerator. More...

static casacore::String	name (ComponentType::SpectralShape spectralEnum)
	Convert the SpectralShape enumerator to a string. More...

static ComponentType::SpectralShape	spectralShape (const casacore::String &spectralName)
	Convert a given casacore::String to a SpectralShape enumerator. More...

Static Private Member Functions
static ComponentShape *	construct (ComponentType::Shape shapeEnum)
	Convert the Shape enumerator to a shape object (upcast to the base object). More...

static SpectralModel *	construct (ComponentType::SpectralShape spectralEnum)
	Convert the SpectralShape enumerator to a spectral model object (upcast to the base object). More...

Friends
class	SkyCompRep
	Declare which classes access the private functions which convert enumerators to objects. More...

class	::casac::componentlist

Detailed Description

Enumerators common to the ComponentsModels module.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd
Test programs:: tComponentType

Etymology

This class contains the type definitions in the ComponentModels module

Synopsis

This class does nothing. It is merely a container for the enumerations used by the ComponentModels module. These enumerations define the standard component types. It also contains:

static functions which convert between these enumerators and strings.
static functions which construct the appropriate derived object given an enumerator. Note that these functions are only accessible by the friend classes SkyCompRep and ComponentList and should be considered an implementation detail.

The first element in the enumerator must be represented by zero and every enumerator must contain as the second last and last elements an UNKNOWN_* and NUMBER_* element.

Example

See the documentation for the ComponentModels classes for examples on the use of these enumerator and functions. For example the ComponentShape class.

To Do

Nothing I can think of.

Definition at line 92 of file ComponentType.h.

Member Enumeration Documentation

enum casa::ComponentType::Polarisation

The ways the Flux polarisation can be represented.

Enumerator
STOKES	The four casacore::Stokes parameters, ie I,Q,U,V.
LINEAR	Linear polarisation feeds ie., XX,XY,YX,YY with zero parrallactic angle.
CIRCULAR	Circular polarisation feeds ie., RR, RL, LR, LL.
UNKNOWN_POLARISATION	An unknown Component.
NUMBER_POLARISATIONS	The number of types in this enumerator.

Definition at line 116 of file ComponentType.h.

enum casa::ComponentType::Shape

The shapes of all the components.

Enumerator
POINT	A simple point component.
GAUSSIAN	A elliptical Gaussian component.
DISK	A elliptical disk component.
LDISK	A elliptical disk component with limb-darkening effect.
UNKNOWN_SHAPE	An unknown Component.
NUMBER_SHAPES	The number of types in this enumerator.

Definition at line 101 of file ComponentType.h.

enum casa::ComponentType::SpectralShape

The different functional forms for the spectral variation.

Enumerator
CONSTANT_SPECTRUM	The flux is constant at different frequencies.
SPECTRAL_INDEX	The flux varies as `I = I_0 * (nu / nu_0)^alpha`
TABULAR_SPECTRUM	Tabular values interpolated in between.
UNKNOWN_SPECTRAL_SHAPE	an unknown spectral type
NUMBER_SPECTRAL_SHAPES	The number of spectral types in this enumerator.

Definition at line 129 of file ComponentType.h.

Member Function Documentation

static ComponentShape* casa::ComponentType::construct ( ComponentType::Shape shapeEnum )

staticprivate

Convert the Shape enumerator to a shape object (upcast to the base object).

Returns a null pointer if the object could not be constructed. This will occur is the enumerator is UNKNOWN_SHAPE or NUMBER_SHAPES or there is insufficient memory. The caller of this function is responsible for deleting the pointer.

static SpectralModel* casa::ComponentType::construct ( ComponentType::SpectralShape spectralEnum )

staticprivate

Convert the SpectralShape enumerator to a spectral model object (upcast to the base object).

Returns a null pointer if the object could not be constructed. This will occur is the enumerator is UNKNOWN_SPECTRAL_SHAPE or NUMBER_SPECTRAL_SHAPES or there is insufficient memory. The caller of this function is responsible for deleting the pointer.

static casacore::String casa::ComponentType::name ( ComponentType::Shape shapeEnum )

static

Convert the Shape enumerator to a string.

static casacore::String casa::ComponentType::name ( ComponentType::Polarisation fluxEnum )

static

Convert the Polarisation enumerator to a string.

static casacore::String casa::ComponentType::name ( ComponentType::SpectralShape spectralEnum )

static

Convert the SpectralShape enumerator to a string.

static ComponentType::Polarisation casa::ComponentType::polarisation ( const casacore::String & polarisationName )

static

Convert a given casacore::String to a Polarisation enumerator.

static ComponentType::Shape casa::ComponentType::shape ( const casacore::String & shapeName )

static

Convert a given casacore::String to a Shape enumerator (min match active)

Referenced by casa::PeakIntensityFluxDensityConverter< T >::setShape().

static ComponentType::SpectralShape casa::ComponentType::spectralShape ( const casacore::String & spectralName )

static

Convert a given casacore::String to a SpectralShape enumerator.

Friends And Related Function Documentation

friend class ::casac::componentlist

friend

Definition at line 98 of file ComponentType.h.

friend class SkyCompRep

friend

Declare which classes access the private functions which convert enumerators to objects.

The private construct functions can only be accessed by functions in the friend classes specified below.

Definition at line 97 of file ComponentType.h.

The documentation for this class was generated from the following file:

casa/code/components/ComponentModels/ComponentType.h

Public Types

Static Public Member Functions

Static Private Member Functions

Friends

Detailed Description

Intended use:

Review Status

Etymology

Synopsis

Example

To Do

Member Enumeration Documentation

Member Function Documentation

Friends And Related Function Documentation