casa::ImageCropper< T > Class Template Reference

#include <ImageCropper.h>

Inheritance diagram for casa::ImageCropper< T >:

List of all members.

Public Member Functions
	ImageCropper (const SHARED_PTR< const ImageInterface< T > > image, const Record *const &regionRec, const String &box, const String &chanInp, const String &stokes, const String &maskInp, const String &outname, const Bool overwrite)
	Top level interface for cropping masked edges of an image.
	~ImageCropper ()
	destructor
SHARED_PTR< ImageInterface< T > >	crop (const Bool wantReturn) const
	Perform the cropping.
void	setAxes (const std::set< uInt > &axes)
	Set the axes along which to do the cropping.
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
	ImageCropper ()
	disallow default constructor
Private Attributes
std::set< uInt >	_axes
Static Private Attributes
static const String	_class

---

Detailed Description

template<class T>
class casa::ImageCropper< T >

Definition at line 36 of file ImageCropper.h.

---

Constructor & Destructor Documentation

template<class T >

casa::ImageCropper< T >::ImageCropper	(	const SHARED_PTR< const ImageInterface< T > >	image,
		const Record *const &	regionRec,
		const String &	box,
		const String &	chanInp,
		const String &	stokes,
		const String &	maskInp,
		const String &	outname,
		const Bool	overwrite
	)

Top level interface for cropping masked edges of an image.

Etymology

Crop an image

Synopsis

High level interface for cropping images.

Example

 ImageCropper cropper();
 cropper.crop();

At most one of regionRec or box/chanInp/stokes should be supplied. If specifying regionRec that should be a non-null pointer and box, chanInp and stokes should all be empty strings. If specifying either or both of chanInp and/or stokes, the one(s) being specified should be non-empty strings corresponding to correct syntax for that particular parameter, and regionRec should be null. If you specify regionRec=0 and box="", stokes="", and chanInp="", that implies you want to use all of the input image.

template<class T >

casa::ImageCropper< T >::~ImageCropper

(

)

destructor

template<class T >

casa::ImageCropper< T >::ImageCropper

(

)

[private]

disallow default constructor

---

Member Function Documentation

template<class T >

vector<Coordinate::Type> casa::ImageCropper< 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 97 of file ImageCropper.h.

template<class T >

CasacRegionManager::StokesControl casa::ImageCropper< T >::_getStokesControl

(

)

const [inline, protected, virtual]

Implements casa::ImageTask< T >.

Definition at line 93 of file ImageCropper.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

template<class T >

SHARED_PTR<ImageInterface<T> > casa::ImageCropper< T >::crop

(

const Bool

wantReturn

)

const

Perform the cropping.

If wantReturn is True, a shared_ptr which wraps the cropped image is returned. If False, an empty shared_ptr is returned.

template<class T >

String casa::ImageCropper< T >::getClass

(

)

const [virtual]

Implements casa::ImageTask< T >.

template<class T >

void casa::ImageCropper< T >::setAxes

(

const std::set< uInt > &

axes

)

Set the axes along which to do the cropping.

An empty set means crop all axes.

---

Member Data Documentation

template<class T >

std::set<uInt> casa::ImageCropper< T >::_axes [private]

Definition at line 102 of file ImageCropper.h.

template<class T >

const String casa::ImageCropper< T >::_class [static, private]

Definition at line 103 of file ImageCropper.h.

---

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

• code/imageanalysis/ImageAnalysis/ImageCropper.h