casa::ImageInputProcessor Class Reference

#include <ImageInputProcessor.h>

Public Member Functions
	ImageInputProcessor ()
	Collection of methods for processing inputs to image analysis applications. More...
	~ImageInputProcessor ()
	Destructor. More...
template<class T >
void	process (casacore::Record &regionRecord, casacore::String &diagnostics, std::vector< OutputDestinationChecker::OutputStruct > *const outputStruct, casacore::String &stokes, SPCIIT image, const casacore::Record *regionPtr, const casacore::String &regionName, const casacore::String &box, const casacore::String &chans, const CasacRegionManager::StokesControl &stokesControl, const casacore::Bool &allowMultipleBoxes, const std::vector< casacore::Coordinate::Type > *const &requiredCoordinateTypes, casacore::Bool verbose=true)
	Process the inputs. More...
casacore::uInt	nSelectedChannels () const
	Get the number of channels that have been selected. More...

Private Member Functions
template<class T >
void	_process (casacore::Record &regionRecord, casacore::String &diagnostics, std::vector< OutputDestinationChecker::OutputStruct > *outputStruct, casacore::String &stokes, SPCIIT image, const casacore::Record *const &regionPtr, const casacore::String &regionName, const casacore::String &box, const casacore::String &chans, const CasacRegionManager::StokesControl &stokesControl, const casacore::Bool &allowMultipleBoxes, const std::vector< casacore::Coordinate::Type > *const &requiredCoordinateTypes, casacore::Bool verbose)
void	_setRegion (casacore::Record &regionRecord, casacore::String &diagnostics, const casacore::Record *const regionPtr) const
	set region given a pointer to a region record. More...
template<class T >
void	_setRegion (casacore::Record &regionRecord, casacore::String &diagnostics, const casacore::ImageInterface< T > *const image, const casacore::String &regionName) const
casacore::String	_stokesFromRecord (const casacore::Record &region, const casacore::CoordinateSystem &csys) const
casacore::String	_pairsToString (const std::vector< casacore::uInt > &pairs) const

Private Attributes
casacore::LogIO *	_log
casacore::Bool	_processHasRun
casacore::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

casacore::String casa::ImageInputProcessor::_pairsToString ( const std::vector< casacore::uInt > &  pairs ) const

private

template<class T >

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

private

void casa::ImageInputProcessor::_setRegion ( casacore::Record &  regionRecord, casacore::String &  diagnostics, const casacore::Record *const  regionPtr  ) const

private

set region given a pointer to a region record.

template<class T >

void casa::ImageInputProcessor::_setRegion ( casacore::Record &  regionRecord, casacore::String &  diagnostics, const casacore::ImageInterface< T > *const  image, const casacore::String &  regionName  ) const

private

casacore::String casa::ImageInputProcessor::_stokesFromRecord ( const casacore::Record &  region, const casacore::CoordinateSystem &  csys  ) const

private

casacore::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	(	casacore::Record &	regionRecord,
		casacore::String &	diagnostics,
		std::vector< OutputDestinationChecker::OutputStruct > *const	outputStruct,
		casacore::String &	stokes,
		SPCIIT	image,
		const casacore::Record *	regionPtr,
		const casacore::String &	regionName,
		const casacore::String &	box,
		const casacore::String &	chans,
		const CasacRegionManager::StokesControl &	stokesControl,
		const casacore::Bool &	allowMultipleBoxes,
		const std::vector< casacore::Coordinate::Type > *const &	requiredCoordinateTypes,
		casacore::Bool	verbose = true
	)

Process the inputs.

Output parameters are the pointer to the opened image, the specified region as a record ( regionRecord, and a diagnostics casacore::String describing how the region was chosen. If provided, regionPtr should be a pointer to a record created by a casacore::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 casacore::String describing how the region was chosen. If provided, regionPtr should be a pointer to a record created by a casacore::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.

Member Data Documentation

casacore::LogIO* casa::ImageInputProcessor::_log

private

Definition at line 124 of file ImageInputProcessor.h.

casacore::uInt casa::ImageInputProcessor::_nSelectedChannels

private

Definition at line 126 of file ImageInputProcessor.h.

casacore::Bool casa::ImageInputProcessor::_processHasRun

private

Definition at line 125 of file ImageInputProcessor.h.

---

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

• casa/code/imageanalysis/ImageAnalysis/ImageInputProcessor.h