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

#include <ImageInputProcessor.h>

List of all members.

Classes

struct  OutputStruct
 Collection of methods for processing inputs to image analysis applications. More...

Public Member Functions

 ImageInputProcessor ()
 constructor
 ~ImageInputProcessor ()
 Destructor.
void process (ImageInterface< Float > *&image, Record &regionRecord, String &diagnostics, std::vector< OutputStruct > *const outputStruct, String &stokes, const String &imagename, 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.
void process (Record &regionRecord, String &diagnostics, std::vector< OutputStruct > *const outputStruct, String &stokes, const ImageInterface< Float > *const &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.

Static Public Member Functions

static void checkOutputs (std::vector< OutputStruct > *const output, LogIO &log)
static void checkOutput (OutputStruct &output, LogIO &log)

Private Member Functions

void _process (Record &regionRecord, String &diagnostics, std::vector< OutputStruct > *outputStruct, String &stokes, const ImageInterface< Float > *const &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.
void _setRegion (Record &regionRecord, String &diagnostics, const ImageInterface< Float > *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 37 of file ImageInputProcessor.h.


Constructor & Destructor Documentation

constructor

Destructor.


Member Function Documentation

String casa::ImageInputProcessor::_pairsToString ( const std::vector< uInt > &  pairs) const [private]
void casa::ImageInputProcessor::_process ( Record regionRecord,
String diagnostics,
std::vector< OutputStruct > *  outputStruct,
String stokes,
const ImageInterface< Float > *const &  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 
) [private]
void casa::ImageInputProcessor::_setRegion ( Record regionRecord,
String diagnostics,
const Record *const  regionPtr 
) const [private]

set region given a pointer to a region record.

void casa::ImageInputProcessor::_setRegion ( Record regionRecord,
String diagnostics,
const ImageInterface< Float > *const  image,
const String regionName 
) const [private]
String casa::ImageInputProcessor::_stokesFromRecord ( const Record region,
const CoordinateSystem csys 
) const [private]
static void casa::ImageInputProcessor::checkOutput ( OutputStruct output,
LogIO log 
) [static]
static void casa::ImageInputProcessor::checkOutputs ( std::vector< OutputStruct > *const  output,
LogIO log 
) [static]

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.

void casa::ImageInputProcessor::process ( ImageInterface< Float > *&  image,
Record regionRecord,
String diagnostics,
std::vector< OutputStruct > *const  outputStruct,
String stokes,
const String imagename,
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.

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.

void casa::ImageInputProcessor::process ( Record regionRecord,
String diagnostics,
std::vector< OutputStruct > *const  outputStruct,
String stokes,
const ImageInterface< Float > *const &  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.

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.


Member Data Documentation

Definition at line 136 of file ImageInputProcessor.h.

Definition at line 138 of file ImageInputProcessor.h.

Definition at line 137 of file ImageInputProcessor.h.


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