casa::ParameterParser Class Reference

Parse various common input parameters to image analysis tasks and tool methods <author>Dave Mehringer</author>. More...

#include <ParameterParser.h>

Static Public Member Functions
static std::vector< uInt >	consolidateAndOrderRanges (uInt &nSelected, const std::vector< uInt > &ranges)
	`ranges` are pairs describing the pixel range over which to select.
static std::vector< uInt >	spectralRangesFromChans (uInt &nSelectedChannels, const String &specification, const uInt nChannels)
	get spectral ranges from chans parameter, nSelectedChannels will have the total number of channels selected for the specification, for an image that has nChannels.
static std::vector< String >	stokesFromString (String &specification)
	get a vector of correlations, represented by String, from a stokes string specifcation, eg, "LLRR", "IV", etc that is commonly used in the stokes parameter in casa image analysis tasks

Detailed Description

Parse various common input parameters to image analysis tasks and tool methods <author>Dave Mehringer</author>.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Etymology

Parse parameters

Synopsis

This class is for parsing input parameters associated with image analysis tasks and tool methods.

Definition at line 57 of file ParameterParser.h.

Member Function Documentation

static std::vector<uInt> casa::ParameterParser::consolidateAndOrderRanges	(	uInt &	nSelected,
		const std::vector< uInt > &	ranges
	)			`[static]`

ranges are pairs describing the pixel range over which to select.

If you want to select just one pixel in the "range", you must specify that pixel in both parts of the pair. So if you want to select pixels 0 through 5 and pixel 13, you'd specify ranges[0] = 0; ranges[1] = 5; ranges[2] = 13; ranges[3] = 13

static std::vector<uInt> casa::ParameterParser::spectralRangesFromChans	(	uInt &	nSelectedChannels,
		const String &	specification,
		const uInt	nChannels
	)			`[static]`

get spectral ranges from chans parameter, nSelectedChannels will have the total number of channels selected for the specification, for an image that has nChannels.

static std::vector<String> casa::ParameterParser::stokesFromString ( String & specification ) [static]

get a vector of correlations, represented by String, from a stokes string specifcation, eg, "LLRR", "IV", etc that is commonly used in the stokes parameter in casa image analysis tasks

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

code/imageanalysis/IO/ParameterParser.h