casacore::GaussianBeam Class Reference

More...

#include <GaussianBeam.h>

Public Member Functions
	GaussianBeam ()
	create a beam with all quantities zero (a null beam).
	GaussianBeam (const Quantity &major, const Quantity &minor, const Quantity &pa)
	Construct a beam from a set of Quantities.
	GaussianBeam (const Vector< Quantity > &parms)
	Construct a beam from a 3-Vector of Quantities representing the major axis, the minor axis and the position angle (in that order).
	GaussianBeam (const GaussianBeam &other)
	~GaussianBeam ()
GaussianBeam &	operator= (const GaussianBeam &other)
Bool	operator== (const GaussianBeam &other) const
Bool	operator!= (const GaussianBeam &other) const
const Quantity &	getMajor () const
	returns the major axis in the same units as it had at construction
Double	getMajor (const Unit &u) const
	returns the value portion of the major axis in the specified units
const Quantity &	getMinor () const
	returns the minor axis in the same units as it had at construction
Double	getMinor (const Unit &u) const
	returns the value portion of the minor axis in the specified units
Quantity	getPA (const Bool unwrap=True) const
	returns the position angle's value as it was at construction, unless unwrap is True, in which case the value of the angle returned will be between -90 and 90 degrees (but with unit the same as it had when this object was constructed).
Double	getPA (const Unit &u, const Bool unwrap=True) const
	returns the value portion of the position angle in the specified units
Double	getArea (const Unit &unit) const
	returns the beam area in the specified unit, which much conform to solid angle units.
Bool	isNull () const
	is this object a null beam (ie is either its major and/or minor axis zero)?
Record	toRecord () const
void	setMajorMinor (const Quantity &majAx, const Quantity &minAx)
void	setPA (const Quantity &pa, Bool unwrap=False)
	if unwrap=True, unwrap pa so its value lies in the range -90 to 90 degrees before setting it.
Vector< Quantity >	toVector (const Bool unwrap=True) const
	convert this object to a three-Vector of (major FWHM, minor FWHM, and pa).
void	convert (const String &majUnit, const String &minUnit, const String &paUnit)
	convert stored Quantities to the specified units

Static Public Member Functions
static const String &	className ()
	returns GassianBeam.
static GaussianBeam	fromRecord (const Record &rec)

Static Public Attributes
static const GaussianBeam	NULL_BEAM

Protected Attributes
Quantity	_major
Quantity	_minor
Quantity	_pa

Static Private Member Functions
static Quantity	_unwrap (const Quantity &pa)

Detailed Description

Represents a Gaussian restoring beam associated with an image.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Etymology

A Gaussian Beam.

Synopsis

This class represents a Gaussian restoring beam associated with a deconvolved image.

Example

Motivation

Restoring beams are used many places in image analysis tasks.

Definition at line 66 of file GaussianBeam.h.

Constructor & Destructor Documentation

GaussianBeam() [1/4]

casacore::GaussianBeam::GaussianBeam

(

)

create a beam with all quantities zero (a null beam).

Referenced by fromRecord(), GaussianBeam(), operator!=(), operator=(), and operator==().

GaussianBeam() [2/4]

casacore::GaussianBeam::GaussianBeam	(	const Quantity &	major,
		const Quantity &	minor,
		const Quantity &	pa )

Construct a beam from a set of Quantities.

If minor > major an exception is thrown. If any units are not angular, an exception is thrown

References casacore::pa().

GaussianBeam() [3/4]

casacore::GaussianBeam::GaussianBeam

(

const Vector< Quantity > &

parms

)

Construct a beam from a 3-Vector of Quantities representing the major axis, the minor axis and the position angle (in that order).

If parms[1] > parms[0] (minor axis > major axis), an exception is thrown. If any units are not angular, an exception is thrown

GaussianBeam() [4/4]

casacore::GaussianBeam::GaussianBeam

(

const GaussianBeam &

other

)

References GaussianBeam().

~GaussianBeam()

casacore::GaussianBeam::~GaussianBeam

(

)

Member Function Documentation

_unwrap()

Quantity casacore::GaussianBeam::_unwrap ( const Quantity & pa )

staticprivate

References casacore::pa().

className()

const String & casacore::GaussianBeam::className ( )

static

returns GassianBeam.

convert()

void casacore::GaussianBeam::convert	(	const String &	majUnit,
		const String &	minUnit,
		const String &	paUnit )

convert stored Quantities to the specified units

fromRecord()

GaussianBeam casacore::GaussianBeam::fromRecord ( const Record & rec )

static

References GaussianBeam(), and casacore::Record().

getArea()

Double casacore::GaussianBeam::getArea

(

const Unit &

unit

)

const

returns the beam area in the specified unit, which much conform to solid angle units.

getMajor() [1/2]

const Quantity & casacore::GaussianBeam::getMajor

(

)

const

returns the major axis in the same units as it had at construction

getMajor() [2/2]

Double casacore::GaussianBeam::getMajor

(

const Unit &

u

)

const

returns the value portion of the major axis in the specified units

getMinor() [1/2]

const Quantity & casacore::GaussianBeam::getMinor

(

)

const

returns the minor axis in the same units as it had at construction

getMinor() [2/2]

Double casacore::GaussianBeam::getMinor

(

const Unit &

u

)

const

returns the value portion of the minor axis in the specified units

getPA() [1/2]

Quantity casacore::GaussianBeam::getPA

(

const Bool

unwrap = True

)

const

returns the position angle's value as it was at construction, unless unwrap is True, in which case the value of the angle returned will be between -90 and 90 degrees (but with unit the same as it had when this object was constructed).

References casacore::True.

getPA() [2/2]

Double casacore::GaussianBeam::getPA	(	const Unit &	u,
		const Bool	unwrap = True ) const

returns the value portion of the position angle in the specified units

References casacore::True.

isNull()

Bool casacore::GaussianBeam::isNull

(

)

const

is this object a null beam (ie is either its major and/or minor axis zero)?

operator!=()

Bool casacore::GaussianBeam::operator!=

(

const GaussianBeam &

other

)

const

References GaussianBeam().

operator=()

GaussianBeam & casacore::GaussianBeam::operator=

(

const GaussianBeam &

other

)

References GaussianBeam().

operator==()

Bool casacore::GaussianBeam::operator==

(

const GaussianBeam &

other

)

const

References GaussianBeam().

setMajorMinor()

void casacore::GaussianBeam::setMajorMinor	(	const Quantity &	majAx,
		const Quantity &	minAx )

setPA()

void casacore::GaussianBeam::setPA	(	const Quantity &	pa,
		Bool	unwrap = False )

if unwrap=True, unwrap pa so its value lies in the range -90 to 90 degrees before setting it.

References casacore::False, and casacore::pa().

toRecord()

Record casacore::GaussianBeam::toRecord

(

)

const

References casacore::Record().

toVector()

Vector< Quantity > casacore::GaussianBeam::toVector

(

const Bool

unwrap = True

)

const

convert this object to a three-Vector of (major FWHM, minor FWHM, and pa).

If unwrap is True, the returned pa will fall between -90 and +90 degrees.

References casacore::True.

Member Data Documentation

_major

Quantity casacore::GaussianBeam::_major

protected

Definition at line 153 of file GaussianBeam.h.

_minor

Quantity casacore::GaussianBeam::_minor

protected

Definition at line 153 of file GaussianBeam.h.

_pa

Quantity casacore::GaussianBeam::_pa

protected

Definition at line 153 of file GaussianBeam.h.

NULL_BEAM

const GaussianBeam casacore::GaussianBeam::NULL_BEAM

static

Definition at line 69 of file GaussianBeam.h.

Referenced by casacore::ImageBeamSet::ImageBeamSet().

---

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

• scimath/Mathematics/GaussianBeam.h