casa::ImageDecimator< T > Class Template Reference

#include <ImageDecimator.h>

Inheritance diagram for casa::ImageDecimator< T >:
casa::ImageTask< T >

List of all members.

Public Member Functions

 ImageDecimator (const SPCIIT image, const Record *const region, const String &maskInp, const String &outname, Bool overwrite)
 Top level interface for removing image planes.
 ~ImageDecimator ()
 destructor
SPIIT decimate () const
String getClass () const
void setFactor (uInt n)
 every nth plane will be kept
void setAxis (uInt n)
 Set the pixel axis number along which the decimation will occur.
void setFunction (ImageDecimatorData::Function f)
 set the decimation function

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

 ImageDecimator ()
 disallow default constructor

Private Attributes

uInt _axis
uInt _factor
ImageDecimatorData::Function _function

Detailed Description

template<class T>
class casa::ImageDecimator< T >

Definition at line 12 of file ImageDecimator.h.


Constructor & Destructor Documentation

template<class T >
casa::ImageDecimator< T >::ImageDecimator ( const SPCIIT  image,
const Record *const   region,
const String &  maskInp,
const String &  outname,
Bool  overwrite 
)

Top level interface for removing image planes.

Etymology

Decimates planes of image

Synopsis

Top level interface for removing image planes.

template<class T >
casa::ImageDecimator< T >::~ImageDecimator (  )  [inline]

destructor

Definition at line 41 of file ImageDecimator.h.

template<class T >
casa::ImageDecimator< T >::ImageDecimator (  )  [private]

disallow default constructor


Member Function Documentation

template<class T >
std::vector<Coordinate::Type> casa::ImageDecimator< 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 61 of file ImageDecimator.h.

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

Implements casa::ImageTask< T >.

Definition at line 57 of file ImageDecimator.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

template<class T >
Bool casa::ImageDecimator< 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 65 of file ImageDecimator.h.

References casacore::False.

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

Reimplemented from casa::ImageTask< T >.

Definition at line 67 of file ImageDecimator.h.

References casacore::True.

template<class T >
SPIIT casa::ImageDecimator< T >::decimate (  )  const
template<class T >
String casa::ImageDecimator< T >::getClass (  )  const [inline, virtual]

Implements casa::ImageTask< T >.

Definition at line 45 of file ImageDecimator.h.

References String.

template<class T >
void casa::ImageDecimator< T >::setAxis ( uInt  n  ) 

Set the pixel axis number along which the decimation will occur.

template<class T >
void casa::ImageDecimator< T >::setFactor ( uInt  n  ) 

every nth plane will be kept

template<class T >
void casa::ImageDecimator< T >::setFunction ( ImageDecimatorData::Function  f  ) 

set the decimation function


Member Data Documentation

template<class T >
uInt casa::ImageDecimator< T >::_axis [private]

Definition at line 70 of file ImageDecimator.h.

template<class T >
uInt casa::ImageDecimator< T >::_factor [private]

Definition at line 70 of file ImageDecimator.h.

template<class T >
ImageDecimatorData::Function casa::ImageDecimator< T >::_function [private]

Definition at line 71 of file ImageDecimator.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1