casa::PVGenerator Class Reference

#include <PVGenerator.h>

Inheritance diagram for casa::PVGenerator:

List of all members.

Public Member Functions
	PVGenerator (const SPCIIF 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
SPIIF	generate () const
	perform the collapse.
void	setEndpoints (const std::pair< Double, Double > &start, const std::pair< Double, Double > &end)
	set the end points of the slice in direction space.
void	setEndpoints (const std::pair< Double, Double > &center, Double length, const Quantity &pa)
	set end points given center in pixels, length of segment in pixels, and position angle taken in the normal astronomical sense, measured from north through east.
void	setEndpoints (const std::pair< Double, Double > &center, const Quantity &length, const Quantity &pa)
void	setEndpoints (const MDirection &center, const Quantity &length, const Quantity &pa)
void	setEndpoints (const MDirection &center, Double length, const Quantity &pa)
	length in pixels
void	setEndpoints (const MDirection &start, const MDirection &end)
void	setWidth (uInt width)
	Set the number of pixels perpendicular to the slice for which averaging should occur.
void	setWidth (const Quantity &q)
	This will set the width by rounding q up so that the width is an odd number of pixels.
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.
virtual Bool	_mustHaveSquareDirectionPixels () const
Private Member Functions
	PVGenerator ()
	disallow default constructor
void	_checkWidth (const Int64 xShape, const Int64 yShape) const
Quantity	_increment () const
Static Private Member Functions
static String	_pairToString (const std::pair< Double, Double > &p)
Private Attributes
std::unique_ptr< vector< Double > >	_start
std::unique_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 SPCIIF	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< Float >.

Definition at line 146 of file PVGenerator.h.

CasacRegionManager::StokesControl casa::PVGenerator::_getStokesControl

(

)

const [inline, protected, virtual]

Implements casa::ImageTask< Float >.

Definition at line 142 of file PVGenerator.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

Quantity casa::PVGenerator::_increment

(

)

const [private]

virtual Bool casa::PVGenerator::_mustHaveSquareDirectionPixels

(

)

const [inline, protected, virtual]

Reimplemented from casa::ImageTask< Float >.

Definition at line 153 of file PVGenerator.h.

References casacore::True.

static String casa::PVGenerator::_pairToString

(

const std::pair< Double, Double > &

p

)

[static, private]

SPIIF casa::PVGenerator::generate

(

)

const

perform the collapse.

Returns a pointer to the collapsed image.

String casa::PVGenerator::getClass

(

)

const [virtual]

Implements casa::ImageTask< Float >.

void casa::PVGenerator::setEndpoints	(	const MDirection &	start,
		const MDirection &	end
	)

void casa::PVGenerator::setEndpoints	(	const MDirection &	center,
		Double	length,
		const Quantity &	pa
	)

length in pixels

void casa::PVGenerator::setEndpoints	(	const MDirection &	center,
		const Quantity &	length,
		const Quantity &	pa
	)

void casa::PVGenerator::setEndpoints	(	const std::pair< Double, Double > &	center,
		const Quantity &	length,
		const Quantity &	pa
	)

void casa::PVGenerator::setEndpoints	(	const std::pair< Double, Double > &	center,
		Double	length,
		const Quantity &	pa
	)

set end points given center in pixels, length of segment in pixels, and position angle taken in the normal astronomical sense, measured from north through east.

void casa::PVGenerator::setEndpoints	(	const std::pair< Double, Double > &	start,
		const std::pair< Double, Double > &	end
	)

set the end points of the slice in direction space.

Input values represent pixel coordinates in the input image.

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

(

const Quantity &

q

)

This will set the width by rounding q up so that the width is an odd number of pixels.

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.

---

Member Data Documentation

const String casa::PVGenerator::_class [static, private]

Definition at line 160 of file PVGenerator.h.

std::unique_ptr<vector<Double> > casa::PVGenerator::_end [private]

Definition at line 157 of file PVGenerator.h.

std::unique_ptr<vector<Double> > casa::PVGenerator::_start [private]

Definition at line 157 of file PVGenerator.h.

String casa::PVGenerator::_unit [private]

Definition at line 159 of file PVGenerator.h.

uInt casa::PVGenerator::_width [private]

Definition at line 158 of file PVGenerator.h.

---

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

• code/imageanalysis/ImageAnalysis/PVGenerator.h