casa::ImageInputProcessor Class Reference

#include <ImageInputProcessor.h>

Public Member Functions
	ImageInputProcessor ()
	Collection of methods for processing inputs to image analysis applications.
	~ImageInputProcessor ()
	Destructor.
template<class T >
void	process (Record &regionRecord, String &diagnostics, std::vector< OutputDestinationChecker::OutputStruct > const outputStruct, String &stokes, SPCIIT image, const Record regionPtr, const String &regionName, const String &box, const String &chans, const CasacRegionManager::StokesControl &stokesControl, const Bool &allowMultipleBoxes, const std::vector< Coordinate::Type > *const &requiredCoordinateTypes, Bool verbose=True)
	Process the inputs.
uInt	nSelectedChannels () const
	Get the number of channels that have been selected.
Private Member Functions
template<class T >
void	_process (Record &regionRecord, String &diagnostics, std::vector< OutputDestinationChecker::OutputStruct > outputStruct, String &stokes, SPCIIT image, const Record const &regionPtr, const String &regionName, const String &box, const String &chans, const CasacRegionManager::StokesControl &stokesControl, const Bool &allowMultipleBoxes, const std::vector< Coordinate::Type > *const &requiredCoordinateTypes, Bool verbose)
void	_setRegion (Record &regionRecord, String &diagnostics, const Record *const regionPtr) const
	set region given a pointer to a region record.
template<class T >
void	_setRegion (Record &regionRecord, String &diagnostics, const ImageInterface< T > *const image, const String &regionName) const
String	_stokesFromRecord (const Record &region, const CoordinateSystem &csys) const
String	_pairsToString (const std::vector< uInt > &pairs) const
Private Attributes
LogIO *	_log
Bool	_processHasRun
uInt	_nSelectedChannels

Detailed Description

Definition at line 39 of file ImageInputProcessor.h.

Constructor & Destructor Documentation

casa::ImageInputProcessor::ImageInputProcessor ( )

Collection of methods for processing inputs to image analysis applications.

Etymology

Processes inputs to image analysis apps.

Synopsis

Collection of methods for processing inputs to image analysis applicationsconstructor

casa::ImageInputProcessor::~ImageInputProcessor ( )

Destructor.

Member Function Documentation

String casa::ImageInputProcessor::_pairsToString ( const std::vector< uInt > & pairs ) const [private]

template<class T >

void casa::ImageInputProcessor::_process	(	Record &	regionRecord,
		String &	diagnostics,
		std::vector< OutputDestinationChecker::OutputStruct > *	outputStruct,
		String &	stokes,
		SPCIIT	image,
		const Record *const &	regionPtr,
		const String &	regionName,
		const String &	box,
		const String &	chans,
		const CasacRegionManager::StokesControl &	stokesControl,
		const Bool &	allowMultipleBoxes,
		const std::vector< Coordinate::Type > *const &	requiredCoordinateTypes,
		Bool	verbose
	)			`[inline, private]`

template<class T >

void casa::ImageInputProcessor::_setRegion	(	Record &	regionRecord,
		String &	diagnostics,
		const ImageInterface< T > *const	image,
		const String &	regionName
	)			const `[inline, private]`

void casa::ImageInputProcessor::_setRegion	(	Record &	regionRecord,
		String &	diagnostics,
		const Record *const	regionPtr
	)			const `[private]`

set region given a pointer to a region record.

String casa::ImageInputProcessor::_stokesFromRecord	(	const Record &	region,
		const CoordinateSystem &	csys
	)			const `[private]`

uInt casa::ImageInputProcessor::nSelectedChannels ( ) const

Get the number of channels that have been selected.

The process() method must be called prior to calling this method or an exception is thrown.

template<class T >

void casa::ImageInputProcessor::process	(	Record &	regionRecord,
		String &	diagnostics,
		std::vector< OutputDestinationChecker::OutputStruct > *const	outputStruct,
		String &	stokes,
		SPCIIT	image,
		const Record *	regionPtr,
		const String &	regionName,
		const String &	box,
		const String &	chans,
		const CasacRegionManager::StokesControl &	stokesControl,
		const Bool &	allowMultipleBoxes,
		const std::vector< Coordinate::Type > *const &	requiredCoordinateTypes,
		Bool	verbose = `True`
	)			`[inline]`

Process the inputs.

Output parameters are the pointer to the opened image, the specified region as a record ( regionRecord, and a diagnostics String describing how the region was chosen. If provided, regionPtr should be a pointer to a record created by a RegionManager method. stokesControl indicates default stokes range to use if stokes is blank. In this case stokes will be set the the value of stokes that will be used. If allowMultipleBoxes is False, an exception will be thrown if the inputs specify multiple n-dimensional rectangles. This should usually be set to false if the caller can only deal with a single n-dimensional rectangular region. Process the inputs. Use this version if the associated image already exists. Output parameters the specified region as a record ( regionRecord, and a diagnostics String describing how the region was chosen. If provided, regionPtr should be a pointer to a record created by a RegionManager method. stokesControl indicates default stokes range to use if stokes is blank. In this case stokes will be set the the value of stokes that will be used. If allowMultipleBoxes is False, an exception will be thrown if the inputs specify multiple n-dimensional rectangles. This should usually be set to false if the caller can only deal with a single n-dimensional rectangular region.