casa::AnnotationBase Class Reference

Base class for annotations. More...

#include <AnnotationBase.h>

Inheritance diagram for casa::AnnotationBase:

Public Types
enum	Type { LINE, VECTOR, TEXT, SYMBOL, RECT_BOX, CENTER_BOX, ROTATED_BOX, POLYGON, POLYLINE, CIRCLE, ANNULUS, ELLIPSE }
enum	Keyword { COORD, RANGE, FRAME, CORR, VELTYPE, RESTFREQ, LINEWIDTH, LINESTYLE, SYMSIZE, SYMTHICK, COLOR, FONT, FONTSIZE, FONTSTYLE, USETEX, LABEL, LABELCOLOR, LABELPOS, LABELOFF, UNKNOWN_KEYWORD, N_KEYS }
enum	LineStyle { SOLID, DASHED, DOT_DASHED, DOTTED }
enum	FontStyle { NORMAL, BOLD, ITALIC, ITALIC_BOLD }
Public Member Functions
virtual	~AnnotationBase ()
Type	getType () const
void	setLabel (const String &label)
String	getLabel () const
void	setColor (const String &color)
	`color` must either be a recognized color name or a valid rgb hex string, else an expection is thrown
void	setColor (const RGB &color)
	color must have three elements all with values between 0 and 255 inclusive or an exception is thrown.
String	getColorString () const
	returns the color name if it is recognized or its rgb hex string
RGB	getColor () const
	get the color associated with this object
void	setLineStyle (const LineStyle lineStyle)
LineStyle	getLineStyle () const
void	setLineWidth (const uInt linewidth)
uInt	getLineWidth () const
void	setSymbolSize (const uInt symbolsize)
uInt	getSymbolSize () const
void	setSymbolThickness (const uInt symbolthickness)
uInt	getSymbolThickness () const
void	setFont (const String &font)
String	getFont () const
void	setFontSize (const uInt fontsize)
uInt	getFontSize () const
void	setFontStyle (const FontStyle &fontstyle)
FontStyle	getFontStyle () const
void	setUseTex (const Bool usetex)
Bool	isUseTex () const
virtual Bool	isRegion () const
	is the object a region?
virtual Bool	isAnnotationOnly () const
	is the object only an annotation? Can only be false if the object is a region
void	setLabelColor (const String &color)
	`color` must either be a recognized color name or a valid rgb hex string, else an expection is thrown
void	setLabelColor (const RGB &color)
	color must have three elements all with values between 0 and 255 inclusive or an exception is thrown.
String	getLabelColorString () const
	returns the color name if it is recognized or its rgb hex string
RGB	getLabelColor () const
	get the color associated with this object's label
String	getLabelPosition () const
	returns one of top, bottom, left, or right.
void	setLabelPosition (const String &position)
	`position` must have a value in top, bottom, left, or right.
void	setLabelOffset (const vector< Int > &offset)
	`offset` must have two elements
vector< Int >	getLabelOffset () const
virtual ostream &	print (ostream &os) const =0
void	setGlobals (const Vector< Keyword > &globalKeys)
	These parameters are included at the global scope.
const CoordinateSystem &	getCsys () const
	get the coordinate system associated with this object.
Direction	getDirections () const
	DEPRECATED Please use getConvertedDirections() the pair elements have longitude as the first member and latitude as the second.
Vector< MFrequency >	getFrequencyLimits () const
	get the frequency limits converted to the spectral frame of the coordinate system of this object.
Vector< Stokes::StokesTypes >	getStokes () const
	Get the stokes for which the selection applies.
virtual Bool	setFrequencyLimits (const Quantity &beginFreq, const Quantity &endFreq, const String &freqRefFrame, const String &dopplerString, const Quantity &restfreq)
	if freqRefFrame=="" -> use the reference frame of the coordinate system if dopplerString=="" -> use the doppler system associated with the coordinate system if restfreq=Quantity(0, "Hz") -> use the rest frequency associated with the coordinate system Tacitly does nothing if the coordinate system has no spectral axis.
const Vector< MDirection > &	getConvertedDirections () const
	same as getDirections, only returns proper MDirections
Static Public Member Functions
static LineStyle	lineStyleFromString (const String &ls)
static Type	typeFromString (const String &type)
	Given a string, return the corresponding annotation type or throw an error if the string does not correspond to an allowed type.
static String	typeToString (const Type type)
static String	keywordToString (const Keyword key)
static String	lineStyleToString (const LineStyle linestyle)
static FontStyle	fontStyleFromString (const String &fs)
static String	fontStyleToString (const FontStyle fs)
static String	colorToString (const RGB &color)
static void	unitInit ()
	set "pix" as valid unit.
static ostream &	print (ostream &os, const map< Keyword, String > &params)
	print a set of keyword value pairs
static ostream &	print (ostream &os, const LineStyle ls)
	print a line style representation
static ostream &	print (ostream &os, const FontStyle fs)
	print a font style representation
static ostream &	print (ostream &os, const Direction d)
static std::list< std::string >	colorChoices ()
	Get a list of the user-friendly color names supported.
Static Public Attributes
static const RGB	BLACK
static const RGB	BLUE
static const RGB	CYAN
static const RGB	GRAY
static const RGB	GREEN
static const RGB	MAGENTA
static const RGB	ORANGE
static const RGB	RED
static const RGB	WHITE
static const RGB	YELLOW
static const String	DEFAULT_LABEL
static const RGB	DEFAULT_COLOR
static const LineStyle	DEFAULT_LINESTYLE
static const uInt	DEFAULT_LINEWIDTH
static const uInt	DEFAULT_SYMBOLSIZE
static const uInt	DEFAULT_SYMBOLTHICKNESS
static const String	DEFAULT_FONT
static const uInt	DEFAULT_FONTSIZE
static const FontStyle	DEFAULT_FONTSTYLE
static const Bool	DEFAULT_USETEX
static const RGB	DEFAULT_LABELCOLOR
static const String	DEFAULT_LABELPOS
static const vector< Int >	DEFAULT_LABELOFF
static const Regex	rgbHexRegex
Protected Member Functions
	AnnotationBase (const Type type, const String &dirRefFrameString, const CoordinateSystem &csys, const Quantity &beginFreq, const Quantity &endFreq, const String &freqRefFrame, const String &dopplerString, const Quantity &restfreq, const Vector< Stokes::StokesTypes > &stokes)
	if `freqRefFrame` or `dopplerString` are empty, the values from the spectral coordinate of csys will be used, if one exists.
	AnnotationBase (const Type type, const CoordinateSystem &csys, const Vector< Stokes::StokesTypes > &stokes)
	use only if the frame of the input directions is the same as the frame of the coordinate system.
AnnotationBase &	operator= (const AnnotationBase &other)
	the implicitly defined copy constructor is fine AnnotationBase(const AnnotationBase& other);
MDirection	_directionFromQuantities (const Quantity &q0, const Quantity &q1)
void	_checkAndConvertDirections (const String &origin, const Direction &dirs)
virtual void	_printPairs (ostream &os) const
const IPosition &	_getDirectionAxes () const
String	_printDirection (const Quantity &longitude, const Quantity &latitude) const
	direction to string, precision of 0.1 mas ra and dec in sexigesimal format, non-equatorial coords in degrees
void	_setParam (const Keyword k, const String &s)
MDirection::Types	_getDirectionRefFrame () const
Static Protected Member Functions
static void	_checkMixed (const String &origin, const Direction &dirs)
static String	_toArcsec (const Quantity &angle)
	convert angle to arcsec, precision 0.1 mas
static String	_toDeg (const Quantity &angle)
	convert angle to degrees, precision 0.1 mas
static String	_printPixel (const Double &d)
	return a string representing a pixel value, precision 1.
Private Member Functions
void	_init ()
void	_initParams ()
void	_testConvertToPixel () const
void	_checkAndConvertFrequencies ()
String	_printFreqRange () const
Static Private Member Functions
static void	_initColors ()
static RGB	_colorStringToRGB (const String &s)
static Bool	_isRGB (const RGB &rgb)
static void	_initTypeMap ()
static String	_printFreq (const Quantity &freq)
Private Attributes
Type	_type
MDirection::Types	_directionRefFrame
CoordinateSystem	_csys
IPosition	_directionAxes
String	_label
String	_font
String	_labelPos
RGB	_color
RGB	_labelColor
FontStyle	_fontstyle
LineStyle	_linestyle
uInt	_fontsize
uInt	_linewidth
uInt	_symbolsize
uInt	_symbolthickness
Bool	_usetex
Vector< MDirection >	_convertedDirections
Vector< MFrequency >	_convertedFreqLimits
Quantity	_beginFreq
Quantity	_endFreq
Quantity	_restFreq
Vector< Stokes::StokesTypes >	_stokes
MFrequency::Types	_freqRefFrame
MDoppler::Types	_dopplerType
map< Keyword, Bool >	_globals
map< Keyword, String >	_params
Bool	_printGlobals
vector< Int >	_labelOff
Static Private Attributes
static Bool	_doneUnitInit
static Bool	_doneColorInit
static map< String, LineStyle >	_lineStyleMap
static map< String, Type >	_typeMap
static map< string, RGB >	_colors
static map< RGB, string >	_rgbNameMap
static std::list< std::string >	_colorNames
static const String	_class

Detailed Description

Base class for annotations.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Synopsis

Base class for annotations

In order to minimize maintainability, many parameters are not set in the constructor but can be set by mutator methods.

Input directions will be converted to the reference frame of the input coordinate system upon construction if necessary.

Definition at line 56 of file AnnotationBase.h.

Member Enumeration Documentation

enum casa::AnnotationBase::FontStyle

Enumerator:

NORMAL
BOLD
ITALIC
ITALIC_BOLD

Definition at line 112 of file AnnotationBase.h.

enum casa::AnnotationBase::Keyword

Enumerator:

COORD
RANGE
FRAME
CORR
VELTYPE
RESTFREQ
LINEWIDTH
LINESTYLE
SYMSIZE
SYMTHICK
COLOR
FONT
FONTSIZE
FONTSTYLE
USETEX
LABEL
LABELCOLOR
LABELPOS
LABELOFF
UNKNOWN_KEYWORD
N_KEYS

Definition at line 81 of file AnnotationBase.h.

enum casa::AnnotationBase::LineStyle

Enumerator:

SOLID
DASHED
DOT_DASHED
DOTTED

Definition at line 105 of file AnnotationBase.h.

enum casa::AnnotationBase::Type

Enumerator:

LINE	annotations only
VECTOR
TEXT
SYMBOL
RECT_BOX	regions
CENTER_BOX
ROTATED_BOX
POLYGON
POLYLINE
CIRCLE
ANNULUS
ELLIPSE

Definition at line 64 of file AnnotationBase.h.

Constructor & Destructor Documentation

virtual casa::AnnotationBase::~AnnotationBase ( ) [virtual]

casa::AnnotationBase::AnnotationBase	(	const Type	type,
		const String &	dirRefFrameString,
		const CoordinateSystem &	csys,
		const Quantity &	beginFreq,
		const Quantity &	endFreq,
		const String &	freqRefFrame,
		const String &	dopplerString,
		const Quantity &	restfreq,
		const Vector< Stokes::StokesTypes > &	stokes
	)			`[protected]`

if freqRefFrame or dopplerString are empty, the values from the spectral coordinate of csys will be used, if one exists.

if restfreq=Quantity(0, "Hz") -> use the rest frequency associated with the coordinate system

casa::AnnotationBase::AnnotationBase	(	const Type	type,
		const CoordinateSystem &	csys,
		const Vector< Stokes::StokesTypes > &	stokes
	)			`[protected]`

use only if the frame of the input directions is the same as the frame of the coordinate system.

All frequencies are used.

Member Function Documentation

void casa::AnnotationBase::_checkAndConvertDirections	(	const String &	origin,
		const Direction &	dirs
	)			`[protected]`

void casa::AnnotationBase::_checkAndConvertFrequencies ( ) [private]

static void casa::AnnotationBase::_checkMixed	(	const String &	origin,
		const Direction &	dirs
	)			`[static, protected]`

static RGB casa::AnnotationBase::_colorStringToRGB ( const String & s ) [static, private]

MDirection casa::AnnotationBase::_directionFromQuantities	(	const Quantity &	q0,
		const Quantity &	q1
	)			`[protected]`

const IPosition& casa::AnnotationBase::_getDirectionAxes ( ) const [inline, protected]

Definition at line 373 of file AnnotationBase.h.

References _directionAxes.

MDirection::Types casa::AnnotationBase::_getDirectionRefFrame ( ) const [inline, protected]

Definition at line 396 of file AnnotationBase.h.

References _directionRefFrame.

void casa::AnnotationBase::_init ( ) [private]

Reimplemented in casa::AnnAnnulus, casa::AnnPolygon, casa::AnnPolyline, and casa::AnnRegion.

static void casa::AnnotationBase::_initColors ( ) [static, private]

void casa::AnnotationBase::_initParams ( ) [private]

static void casa::AnnotationBase::_initTypeMap ( ) [static, private]

static Bool casa::AnnotationBase::_isRGB ( const RGB & rgb ) [static, private]

String casa::AnnotationBase::_printDirection	(	const Quantity &	longitude,
		const Quantity &	latitude
	)			const `[protected]`

direction to string, precision of 0.1 mas ra and dec in sexigesimal format, non-equatorial coords in degrees

static String casa::AnnotationBase::_printFreq ( const Quantity & freq ) [static, private]

String casa::AnnotationBase::_printFreqRange ( ) const [private]

virtual void casa::AnnotationBase::_printPairs ( ostream & os ) const [protected, virtual]

static String casa::AnnotationBase::_printPixel ( const Double & d ) [static, protected]

return a string representing a pixel value, precision 1.

void casa::AnnotationBase::_setParam	(	const Keyword	k,
		const String &	s
	)			`[inline, protected]`

Definition at line 389 of file AnnotationBase.h.

References _params.

void casa::AnnotationBase::_testConvertToPixel ( ) const [private]

static String casa::AnnotationBase::_toArcsec ( const Quantity & angle ) [static, protected]

convert angle to arcsec, precision 0.1 mas

static String casa::AnnotationBase::_toDeg ( const Quantity & angle ) [static, protected]

convert angle to degrees, precision 0.1 mas

static std::list<std::string> casa::AnnotationBase::colorChoices ( ) [static]

Get a list of the user-friendly color names supported.

static String casa::AnnotationBase::colorToString ( const RGB & color ) [static]

static FontStyle casa::AnnotationBase::fontStyleFromString ( const String & fs ) [static]

static String casa::AnnotationBase::fontStyleToString ( const FontStyle fs ) [static]

RGB casa::AnnotationBase::getColor ( ) const

get the color associated with this object

String casa::AnnotationBase::getColorString ( ) const

returns the color name if it is recognized or its rgb hex string

const Vector<MDirection>& casa::AnnotationBase::getConvertedDirections ( ) const [inline]

same as getDirections, only returns proper MDirections

Definition at line 322 of file AnnotationBase.h.

References _convertedDirections.

const CoordinateSystem& casa::AnnotationBase::getCsys ( ) const [inline]

get the coordinate system associated with this object.

This is the same coordinates system used to construct the object.

Definition at line 289 of file AnnotationBase.h.

References _csys.

Direction casa::AnnotationBase::getDirections ( ) const

DEPRECATED Please use getConvertedDirections() the pair elements have longitude as the first member and latitude as the second.

FIXME make this return of vector of MVDirections Returns the same angles as getConvertedDirections()

String casa::AnnotationBase::getFont ( ) const

uInt casa::AnnotationBase::getFontSize ( ) const

FontStyle casa::AnnotationBase::getFontStyle ( ) const

Vector<MFrequency> casa::AnnotationBase::getFrequencyLimits ( ) const

get the frequency limits converted to the spectral frame of the coordinate system of this object.

An empty Vector implies all applicable frequencies have been selected.

String casa::AnnotationBase::getLabel ( ) const

RGB casa::AnnotationBase::getLabelColor ( ) const

get the color associated with this object's label

String casa::AnnotationBase::getLabelColorString ( ) const

returns the color name if it is recognized or its rgb hex string

vector<Int> casa::AnnotationBase::getLabelOffset ( ) const

String casa::AnnotationBase::getLabelPosition ( ) const

returns one of top, bottom, left, or right.

LineStyle casa::AnnotationBase::getLineStyle ( ) const

uInt casa::AnnotationBase::getLineWidth ( ) const

Vector<Stokes::StokesTypes> casa::AnnotationBase::getStokes ( ) const

Get the stokes for which the selection applies.

An empty Vector implies all applicable stokes have been selected.

uInt casa::AnnotationBase::getSymbolSize ( ) const

uInt casa::AnnotationBase::getSymbolThickness ( ) const

Type casa::AnnotationBase::getType ( ) const

virtual Bool casa::AnnotationBase::isAnnotationOnly ( ) const [inline, virtual]

is the object only an annotation? Can only be false if the object is a region

Reimplemented in casa::AnnRegion.

Definition at line 223 of file AnnotationBase.h.

References casacore::True.

virtual Bool casa::AnnotationBase::isRegion ( ) const [virtual]

is the object a region?

Reimplemented in casa::AnnRegion.

Bool casa::AnnotationBase::isUseTex ( ) const

static String casa::AnnotationBase::keywordToString ( const Keyword key ) [static]

static LineStyle casa::AnnotationBase::lineStyleFromString ( const String & ls ) [static]

static String casa::AnnotationBase::lineStyleToString ( const LineStyle linestyle ) [static]

AnnotationBase& casa::AnnotationBase::operator= ( const AnnotationBase & other ) [protected]

the implicitly defined copy constructor is fine AnnotationBase(const AnnotationBase& other);

assignment operator

Reimplemented in casa::AnnAnnulus, casa::AnnCenterBox, casa::AnnCircle, casa::AnnEllipse, casa::AnnLine, casa::AnnPolygon, casa::AnnPolyline, casa::AnnRectBox, casa::AnnRegion, casa::AnnRotBox, casa::AnnSymbol, casa::AnnText, and casa::AnnVector.

static ostream& casa::AnnotationBase::print	(	ostream &	os,
		const Direction	d
	)			`[static]`

static ostream& casa::AnnotationBase::print	(	ostream &	os,
		const FontStyle	fs
	)			`[static]`

print a font style representation

static ostream& casa::AnnotationBase::print	(	ostream &	os,
		const LineStyle	ls
	)			`[static]`

print a line style representation

static ostream& casa::AnnotationBase::print	(	ostream &	os,
		const map< Keyword, String > &	params
	)			`[static]`

print a set of keyword value pairs

virtual ostream& casa::AnnotationBase::print ( ostream & os ) const [pure virtual]

Implemented in casa::AnnAnnulus, casa::AnnCenterBox, casa::AnnCircle, casa::AnnEllipse, casa::AnnLine, casa::AnnPolygon, casa::AnnPolyline, casa::AnnRectBox, casa::AnnRotBox, casa::AnnSymbol, casa::AnnText, and casa::AnnVector.

Referenced by casa::operator<<().

void casa::AnnotationBase::setColor ( const RGB & color )

color must have three elements all with values between 0 and 255 inclusive or an exception is thrown.

void casa::AnnotationBase::setColor ( const String & color )

color must either be a recognized color name or a valid rgb hex string, else an expection is thrown

void casa::AnnotationBase::setFont ( const String & font )

void casa::AnnotationBase::setFontSize ( const uInt fontsize )

void casa::AnnotationBase::setFontStyle ( const FontStyle & fontstyle )

virtual Bool casa::AnnotationBase::setFrequencyLimits	(	const Quantity &	beginFreq,
		const Quantity &	endFreq,
		const String &	freqRefFrame,
		const String &	dopplerString,
		const Quantity &	restfreq
	)			`[virtual]`

if freqRefFrame=="" -> use the reference frame of the coordinate system if dopplerString=="" -> use the doppler system associated with the coordinate system if restfreq=Quantity(0, "Hz") -> use the rest frequency associated with the coordinate system Tacitly does nothing if the coordinate system has no spectral axis.

Returns True if frequencies actually need to be set and were set.

Reimplemented in casa::AnnRegion.

void casa::AnnotationBase::setGlobals ( const Vector< Keyword > & globalKeys )

These parameters are included at the global scope.

Multiple runs on the same object are cumulative; if a key exists in the current settings but not in globalKeys that key will still exist in the globals after setGlobals has run.

void casa::AnnotationBase::setLabel ( const String & label )