casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes
casa::ImagePadder Class Reference

#include <ImagePadder.h>

Inheritance diagram for casa::ImagePadder:
casa::ImageTask

List of all members.

Public Member Functions

 ImagePadder (const ImageInterface< Float > *const image, const Record *const regionRec=0, const String &box="", const String &chanInp="", const String &stokes="", const String &maskInp="", const String &outname="", const Bool overwrite="")
 Top level interface for padding an image in direction space.
 ~ImagePadder ()
 destructor
ImageInterface< Float > * pad (const Bool wantReturn) const
 perform the padding.
void setPaddingPixels (const uInt nPixels, const Double value=0, const Bool good=False)
 set the number of pixels to use for padding and their values and if they should be masked on each edge of the direction plane.
String getClass () const

Protected Member Functions

CasacRegionManager::StokesControl _getStokesControl () const
vector< Coordinate::Type_getNecessaryCoordinates () const
 Represents the minimum set of coordinates necessary for the task to function.

Private Member Functions

 ImagePadder ()
 disallow default constructor

Private Attributes

uInt _nPixels
Double _value
Bool _good

Static Private Attributes

static const String _class

Detailed Description

Definition at line 39 of file ImagePadder.h.


Constructor & Destructor Documentation

casa::ImagePadder::ImagePadder ( const ImageInterface< Float > *const  image,
const Record *const  regionRec = 0,
const String box = "",
const String chanInp = "",
const String stokes = "",
const String maskInp = "",
const String outname = "",
const Bool  overwrite = "" 
)

Top level interface for padding an image in direction space.

Etymology

Collapses image.

Synopsis

High level interface for padding an image.

Example

            ImagePadder padder();
            padder.pad();

destructor

disallow default constructor


Member Function Documentation

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

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

Implements casa::ImageTask.

Definition at line 99 of file ImagePadder.h.

References casa::Coordinate::DIRECTION.

Implements casa::ImageTask.

Definition at line 95 of file ImagePadder.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

String casa::ImagePadder::getClass ( ) const [virtual]

Implements casa::ImageTask.

ImageInterface<Float>* casa::ImagePadder::pad ( const Bool  wantReturn) const

perform the padding.

If wantReturn is True, return a pointer to the padded image. The returned pointer is created via new(); it is the caller's responsibility to delete the returned pointer. If wantReturn is False, a NULL pointer is returned and pointer deletion is performed internally.

void casa::ImagePadder::setPaddingPixels ( const uInt  nPixels,
const Double  value = 0,
const Bool  good = False 
)

set the number of pixels to use for padding and their values and if they should be masked on each edge of the direction plane.

good=True means the padding pixels will not be masked (set to good, mask values = True).


Member Data Documentation

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

Definition at line 109 of file ImagePadder.h.

Definition at line 108 of file ImagePadder.h.

Definition at line 106 of file ImagePadder.h.

Definition at line 107 of file ImagePadder.h.


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