casa::SubImageFactory< T > Class Template Reference

Static methods for subimage creation. More...

#include <SubImageFactory.h>

List of all members.

Static Public Member Functions
static SubImage< T >	createSubImage (ImageRegion *&outRegion, ImageRegion *&outMask, ImageInterface< T > &inImage, const Record &region, const String &mask, LogIO *const &os, Bool writableIfPossible, const AxesSpecifier &axesSpecifier=casa::AxesSpecifier(), Bool extendMask=False, Bool preserveAxesOrder=False)
	Factory method to create a SubImage from a region and a WCLELMask string.
static SubImage< T >	createSubImage (ImageInterface< T > &inImage, const Record &region, const String &mask, LogIO *const &os, Bool writableIfPossible, const AxesSpecifier &axesSpecifier=casa::AxesSpecifier(), Bool extendMask=False, Bool preserveAxesOrder=False)
	variant on previous method where caller doesn't have to worry about creating pointers it does not need returned.
static ImageInterface< Float > *	createImage (ImageInterface< T > &image, const String &outfile, Record &Region, const String &mask, const Bool dropDegenerateAxes, const Bool overwrite, const Bool list, const Bool extendMask)
	return a PagedImage if outfile is not blank or a SubImage if it is.
Private Member Functions
	SubImageFactory ()

---

Detailed Description

template<class T>
class casa::SubImageFactory< T >

Static methods for subimage creation.

Intended use:

Public interface

Review Status

Test programs:

tSubImageFactory

Prerequisite

• SubImage

Synopsis

Factory methods for creating subimages

Motivation

Definition at line 61 of file SubImageFactory.h.

---

Constructor & Destructor Documentation

template<class T >

casa::SubImageFactory< T >::SubImageFactory

(

)

[private]

---

Member Function Documentation

template<class T >

static ImageInterface<Float>* casa::SubImageFactory< T >::createImage	(	ImageInterface< T > &	image,
		const String &	outfile,
		Record &	Region,
		const String &	mask,
		const Bool	dropDegenerateAxes,
		const Bool	overwrite,
		const Bool	list,
		const Bool	extendMask
	)		[static]

return a PagedImage if outfile is not blank or a SubImage if it is.

template<class T >

static SubImage<T> casa::SubImageFactory< T >::createSubImage	(	ImageRegion *&	outRegion,
		ImageRegion *&	outMask,
		ImageInterface< T > &	inImage,
		const Record &	region,
		const String &	mask,
		LogIO *const &	os,
		Bool	writableIfPossible,
		const AxesSpecifier &	axesSpecifier = casa::AxesSpecifier(),
		Bool	extendMask = False,
		Bool	preserveAxesOrder = False
	)		[static]

Factory method to create a SubImage from a region and a WCLELMask string.

Moved from ImageAnalysis outRegion Pointer to the corresponding region. Pointer is created internally by new(); it is the caller's responsibility to delete it. outMask Pointer to corresponding mask. Pointer is created internally via new(); it is the caller's responsibility to delete it. inImage input image for which a subimage is desired. region Input region record from which to make the subimage. mask LEL mask description. os Pointer to logger to which to log messages. If null, no logging (except exceptions). writableIfPossible make the subimage writable. If input image is not writable, this will always be False. axesSpecifier Specifier for output axes. extendMask If the mask has one or more of degenerate axes whereas the corresponding axes of inImage are not, extend the mask to match the shape of the input image. preserveAxesOrder. Only used when dropping degenerate axes and coordinate order and axes order are not the same. In that case, if False, the pixel/world axes order of the returned image will be different from the input, if True it will be the same. If not dropping degenerate axes or if coordinate order and axes order are the same in the input image's coordinate system, the output axex order will always be preserved.

template<class T >

static SubImage<T> casa::SubImageFactory< T >::createSubImage	(	ImageInterface< T > &	inImage,
		const Record &	region,
		const String &	mask,
		LogIO *const &	os,
		Bool	writableIfPossible,
		const AxesSpecifier &	axesSpecifier = casa::AxesSpecifier(),
		Bool	extendMask = False,
		Bool	preserveAxesOrder = False
	)		[static]

variant on previous method where caller doesn't have to worry about creating pointers it does not need returned.

---

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

• code/imageanalysis/ImageAnalysis/SubImageFactory.h