casa::TwoPointCorrelator< T > Class Template Reference

#include <TwoPointCorrelator.h>

Inheritance diagram for casa::TwoPointCorrelator< T >:

Public Member Functions
	TwoPointCorrelator ()
	Top level interface for two point correlation of images.
	TwoPointCorrelator (SPCIIT image, const Record *const region, const String &mask, const String &outname, Bool overwrite)
	~TwoPointCorrelator ()
	destructor
SPIIT	correlate ()
String	getClass () const
void	setAxes (const IPosition &axes)
	Set the pixel axes over which to do correlation.
void	setMethod (const String &method)
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.
Private Attributes
IPosition	_axes
LatticeTwoPtCorr< T >::Method	_method

Detailed Description

template<class T>
class casa::TwoPointCorrelator< T >

Definition at line 12 of file TwoPointCorrelator.h.

Constructor & Destructor Documentation

template<class T >

casa::TwoPointCorrelator< T >::TwoPointCorrelator ( )

Top level interface for two point correlation of images.

Etymology

Smooths an image in one dimension.

Synopsis

template<class T >

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

template<class T >

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

destructor

Definition at line 40 of file TwoPointCorrelator.h.

Member Function Documentation

template<class T >

std::vector<Coordinate::Type> casa::TwoPointCorrelator< 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 59 of file TwoPointCorrelator.h.

template<class T >

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

Implements casa::ImageTask< T >.

Definition at line 55 of file TwoPointCorrelator.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

template<class T >

Bool casa::TwoPointCorrelator< 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 63 of file TwoPointCorrelator.h.

References casacore::True.

template<class T >

SPIIT casa::TwoPointCorrelator< T >::correlate ( )

template<class T >

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

Implements casa::ImageTask< T >.

Definition at line 44 of file TwoPointCorrelator.h.

References String.

template<class T >

void casa::TwoPointCorrelator< T >::setAxes ( const IPosition & axes )