casa::Image1DSmoother< T > Class Template Reference

#include <Image1DSmoother.h>

Inheritance diagram for casa::Image1DSmoother< T >:
casa::ImageTask< T > casa::ImageBoxcarSmoother< T > casa::ImageHanningSmoother< T >

List of all members.

Public Member Functions

virtual ~Image1DSmoother ()
 Top level interface for 1-D smoothing of images.
SPIIT smooth () const
virtual String getClass () const
void setDecimate (Bool b)
 Keep only every nth plane.
void setAxis (uInt n)
 Set the pixel axis number along which the smoothing will occur.
void setDecimationFunction (ImageDecimatorData::Function f)
 Set the decimation function.

Protected Member Functions

 Image1DSmoother (const SPCIIT image, const Record *const region, const String &maskInp, const String &outname, Bool overwrite)
virtual SPIIT _smooth (const ImageInterface< T > &image) const =0
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 _getDecimate () const
ImageDecimatorData::Function _getDecimationFunction () const
uInt _getAxis () const
void _setNMinPixels (uInt n)

Private Member Functions

 Image1DSmoother ()
 disallow default constructor

Private Attributes

uInt _axis
uInt _nMinPixels
Bool _decimate
ImageDecimatorData::Function _decimationFunction

Detailed Description

template<class T>
class casa::Image1DSmoother< T >

Definition at line 12 of file Image1DSmoother.h.


Constructor & Destructor Documentation

template<class T >
virtual casa::Image1DSmoother< T >::~Image1DSmoother (  )  [inline, virtual]

Top level interface for 1-D smoothing of images.

Etymology

Smooths an image in one dimension.

Synopsis

Top level interface for removing image planes. destructor

Definition at line 34 of file Image1DSmoother.h.

template<class T >
casa::Image1DSmoother< T >::Image1DSmoother ( const SPCIIT  image,
const Record *const   region,
const String &  maskInp,
const String &  outname,
Bool  overwrite 
) [protected]
template<class T >
casa::Image1DSmoother< T >::Image1DSmoother (  )  [private]

disallow default constructor


Member Function Documentation

template<class T >
uInt casa::Image1DSmoother< T >::_getAxis (  )  const [inline, protected]

Definition at line 78 of file Image1DSmoother.h.

References casa::Image1DSmoother< T >::_axis.

template<class T >
Bool casa::Image1DSmoother< T >::_getDecimate (  )  const [inline, protected]

Definition at line 72 of file Image1DSmoother.h.

References casa::Image1DSmoother< T >::_decimate.

template<class T >
ImageDecimatorData::Function casa::Image1DSmoother< T >::_getDecimationFunction (  )  const [inline, protected]

Definition at line 74 of file Image1DSmoother.h.

References casa::Image1DSmoother< T >::_decimationFunction.

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

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

Implements casa::ImageTask< T >.

Definition at line 62 of file Image1DSmoother.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

template<class T >
void casa::Image1DSmoother< T >::_setNMinPixels ( uInt  n  )  [inline, protected]

Definition at line 80 of file Image1DSmoother.h.

References casa::Image1DSmoother< T >::_nMinPixels.

template<class T >
virtual SPIIT casa::Image1DSmoother< T >::_smooth ( const ImageInterface< T > &  image  )  const [protected, pure virtual]
template<class T >
Bool casa::Image1DSmoother< 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 70 of file Image1DSmoother.h.

References casacore::False.

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

Implements casa::ImageTask< T >.

Reimplemented in casa::ImageBoxcarSmoother< T >, and casa::ImageHanningSmoother< T >.

Definition at line 38 of file Image1DSmoother.h.

References String.

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

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

template<class T >
void casa::Image1DSmoother< T >::setDecimate ( Bool  b  )  [inline]

Keep only every nth plane.

Definition at line 41 of file Image1DSmoother.h.

References casa::Image1DSmoother< T >::_decimate.

template<class T >
void casa::Image1DSmoother< T >::setDecimationFunction ( ImageDecimatorData::Function  f  )  [inline]

Set the decimation function.

Definition at line 47 of file Image1DSmoother.h.

References casa::Image1DSmoother< T >::_decimationFunction.

template<class T >
SPIIT casa::Image1DSmoother< T >::smooth (  )  const

Member Data Documentation

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

Definition at line 82 of file Image1DSmoother.h.

Referenced by casa::Image1DSmoother< T >::_getAxis().

template<class T >
Bool casa::Image1DSmoother< T >::_decimate [private]
template<class T >
uInt casa::Image1DSmoother< T >::_nMinPixels [private]

Definition at line 82 of file Image1DSmoother.h.

Referenced by casa::Image1DSmoother< T >::_setNMinPixels().


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