dp3::parmdb::SourceInfo Class Reference

Info about a source. More...

#include <SourceInfo.h>

Public Types
enum	Type { POINT = 0 , GAUSSIAN = 1 , DISK = 2 , SHAPELET = 3 }

Public Member Functions
	SourceInfo (const SourceInfo &)
	Copy constructor. More...
	SourceInfo (const std::string &name, Type type, const std::string &refType="J2000", bool useLogarithmicSI=true, unsigned int spectralIndexNTerms=0, double spectralIndexRefFreqHz=0., bool useRotationMeasure=false, bool positionAngleIsAbsolute=false)
bool	getHasLogarithmicSI () const
const std::string &	getName () const
	Get the source name. More...
unsigned int	getNSpectralTerms () const
bool	getPositionAngleIsAbsolute () const
const std::string &	getRefType () const
	Get the reference type. More...
double	getSpectralTermsRefFreq () const
	Get the reference frequency (in Hz) for the spectral index. More...
Type	getType () const
	Get the source type. More...
bool	getUseRotationMeasure () const
SourceInfo &	operator= (const SourceInfo &)
	Assignment. More...
void	read (dp3::blob::BlobIStream &)
	Read from a blob. More...
void	write (dp3::blob::BlobOStream &) const
	Write into a blob. More...
const casacore::Array< double > &	getShapeletCoeffI () const
const casacore::Array< double > &	getShapeletCoeffQ () const
const casacore::Array< double > &	getShapeletCoeffU () const
const casacore::Array< double > &	getShapeletCoeffV () const
double	getShapeletScaleI () const
double	getShapeletScaleQ () const
double	getShapeletScaleU () const
double	getShapeletScaleV () const
void	setShapeletCoeff (const casacore::Array< double > &I, const casacore::Array< double > &Q, const casacore::Array< double > &U, const casacore::Array< double > &V)
void	setShapeletScale (double scaleI, double scaleQ, double scaleU, double scaleV)

Detailed Description

Info about a source.

Member Enumeration Documentation

Type

enum dp3::parmdb::SourceInfo::Type

Define the source types. The values should never be changed.

Enumerator
POINT
GAUSSIAN
DISK
SHAPELET

Constructor & Destructor Documentation

SourceInfo() [1/2]

dp3::parmdb::SourceInfo::SourceInfo	(	const std::string &	name,
		Type	type,
		const std::string &	refType = "J2000",
		bool	useLogarithmicSI = true,
		unsigned int	spectralIndexNTerms = 0,
		double	spectralIndexRefFreqHz = 0.,
		bool	useRotationMeasure = false,
		bool	positionAngleIsAbsolute = false
	)

Create from source name, type, reference type and other info.
The 'type' argument tells the source type (point, gaussian, etc.).
The 'refType' argument tells the MDirection reference frame (J2000, SUN, etc.).
A positive spectralIndexSize means that BBS will take a spectral index with size terms into account when calculating the flux. The values of the terms are in the associated ParmDB. It uses the given reference frequency (in Hz).
useRotationMeasure indicates that Q and U have to be calculated using a rotation measure, polarization angle, and polarized fraction.

SourceInfo() [2/2]

dp3::parmdb::SourceInfo::SourceInfo

(

const SourceInfo &

)

Copy constructor.

Member Function Documentation

getHasLogarithmicSI()

bool dp3::parmdb::SourceInfo::getHasLogarithmicSI ( ) const

inline

Whether the standard logarithmic spectral function is used (where the first terms is thus the SI) or a polynomial spectral function (as used in e.g. cleaning).

getName()

const std::string& dp3::parmdb::SourceInfo::getName ( ) const

inline

Get the source name.

getNSpectralTerms()

unsigned int dp3::parmdb::SourceInfo::getNSpectralTerms ( ) const

inline

Get the number of terms in the spectral index function. A value 0 means that the spectral index is not used.

getPositionAngleIsAbsolute()

bool dp3::parmdb::SourceInfo::getPositionAngleIsAbsolute ( ) const

inline

Whether the position angle (rotation) is absolute, i.e. with respect to the North Celestial pole. False means that it is given with respect to North at the phase center, the default until 2022.

getRefType()

const std::string& dp3::parmdb::SourceInfo::getRefType ( ) const

inline

Get the reference type.

getShapeletCoeffI()

const casacore::Array<double>& dp3::parmdb::SourceInfo::getShapeletCoeffI ( ) const

inline

Set or get the shapelet info.

getShapeletCoeffQ()

const casacore::Array<double>& dp3::parmdb::SourceInfo::getShapeletCoeffQ ( ) const

inline

getShapeletCoeffU()

const casacore::Array<double>& dp3::parmdb::SourceInfo::getShapeletCoeffU ( ) const

inline

getShapeletCoeffV()

const casacore::Array<double>& dp3::parmdb::SourceInfo::getShapeletCoeffV ( ) const

inline

getShapeletScaleI()

double dp3::parmdb::SourceInfo::getShapeletScaleI ( ) const

inline

getShapeletScaleQ()

double dp3::parmdb::SourceInfo::getShapeletScaleQ ( ) const

inline

getShapeletScaleU()

double dp3::parmdb::SourceInfo::getShapeletScaleU ( ) const

inline

getShapeletScaleV()

double dp3::parmdb::SourceInfo::getShapeletScaleV ( ) const

inline

getSpectralTermsRefFreq()

double dp3::parmdb::SourceInfo::getSpectralTermsRefFreq ( ) const

inline

Get the reference frequency (in Hz) for the spectral index.

getType()

Type dp3::parmdb::SourceInfo::getType ( ) const

inline

Get the source type.

getUseRotationMeasure()

bool dp3::parmdb::SourceInfo::getUseRotationMeasure ( ) const

inline

Tell if Q,U are directly given or have to be calculated from rotation measure, polarisation fraction and angle.

operator=()

SourceInfo& dp3::parmdb::SourceInfo::operator=

(

const SourceInfo &

)

Assignment.

read()

void dp3::parmdb::SourceInfo::read

(

dp3::blob::BlobIStream &

)

Read from a blob.

setShapeletCoeff()

void dp3::parmdb::SourceInfo::setShapeletCoeff	(	const casacore::Array< double > &	I,
		const casacore::Array< double > &	Q,
		const casacore::Array< double > &	U,
		const casacore::Array< double > &	V
	)

setShapeletScale()

void dp3::parmdb::SourceInfo::setShapeletScale	(	double	scaleI,
		double	scaleQ,
		double	scaleU,
		double	scaleV
	)

write()

void dp3::parmdb::SourceInfo::write

(

dp3::blob::BlobOStream &

)

const

Write into a blob.

---

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

• SourceInfo.h