#include <PVGenerator.h>

Inheritance diagram for casa::PVGenerator:

Public Member Functions
	PVGenerator (const ImageInterface< Float > const &image, const Record const &regionRec, const String &chanInp, const String &stokes, const String &maskInp, const String &outname, const Bool overwrite)
	Top level interface for generating position-velocity images.
	~PVGenerator ()
	destructor
ImageInterface< Float > *	generate (const Bool wantReturn) const
	perform the collapse.
void	setEndpoints (const Double startx, const Double starty, const Double endx, const Double endy)
	set the endpoints of the slice in direction space.
void	setWidth (uInt width)
	Set the number of pixels perpendicular to the slice for which averaging should occur.
String	getClass () const
void	setOffsetUnit (const String &s)
	set the unit to be used for the offset axis in the resulting image (from calling generate()).
Protected Member Functions
CasacRegionManager::StokesControl	_getStokesControl () const
vector< Coordinate::Type >	_getNecessaryCoordinates () const
	Represents the minimum set of coordinates necessary for the task to function.
Private Member Functions
	PVGenerator ()
	disallow default constructor
void	_checkWidth (const Int64 xShape, const Int64 yShape) const
Private Attributes
std::auto_ptr< vector< Double > >	_start
std::auto_ptr< vector< Double > >	_end
uInt	_width
String	_unit
Static Private Attributes
static const String	_class

Detailed Description

Definition at line 38 of file PVGenerator.h.

Constructor & Destructor Documentation

casa::PVGenerator::PVGenerator	(	const ImageInterface< Float > *const &	image,
		const Record *const &	regionRec,
		const String &	chanInp,
		const String &	stokes,
		const String &	maskInp,
		const String &	outname,
		const Bool	overwrite
	)

Top level interface for generating position-velocity images.

Etymology

Collapses image.

Synopsis

High level interface for generating position-velocity images.

Example

            ImageCollapser collapser();
            collapser.collapse();

The region selection in the constructor only applies to the non-direction coordinates. The direction coordinate limits are effectively set by calling setEndPoints() after construction. The region selection in the constructor is only for things like spectral selection and polarization selection. In addition at most one of regionRec and chanInp/stokes should be supplied. If specifying regionRec that should be a non-null pointer and chanInp and stokes should both be empty strings. If specifying either or both of chanInp and/or stokes, the one(s) being specified should be non-empty strings corresponding to correct syntax for that particular parameter, and regionRec should be null. If you specify regionRec=0 and stokes="", and chanInp="", that implies you want to use all spectral channels and all polarization planes in the input image.

casa::PVGenerator::~PVGenerator ( )

destructor

casa::PVGenerator::PVGenerator ( ) [private]

disallow default constructor

Member Function Documentation

void casa::PVGenerator::_checkWidth	(	const Int64	xShape,
		const Int64	yShape
	)		const `[private]`

vector<Coordinate::Type> casa::PVGenerator::_getNecessaryCoordinates ( ) const [inline, protected, virtual]

Represents the minimum set of coordinates necessary for the task to function.

Implements casa::ImageTask.

Definition at line 118 of file PVGenerator.h.

References casa::Coordinate::DIRECTION, and casa::Coordinate::SPECTRAL.

CasacRegionManager::StokesControl casa::PVGenerator::_getStokesControl ( ) const [inline, protected, virtual]

Implements casa::ImageTask.

Definition at line 114 of file PVGenerator.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

ImageInterface<Float>* casa::PVGenerator::generate ( const Bool wantReturn ) const

perform the collapse.

If wantReturn is True, return a pointer to the collapsed image. The returned pointer is created via new(); it is the caller's responsibility to delete the returned pointer. If wantReturn is False, a NULL pointer is returned and pointer deletion is performed internally.

String casa::PVGenerator::getClass ( ) const [virtual]

Implements casa::ImageTask.

void casa::PVGenerator::setEndpoints	(	const Double	startx,
		const Double	starty,
		const Double	endx,
		const Double	endy
	)

set the endpoints of the slice in direction space.

Input values represent pixel locations.

void casa::PVGenerator::setOffsetUnit ( const String & s )

set the unit to be used for the offset axis in the resulting image (from calling generate()).

Must conform to angular units

void casa::PVGenerator::setWidth ( uInt width )

Set the number of pixels perpendicular to the slice for which averaging should occur.

Must be odd and >= 1. 1 => just use the pixels coincident with the slice (no averaging). 3 => Average three pixels, one pixel on either side of the slice and the pixel lying on the slice. Note this average is done after the image has been rotated.