casa::CasaImageBeamSet Class Reference

Represents a set of restoring beams associated with an image. Implements getCommonBeam(). More...

#include <CasaImageBeamSet.h>

Public Member Functions
	CasaImageBeamSet ()
	Construct an empty beam set.
	CasaImageBeamSet (const Matrix< GaussianBeam > &beams)
	Construct a beam set from an 2-D array of beams representing the frequency and stokes axis.
	CasaImageBeamSet (const GaussianBeam &beam)
	construct an CasaImageBeamSet representing a single beam which is valid for all channels and stokes
	CasaImageBeamSet (uInt nchan, uInt nstokes, const GaussianBeam &beam=GaussianBeam::NULL_BEAM)
	Create an CasaImageBeamSet of the specified shape with all GaussianBeams initialized to `beam`.
	CasaImageBeamSet (const CasaImageBeamSet &other)
	The copy constructor (reference semantics).
	CasaImageBeamSet (const ImageBeamSet &other)
	~CasaImageBeamSet ()
CasaImageBeamSet &	operator= (const CasaImageBeamSet &other)
	Assignment can change the shape (copy semantics).
GaussianBeam	getCommonBeam () const
	Get a beam to which all other beams in the set can be convolved.
Static Public Member Functions
static const String &	className ()
Static Private Member Functions
static void	_transformEllipseByScaling (Double &transformedMajor, Double &transformedMinor, Double &transformedPa, Double major, Double minor, Double pa, Double xScaleFactor, Double yScaleFactor)

Detailed Description

Represents a set of restoring beams associated with an image. Implements getCommonBeam().

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Etymology

A Set of Beams associated with an Image.

Synopsis

Example

Motivation

Restoring beams are used many places in image analysis tasks.

Definition at line 64 of file CasaImageBeamSet.h.

Constructor & Destructor Documentation

casa::CasaImageBeamSet::CasaImageBeamSet ( )

Construct an empty beam set.

casa::CasaImageBeamSet::CasaImageBeamSet ( const Matrix< GaussianBeam > & beams )

Construct a beam set from an 2-D array of beams representing the frequency and stokes axis.

Axis length 1 means it is valid for all channels cq. stokes. If the image has 0 spectral channels or stokes, the corresponding length of the axis in the provided matrix should be 1.

casa::CasaImageBeamSet::CasaImageBeamSet ( const GaussianBeam & beam )

construct an CasaImageBeamSet representing a single beam which is valid for all channels and stokes

casa::CasaImageBeamSet::CasaImageBeamSet	(	uInt	nchan,
		uInt	nstokes,
		const GaussianBeam &	beam = `GaussianBeam::NULL_BEAM`
	)

Create an CasaImageBeamSet of the specified shape with all GaussianBeams initialized to beam.

casa::CasaImageBeamSet::CasaImageBeamSet ( const CasaImageBeamSet & other )

The copy constructor (reference semantics).

casa::CasaImageBeamSet::CasaImageBeamSet ( const ImageBeamSet & other )

casa::CasaImageBeamSet::~CasaImageBeamSet ( )

Member Function Documentation

static void casa::CasaImageBeamSet::_transformEllipseByScaling	(	Double &	transformedMajor,
		Double &	transformedMinor,
		Double &	transformedPa,
		Double	major,
		Double	minor,
		Double	pa,
		Double	xScaleFactor,
		Double	yScaleFactor
	)			`[static, private]`

static const String& casa::CasaImageBeamSet::className ( ) [static]

GaussianBeam casa::CasaImageBeamSet::getCommonBeam ( ) const

Get a beam to which all other beams in the set can be convolved.

If all other beams can be convolved to the maximum area beam in the set, that beam will be returned. If not, this is guaranteed to be the minimum area beam to which all beams in the set can be convolved if all but one of the beams in the set can be convolved to the beam in the set with the largest area. Otherwise, the returned beam may or may not be the smallest possible beam to which all the beams in the set can be convolved.

CasaImageBeamSet& casa::CasaImageBeamSet::operator= ( const CasaImageBeamSet & other )

Assignment can change the shape (copy semantics).

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

code/imageanalysis/ImageAnalysis/CasaImageBeamSet.h