casa::ImageMomentsTask< T > Class Template Reference

#include <ImageMomentsTask.h>

Inheritance diagram for casa::ImageMomentsTask< T >:

Public Member Functions
	ImageMomentsTask ()
	Top level interface for creating image moments.
	ImageMomentsTask (const SPCIIT image, const Record *const region, const String &mask, const String &smoothImageName, Bool overwrite)
	overwrite only applies to the smooth image.
	~ImageMomentsTask ()
String	getClass () const
SPIIT	makeMoments () const
	the first requested moments image is returned.
void	setAxis (Int axis)
	set moments axis number
void	setIncludeExcludeRange (const std::vector< T > &range, Bool isInclude)
	set the include or exclude range.
void	setKernels (const std::vector< String > &kernels)
	Set smoothing kernels.
void	setKernelWidths (const vector< Quantity > &kernelWidths)
	set smoothing kernel widths
void	setMethods (const vector< String > &methods)
	set moment methods
void	setMoments (const Vector< Int > &moments)
	set moments to compute
void	setMomentsProgressMonitor (ImageMomentsProgressMonitor *progressMonitor)
void	setMomentImageName (const String &name)
	set the base name for the moment images.
void	setRemoveAxis (Bool remove)
	Should the moment axis be removed.
void	setSmoothAxes (const std::vector< uInt > &axes)
	set smoothing axes
void	setSNR (Double snr)
	set desired signal-to-noise.
void	setStdDev (Double stddev)
	set desired standard deviation.
void	setVelocityType (const String &type)
	set the velocity type.
Protected Member Functions
CasacRegionManager::StokesControl	_getStokesControl () const
std::vector< Coordinate::Type >	_getNecessaryCoordinates () const
	Represents the minimum set of coordinates necessary for the task to function.
Bool	_supportsMultipleBeams () const
	does this task support images with multiple beams? False means it never does.
Bool	_supportsMultipleRegions () const
Private Member Functions
void	_deleteTempImage (const String &tmpImage) const
Private Attributes
Vector< Int >	_moments
Int	_axis
std::vector< String >	_methods
std::vector< String >	_kernels
std::vector< uInt >	_smoothAxes
std::vector< Quantity >	_kernelWidths
std::vector< T >	_range
Bool	_isIncludeRange
Bool	_removeAxis
Double	_snr
Double	_stddev
String	_velocityType
String	_momentName
ImageMomentsProgressMonitor *	_imageMomentsProgressMonitor

Detailed Description

template<class T>
class casa::ImageMomentsTask< T >

Definition at line 12 of file ImageMomentsTask.h.

Constructor & Destructor Documentation

template<class T >

casa::ImageMomentsTask< T >::ImageMomentsTask ( )

Top level interface for creating image moments.

Etymology

Rebins an image to larger pixels.

Synopsis

Top level interface for rebinning images.

template<class T >

casa::ImageMomentsTask< T >::ImageMomentsTask	(	const SPCIIT	image,
		const Record *const	region,
		const String &	mask,
		const String &	smoothImageName,
		Bool	overwrite
	)

overwrite only applies to the smooth image.

The moment images should be removed if they exist.

template<class T >

casa::ImageMomentsTask< T >::~ImageMomentsTask ( ) [inline]

Definition at line 43 of file ImageMomentsTask.h.

Member Function Documentation

template<class T >

void casa::ImageMomentsTask< T >::_deleteTempImage ( const String & tmpImage ) const [private]

template<class T >

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

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

Implements casa::ImageTask< T >.

Definition at line 109 of file ImageMomentsTask.h.

template<class T >

CasacRegionManager::StokesControl casa::ImageMomentsTask< T >::_getStokesControl ( ) const [inline, protected, virtual]

Implements casa::ImageTask< T >.

Definition at line 105 of file ImageMomentsTask.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

template<class T >

Bool casa::ImageMomentsTask< T >::_supportsMultipleBeams ( ) const [inline, protected, virtual]

does this task support images with multiple beams? False means it never does.

True means it does, but not necessarily in all cases (in which case, the derived class is responsible for checking for and throwing exceptions in those cases).

Reimplemented from casa::ImageTask< T >.

Definition at line 113 of file ImageMomentsTask.h.

References casacore::True.

template<class T >

Bool casa::ImageMomentsTask< T >::_supportsMultipleRegions ( ) const [inline, protected, virtual]

Reimplemented from casa::ImageTask< T >.

Definition at line 115 of file ImageMomentsTask.h.

References casacore::True.

template<class T >

String casa::ImageMomentsTask< T >::getClass ( ) const [inline, virtual]

Implements casa::ImageTask< T >.

Definition at line 45 of file ImageMomentsTask.h.

References String.

template<class T >

SPIIT casa::ImageMomentsTask< T >::makeMoments ( ) const

the first requested moments image is returned.

template<class T >

void casa::ImageMomentsTask< T >::setAxis ( Int axis )

set moments axis number

template<class T >

void casa::ImageMomentsTask< T >::setIncludeExcludeRange	(	const std::vector< T > &	range,
		Bool	isInclude
	)

set the include or exclude range.

An empty vector means no range is set, a one element vector means -range[0] to range[0] is set. If the vector contains more than two elements, an exception is thrown. If isInclude is True, then the range is the range to be included, excluded if False.

template<class T >

void casa::ImageMomentsTask< T >::setKernels ( const std::vector< String > & kernels ) [inline]

Set smoothing kernels.

Definition at line 60 of file ImageMomentsTask.h.

References casa::ImageMomentsTask< T >::_kernels.

template<class T >

void casa::ImageMomentsTask< T >::setKernelWidths ( const vector< Quantity > & kernelWidths ) [inline]

set smoothing kernel widths

Definition at line 63 of file ImageMomentsTask.h.

References casa::ImageMomentsTask< T >::_kernelWidths.

template<class T >

void casa::ImageMomentsTask< T >::setMethods ( const vector< String > & methods ) [inline]

set moment methods

Definition at line 68 of file ImageMomentsTask.h.

References casa::ImageMomentsTask< T >::_methods.

template<class T >

void casa::ImageMomentsTask< T >::setMomentImageName ( const String & name ) [inline]

set the base name for the moment images.

Definition at line 78 of file ImageMomentsTask.h.

References casa::ImageMomentsTask< T >::_momentName.

template<class T >

void casa::ImageMomentsTask< T >::setMoments ( const Vector< Int > & moments )

set moments to compute

template<class T >

void casa::ImageMomentsTask< T >::setMomentsProgressMonitor ( ImageMomentsProgressMonitor * progressMonitor ) [inline]

Definition at line 73 of file ImageMomentsTask.h.

References casa::ImageMomentsTask< T >::_imageMomentsProgressMonitor.

template<class T >

void casa::ImageMomentsTask< T >::setRemoveAxis ( Bool remove ) [inline]

Should the moment axis be removed.

These rules will be followed: If the moment axis is associated with a coordinate with one axis only, the axis and its coordinate are physically removed from the output image. Otherwise, if remove=True then the output axis is logically removed from the the output CoordinateSystem. If remove=False then the axis is retained with shape=1 and with its original coordinate information (which is probably meaningless).

Definition at line 87 of file ImageMomentsTask.h.

References casa::ImageMomentsTask< T >::_removeAxis.

template<class T >

void casa::ImageMomentsTask< T >::setSmoothAxes ( const std::vector< uInt > & axes )

set smoothing axes

template<class T >

void casa::ImageMomentsTask< T >::setSNR ( Double snr ) [inline]

set desired signal-to-noise.

Less than or equal to zero means use the default value.

Definition at line 94 of file ImageMomentsTask.h.

References casa::ImageMomentsTask< T >::_snr.

template<class T >