casa::ImageMoments< T > Class Template Reference
[Images]

#include <ImageMoments.h>

Collaboration diagram for casa::ImageMoments< T >:

[legend]List of all members.

Detailed Description

template<class T>
class casa::ImageMoments< T >

This class generates moments from an image.

Intended use:

Part of API

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

Etymology

This class computes moments from images

Synopsis

The primary goal of this class is to help spectral-line astronomers analyze their multi-dimensional images by generating moments of a specified axis. The word "moment" is used loosely here. It refers to collapsing an axis to one pixel and putting the value of that pixel (for all of the other non-collapsed axes) to something computed from the data values along the moment axis. For example, take an RA-DEC-Velocity cube, collapse the velocity axis by computing the mean intensity at each RA-DEC pixel. This class offers many different moments and a variety of interactive and automatic ways to compute them.

This class only accepts images of type Float and Double. This restriction is because of the plotting capabilities which are a bit awkward for other types.

This class makes a distinction between a "moment" and a "method". This boundary is a little blurred, but it claims to refer to the distinction of what you are computing, as to how the pixels that were included in the computation were selected. For example, a "moment" would be the average value of some pixels. A method for selecting those pixels would be a simple range specifying a range for which pixels should be included.

The default state of this class is to do nothing. If you specify an image via the setImage function then invoking the createMoments function will cause it to compute the integrated itensity along the spectral axis of the image (if it can find one). You can change the computational state of the class from this basic form via the remaining set functions. You can call any number of these functions to suit your needs.

Because there are a wide variety of methods available, if you specify an invalid combination, a table showing the available methods is listed. It is reproduced below for convenience.

The basic method is to just compute moments directly from the pixel intensities. This can be modified by applying pixel intensity inclusion or exclusion ranges. You can then also smooth the image and compute a mask based on the inclusion or exclusion ranges applied to the smoothed image. This mask is then applied to the unsmoothed data for moment computation.

The window method does no pixel intensity range selection. Instead a spectral window is found (hopefully surrounding the spectral line feature) and only the pixels in that window are used for computation. This window can be found from the smoothed or unsmoothed data. The moments are always computed from the unsmoothed data. For each spectrum, the window can be found interactively or automatically. There are two interactive methods. Either you just mark the window with the cursor, or you interactively fit a Gaussian to the profile and the +/- 3-sigma window is returned. There are two automatic methods. Either Bosma's converging mean algorithm is used, or an automatically fit Gaussian +/- 3-sigma window is returned.

The fitting method fits Gaussians to spectral features either automatically or interactively. The moments are then computed from the Gaussian fits (not the data themselves).

When an output image is created, it will have N-1 axes, where the input image has N axes. In the output image, the physical axis corresponding to the moment axis will have been removed, but the coordinate information will be retained for future coordinate transformations. For example, if you have a RA-DEC-VELOCITY image and you collapsed axis 2 (the DEC axis) the output images would be RA-VELOCITY with the coordinate information retained for the DEC axis so that the coupled nature of RA/DEC coordinates is preserved.

Output images are created with an all True (good) mask. If, for a given pixel, the moment calculation fails, then the mask is set to F.

When making plots, the order in which the spectra are displayed is determined by the tiling sequence of the image (for optimum speed of access).

                      Allowed Methods
                      ---------------
   
      Smooth    Window      Fit   in/exclude   Interactive 
      -----------------------------------------------------
        N          N         N        N            N       
        Y/N        N         N        Y            N       
    
        Y/N        Y         N        N            Y       
        Y/N        Y         N        N            N       
        Y/N        Y         Y        N            Y/N     
   
        N          N         Y        N            Y/N     
      ----------------------------------------------------

Caution: Note that the MEDIAN_COORDINATE moment is not very robust. It is very useful for generating quickly a velocity field in a way that is not sensitive to noise. However, it will only give sensible results under certain conditions. It treats the spectrum as a probability distribution, generates the cumulative distribution for the selected pixels (via an include or exclude pixel range, and finds the (interpolated) coordinate coresponding to the 50% value. The generation of the cumulative distribution and the finding of the 50% level really only makes sense if the cumulative distribution is monotonically increasing. This essentially means only selecting pixels which are positive or negative. For this reason, this moment type is *only* supported with the basic method (i.e. no smoothing, no windowing, no fitting) with a pixel selection range that is either all positive, or all negative.

Tip: If you ignore return error statuses from the functions that set the state of the class, the internal status of the class is set to bad. This means it will just keep on returning error conditions until you explicitly recover the situation. A message describing the last error condition can be recovered with function errorMessage.

Example

   // Set state function argument values
   
         Vector<Int> moments(2);
         moments(0) = ImageMoments<Float>::AVERAGE;
         moments(1) = ImageMoments<Float>::WEIGHTED_MEAN_COORDINATE;
         Vector<int> methods(2);
         methods(0) = ImageMoments<Float>::WINDOW;
         methods(1) = ImageMoments<Float>::INTERACTIVE;
         Vector<Int> nxy(2);
         nxy(0) = 3;
         nxy(1) = 3;
   
   // Open paged image
        
         PagedImage<Float> inImage(inName);  
   
   // Construct moment helper object
   
         LogOrigin or("myClass", "myFunction(.\..)", WHERE);
         LogIO os(or);
         ImageMoments<Float> moment(SubImage<Float>(inName), os);
   
   // Specify state via control functions
   
         if (!moment.setMoments(moments)) return 1;
         if (!moment.setWinFitMethod(methods)) return 1;
         if (!moment.setMomentAxis(3)) return 1;
         if (!moment.setPlotting("/xs", nxy)) return 1;
   
   // Create the moments
   
         if (!moment.createMoments()) return 1;

In this example, we generate two moments (average intensity and intensity weighted mean coordinate -- usually the velocity field) of axis 3 by the interactive window method. The interactive plotting is done on the PGPLOT device called /xs. We put 9 subplots on each page. The output file names are constructed by the class from the input file name plus some internally generated suffixes.

Motivation

This is a fundamental and traditional piece of spectral-line image analysis.

To Do

more control over histogram of image noise at start (pixel range and number of bins)
better algorithm for seeing if spectrum is pure noise
Make this class extensible so users could add their own method.

Definition at line 244 of file ImageMoments.h.

Public Types

enum MomentTypes

This enum MomentTypes is provided for use with the setMoments function. More...

enum MethodTypes

The enum MethodTypes is provided for use with the setWinFitMethod function. More...

Public Member Functions

ImageMoments (ImageInterface< T > &image, LogIO &os, Bool overWriteOutput=False, Bool showProgress=True)

Constructor takes an image and a LogIO object for logging purposes.

ImageMoments (const ImageMoments< T > &other)

Copy constructor.

ImageMoments (ImageMoments< T > &other)

Copy constructor.

~ImageMoments ()

Destructor.

ImageMoments< T > & operator= (const ImageMoments< T > &other)

Assignment operator.

Bool setMoments (const Vector< Int > &moments)

Set the desired moments via an Int array.

Bool setMomentAxis (const Int &momentAxis)

Set the moment axis (0 relative).

Bool setWinFitMethod (const Vector< Int > &method)

The method by which you compute the moments is specified by calling (or not calling) the setWinFitMethod and setSmoothMethod functions.

Bool setInExCludeRange (const Vector< T > &include, const Vector< T > &exclude)

You may specify a pixel intensity range as either one for which all pixels in that range are included in the moment calculation, or one for which all pixels in that range are excluded from the moment calculations.

Bool setSnr (const T &peakSNR, const T &stdDeviation)

This function is used to help assess whether a spectrum along the moment axis is all noise or not.

Bool setSmoothOutName (const String &smOut)

This is the output file name for the smoothed image.

Bool setPlotting (PGPlotter &device, const Vector< Int > &nxy, const Bool yInd=False)

This sets the name of the PGPLOT plotting device, the number of subplots in x and y per page and whether each spectrum plot is autoscaled individually (yInd=False) or they are plotted with the same range automatically determined from the image.

void setVelocityType (MDoppler::Types type)

Set Velocity type.

void closePlotting ()

CLose plotter.

void resetError ()

Reset argument error condition.

String errorMessage () const

Recover last error message.

Bool createMoments (PtrBlock< MaskedLattice< T > * > &images, Bool doTemp, const String &outFileName, Bool removeAxes=True)

This is the function that does all the computational work.

Bool setNewImage (ImageInterface< T > &image)

Set a new image.

CoordinateSystem coordinates () const

Get CoordinateSystem.

Bool setSmoothMethod (const Vector< Int > &smoothAxes, const Vector< Int > &kernelTypes, const Vector< Quantum< Double > > &kernelWidths)

This function invokes smoothing of the input image.

Bool setSmoothMethod (const Vector< Int > &smoothAxes, const Vector< Int > &kernelTypes, const Vector< Double > &kernelWidths)

Static Public Member Functions

static Vector< Int > toMethodTypes (const String &methods)

Helper function to convert a string containing a list of desired methods to the correct Vector<Int> required for the setWinFitMethod function.

Private Member Functions

Bool checkMethod ()

Check that the combination of methods that the user has requested is valid List a handy dandy table if not.

Bool setIncludeExclude (Vector< T > &range, Bool &noInclude, Bool &noExclude, const Vector< T > &include, const Vector< T > &exclude, ostream &os)

Take the user's data inclusion and exclusion data ranges and generate the range and Booleans to say what sort it is.

Bool setOutThings (String &suffix, Unit &momentUnits, const Unit &imageUnits, const String &momentAxisUnits, const Int moment, Bool convertToVelocity)

Set the output image suffixes and units.

Bool smoothImage (PtrHolder< ImageInterface< T > > &pSmoothedImage, String &smoothName)

Smooth an image.

Bool whatIsTheNoise (T &noise, ImageInterface< T > &image)

Determine the noise by fitting a Gaussian to a histogram of the entire image above the 25% levels.

CoordinateSystem makeOutputCoordinates (IPosition &outShape, const CoordinateSystem &cSysIn, const IPosition &inShape, Int momentAxis, Bool removeAxis)

Make output Coordinates.

Static Private Member Functions

static void drawHistogram (const Vector< T > &values, const Vector< T > &counts, PGPlotter &plotter)

Plot a histogram.

static void drawLine (const Vector< T > &x, const Vector< T > &y, PGPlotter &plotter)

Plot a line.

static void drawVertical (const T &x, const T &yMin, const T &yMax, PGPlotter &plotter)

Draw a vertical line of the given length at a given abcissa.

static Bool getLoc (T &x, T &y, PGPlotter &plotter)

Read the cursor and return its coordinates.

static Float convertT (const T value)

Convert a <T> to a <Float> for plotting.

static T convertF (const Float value)

Convert a <Float> (from plotting) to a <T>.

static Bool readCursor (PGPlotter &plotter, Float &x, Float &y, String &ch)

Fish out cursor values.

Private Attributes

LogIO os_p

ImageInterface< T > * pInImage_p

Bool showProgress_p

Int momentAxisDefault_p

T peakSNR_p

T stdDeviation_p

T yMin_p

T yMax_p

String out_p

String smoothOut_p

Bool goodParameterStatus_p

Bool doWindow_p

Bool doFit_p

Bool doAuto_p

Bool doSmooth_p

Bool noInclude_p

Bool noExclude_p

Bool fixedYLimits_p

Int momentAxis_p

Int worldMomentAxis_p

Vector< Int > kernelTypes_p

Vector< Quantum< Double > > kernelWidths_p

Vector< Int > nxy_p

Vector< Int > moments_p

Vector< T > selectRange_p

Vector< Int > smoothAxes_p

PGPlotter plotter_p

Bool overWriteOutput_p

String error_p

Bool convertToVelocity_p

MDoppler::Types velocityType_p

Friends

class MomentCalcBase< T >

Note that if I don't put MomentCalcBase as a forward declaration and use instead "friend class MomentCalcBase<T>" The gnu compiler fails with a typedef problem.

Member Enumeration Documentation

template<class T>

enum casa::ImageMoments::MomentTypes

This enum MomentTypes is provided for use with the setMoments function.

It gives the allowed moment types that you can ask for.

Definition at line 280 of file ImageMoments.h.

template<class T>

enum casa::ImageMoments::MethodTypes

The enum MethodTypes is provided for use with the setWinFitMethod function.

It gives the allowed moment methods which are available with this function. The use of these methods is described further with the description of this function as well as in the general documentation earlier.

Definition at line 349 of file ImageMoments.h.

Constructor & Destructor Documentation

template<class T>

casa::ImageMoments< T >::ImageMoments	(	ImageInterface< T > &	image,
		LogIO &	os,
		Bool	overWriteOutput = `False`,
		Bool	showProgress = `True`
	)

Constructor takes an image and a LogIO object for logging purposes.

You specify whether output images are automatically overwritten if pre-existing, or whether an intercative choice dialog widget appears (overWriteOutput=F) You may also determine whether a progress meter is displayed or not.

template<class T>

casa::ImageMoments< T >::ImageMoments ( const ImageMoments< T > & other )

Copy constructor.

Uses copy semantics.

template<class T>

casa::ImageMoments< T >::ImageMoments ( ImageMoments< T > & other )

Copy constructor.

Uses copy semantics.

template<class T>

casa::ImageMoments< T >::~ImageMoments ( )

Destructor.

Member Function Documentation

template<class T>

ImageMoments<T>& casa::ImageMoments< T >::operator= ( const ImageMoments< T > & other )

Assignment operator.

USes copy semantics.

template<class T>

Bool casa::ImageMoments< T >::setMoments ( const Vector< Int > & moments )

Set the desired moments via an Int array.

Each Int specifies a different moment; the allowed values and their meanings are given by the enum MomentTypes. A return value of False indicates you asked for an out of range moment. If you don't call this function, the default state of the class is to request the integrated intensity.

template<class T>

Bool casa::ImageMoments< T >::setMomentAxis ( const Int & momentAxis )

Set the moment axis (0 relative).

A return value of False indicates that the axis was not contained in the image. If you don't call this function, the default state of the class is to set the moment axis to the spectral axis if it can find one. Otherwise an error will result.

template<class T>

Bool casa::ImageMoments< T >::setWinFitMethod ( const Vector< Int > & method )

The method by which you compute the moments is specified by calling (or not calling) the setWinFitMethod and setSmoothMethod functions.

The default state of the class is to compute directly on all (or some according to setInExClude) of the pixels in the spectrum. Calling these functions modifies the computational state to something more complicated.

The setWinMethod function requires an Int array as its argument. Each Int specifies a different method that you can invoke (either separately or in combination). The allowed values and their meanings are given by the enum MethodTypes.

Both the windowing and fitting methods have interactive modes. The windowing method also has a fitting flavour, so if you set both ImageMoments::WINDOW and ImageMoments::FIT, you would be invoking the windowing method but determining the window by fitting Gaussians automatically (as ImageMoments::INTERACTIVE) was not given.

If you don't call this function, then neither the windowing nor fitting methods are invoked. A return value of False indicates that you asked for an illegal method.

template<class T>

Bool casa::ImageMoments< T >::setSmoothMethod	(	const Vector< Int > &	smoothAxes,
		const Vector< Int > &	kernelTypes,
		const Vector< Quantum< Double > > &	kernelWidths
	)

This function invokes smoothing of the input image.

Give Int arrays for the axes (0 relative) to be smoothed and the smoothing kernel types (use the enum KernelTypes) for each axis. Give a Double array for the widths (full width for BOXCAR and full width at half maximum for GAUSSIAN) in pixels of the smoothing kernels for each axis. For HANNING smoothing, you always get the quarter-half-quarter kernel (no matter what you might ask for). A return value of False indicates that you have given an inconsistent or invalid set of smoothing parameters. If you don't call this function the default state of the class is to do no smoothing. The kernel types are specified with the VectorKernel::KernelTypes enum

template<class T>

Bool casa::ImageMoments< T >::setSmoothMethod	(	const Vector< Int > &	smoothAxes,
		const Vector< Int > &	kernelTypes,
		const Vector< Double > &	kernelWidths
	)

template<class T>

Bool casa::ImageMoments< T >::setInExCludeRange	(	const Vector< T > &	include,
		const Vector< T > &	exclude
	)

You may specify a pixel intensity range as either one for which all pixels in that range are included in the moment calculation, or one for which all pixels in that range are excluded from the moment calculations.

One or the other of include and exclude must therefore be a zero length vector if you call this function. A return value of False indicates that you have given both an include and an exclude range. If you don't call this function, the default state of the class is to include all pixels.

template<class T>

Bool casa::ImageMoments< T >::setSnr	(	const T &	peakSNR,
		const T &	stdDeviation
	)

This function is used to help assess whether a spectrum along the moment axis is all noise or not.

If it is all noise, there is not a lot of point to trying to computing the moment. This is only needed for the automatic window or fit methods. If you are using an interactive nethod, you assess yourself whether the spectrum contains signal or not.

peakSNR is the signal-to-noise ratio of the peak value in the spectrum below which the spectrum is considered pure noise. stdDeviation is the standard deviation of the noise for the input image.

Default values for one or the other parameter are indicated by giving zero.

The default state of the class then is to set peakSNR=3 and/or to work out the noise level from a Gaussian fit to a histogram (above 25%) of the entire image (it is very hard to get an accurate estimate of the noise a single spectrum). If you have specified a plotting device (see setPlotting) then you get to interact with the fitting procedure if you want to. A return value of False indicates you have set invalid values.

template<class T>

Bool casa::ImageMoments< T >::setSmoothOutName ( const String & smOut )

This is the output file name for the smoothed image.

It can be useful to have access this to this image when trying to get the pixel include or exclude range correct for the smooth-clip method. The default state of the class is to not output the smoothed image.

template<class T>

Bool casa::ImageMoments< T >::setPlotting	(	PGPlotter &	device,
		const Vector< Int > &	nxy,
		const Bool	yInd = `False`
	)

This sets the name of the PGPLOT plotting device, the number of subplots in x and y per page and whether each spectrum plot is autoscaled individually (yInd=False) or they are plotted with the same range automatically determined from the image.

Plotting is not invoked for all states of the class. It is only needed for the interactive methods. If you ask for a method that needs to determine the noise from the image, and you set the plotting device, then this will be done interactively. Similarly, if you invoke the automatic window or fit methods, but set the plotting device, then you will see plots of the spectra and the selected windows and fits, respectively.

The default state of the class is that no plotting characteristics are set. However, if you set device but offer a zero length array for nxy then the latter is set to [1,1]. A return value of False indicates that you gave roo many values in the nxy vector.

template<class T>

void casa::ImageMoments< T >::setVelocityType ( MDoppler::Types type )

Set Velocity type.

This is used for moments for which the moment axis is a spectral axis for which the coordinate is traditionally presented in km/s You can select the velocity definition. The default state of the class is to use the radio definition.

template<class T>

void casa::ImageMoments< T >::closePlotting ( )

CLose plotter.

template<class T>

void casa::ImageMoments< T >::resetError ( ) [inline]

Reset argument error condition.

If you specify invalid arguments to one of the above functions, an internal flag will be set which will prevent the createMoments function from doing anything (should you have chosen to igmore the Boolean return values of the functions). This function allows you to reset that internal state to good.

Definition at line 483 of file ImageMoments.h.

References casa::ImageMoments< T >::error_p, casa::ImageMoments< T >::goodParameterStatus_p, and casa::True.

template<class T>

String casa::ImageMoments< T >::errorMessage ( ) const [inline]

Recover last error message.

Definition at line 486 of file ImageMoments.h.

References casa::ImageMoments< T >::error_p.

template<class T>

Bool casa::ImageMoments< T >::createMoments	(	PtrBlock< MaskedLattice< T > * > &	images,
		Bool	doTemp,
		const String &	outFileName,
		Bool	removeAxes = `True`
	)

This is the function that does all the computational work.

It should be called after the set functions. A return value of False indicates that additional checking of the combined methods that you have requested has shown that you have not given consistent state to the class. If the axis being collapsed comes from a coordinate with one axis only, the axis and its coordinate are physically removed from the output image. Otherwise, if removeAxes=True then the output axis is logically removed from the the output CoordinateSystem. If removeAxes=False then the axis is retained with shape=1 and with its original coordinate information (which is probably meaningless).

The output PtrBlock will hold PagedImages or TempImages (doTemp=True). It is your responsibility to delete the pointers. If doTemp is True, the outFileName is irrelevant.

If you create PagedImages, outFileName is the root name for the output files. Suffixes will be made up internally to append to this root. If you only ask for one moment, this will be the actual name of the output file. If you don't set this variable, the default state of the class is to set the output name root to the name of the input file.

template<class T>

Bool casa::ImageMoments< T >::setNewImage ( ImageInterface< T > & image )

Set a new image.

A return value of False indicates the image had an invalid type (this class only accepts Float or Double images).

template<class T>

CoordinateSystem casa::ImageMoments< T >::coordinates ( ) const [inline]

Get CoordinateSystem.

Definition at line 518 of file ImageMoments.h.

References casa::ImageMoments< T >::pInImage_p.

template<class T>

static Vector<Int> casa::ImageMoments< T >::toMethodTypes ( const String & methods ) [static]

Helper function to convert a string containing a list of desired methods to the correct Vector<Int> required for the setWinFitMethod function.

This may be usful if your user interface involves strings rather than integers. A new value is added to the output vector (which is resized appropriately) if any of the substrings "window", "fit" or "interactive" (actually "win", "box" and "inter" will do) is present.

template<class T>

Bool casa::ImageMoments< T >::checkMethod ( ) [private]

Check that the combination of methods that the user has requested is valid List a handy dandy table if not.

template<class T>

static void casa::ImageMoments< T >::drawHistogram	(	const Vector< T > &	values,
		const Vector< T > &	counts,
		PGPlotter &	plotter
	)			`[static, private]`

Plot a histogram.

template<class T>

static void casa::ImageMoments< T >::drawLine	(	const Vector< T > &	x,
		const Vector< T > &	y,
		PGPlotter &	plotter
	)			`[static, private]`

Plot a line.

template<class T>

static void casa::ImageMoments< T >::drawVertical	(	const T &	x,
		const T &	yMin,
		const T &	yMax,
		PGPlotter &	plotter
	)			`[static, private]`

Draw a vertical line of the given length at a given abcissa.

template<class T>

static Bool casa::ImageMoments< T >::getLoc	(	T &	x,
		T &	y,
		PGPlotter &	plotter
	)			`[static, private]`

Read the cursor and return its coordinates.

template<class T>

static Float casa::ImageMoments< T >::convertT ( const T value ) [inline, static, private]

Convert a <T> to a <Float> for plotting.

Definition at line 584 of file ImageMoments.h.

References casa::real().

template<class T>

static T casa::ImageMoments< T >::convertF ( const Float value ) [inline, static, private]

Convert a <Float> (from plotting) to a <T>.

Definition at line 587 of file ImageMoments.h.

template<class T>

static Bool casa::ImageMoments< T >::readCursor	(	PGPlotter &	plotter,
		Float &	x,
		Float &	y,
		String &	ch
	)			`[static, private]`

Fish out cursor values.

template<class T>

Bool casa::ImageMoments< T >::setIncludeExclude	(	Vector< T > &	range,
		Bool &	noInclude,
		Bool &	noExclude,
		const Vector< T > &	include,
		const Vector< T > &	exclude,
		ostream &	os
	)			`[private]`

Take the user's data inclusion and exclusion data ranges and generate the range and Booleans to say what sort it is.

template<class T>

Bool casa::ImageMoments< T >::setOutThings	(	String &	suffix,
		Unit &	momentUnits,
		const Unit &	imageUnits,
		const String &	momentAxisUnits,
		const Int	moment,
		Bool	convertToVelocity
	)			`[private]`

Set the output image suffixes and units.

template<class T>

Bool casa::ImageMoments< T >::smoothImage	(	PtrHolder< ImageInterface< T > > &	pSmoothedImage,
		String &	smoothName
	)			`[private]`

Smooth an image.

template<class T>

Bool casa::ImageMoments< T >::whatIsTheNoise	(	T &	noise,
		ImageInterface< T > &	image
	)			`[private]`

Determine the noise by fitting a Gaussian to a histogram of the entire image above the 25% levels.

If a plotting device is set, the user can interact with this process.

template<class T>

CoordinateSystem casa::ImageMoments< T >::makeOutputCoordinates	(	IPosition &	outShape,
		const CoordinateSystem &	cSysIn,
		const IPosition &	inShape,
		Int	momentAxis,
		Bool	removeAxis
	)			`[private]`

Make output Coordinates.

Friends And Related Function Documentation

template<class T>

friend class MomentCalcBase< T > [friend]

Note that if I don't put MomentCalcBase as a forward declaration and use instead "friend class MomentCalcBase<T>" The gnu compiler fails with a typedef problem.

But I can't solve it with say "typedef MomentCalcBase<T> gpp_type;" because you can only do a typedef with an actual type, not a <T> !

Definition at line 253 of file ImageMoments.h.

Member Data Documentation

template<class T>

LogIO casa::ImageMoments< T >::os_p [private]

Definition at line 531 of file ImageMoments.h.

template<class T>

ImageInterface<T>* casa::ImageMoments< T >::pInImage_p [private]

Definition at line 532 of file ImageMoments.h.

Referenced by casa::ImageMoments< T >::coordinates().

template<class T>

Bool casa::ImageMoments< T >::showProgress_p [private]

Definition at line 533 of file ImageMoments.h.

template<class T>

Int casa::ImageMoments< T >::momentAxisDefault_p [private]

Definition at line 534 of file ImageMoments.h.

template<class T>

T casa::ImageMoments< T >::peakSNR_p [private]

Definition at line 535 of file ImageMoments.h.

template<class T>

T casa::ImageMoments< T >::stdDeviation_p [private]

Definition at line 536 of file ImageMoments.h.

template<class T>

T casa::ImageMoments< T >::yMin_p [private]

Definition at line 537 of file ImageMoments.h.

template<class T>

T casa::ImageMoments< T >::yMax_p [private]

Definition at line 537 of file ImageMoments.h.

template<class T>

String casa::ImageMoments< T >::out_p [private]

Definition at line 538 of file ImageMoments.h.

template<class T>

String casa::ImageMoments< T >::smoothOut_p [private]

Definition at line 539 of file ImageMoments.h.

template<class T>

Bool casa::ImageMoments< T >::goodParameterStatus_p [private]

Definition at line 540 of file ImageMoments.h.

Referenced by casa::ImageMoments< T >::resetError().

template<class T>

Bool casa::ImageMoments< T >::doWindow_p [private]

Definition at line 541 of file ImageMoments.h.

template<class T>

Bool casa::ImageMoments< T >::doFit_p [private]

Definition at line 541 of file ImageMoments.h.

template<class T>

Bool casa::ImageMoments< T >::doAuto_p [private]

Definition at line 541 of file ImageMoments.h.

template<class T>

Bool casa::ImageMoments< T >::doSmooth_p [private]

Definition at line 541 of file ImageMoments.h.

template<class T>

Bool casa::ImageMoments< T >::noInclude_p [private]

Definition at line 541 of file ImageMoments.h.

template<class T>

Bool casa::ImageMoments< T >::noExclude_p [private]

Definition at line 541 of file ImageMoments.h.

template<class T>

Bool casa::ImageMoments< T >::fixedYLimits_p [private]

Definition at line 542 of file ImageMoments.h.

template<class T>

Int casa::ImageMoments< T >::momentAxis_p [private]

Definition at line 544 of file ImageMoments.h.

template<class T>

Int casa::ImageMoments< T >::worldMomentAxis_p [private]

Definition at line 545 of file ImageMoments.h.

template<class T>

Vector<Int> casa::ImageMoments< T >::kernelTypes_p [private]

Definition at line 546 of file ImageMoments.h.

template<class T>

Vector<Quantum<Double> > casa::ImageMoments< T >::kernelWidths_p [private]

Definition at line 547 of file ImageMoments.h.

template<class T>

Vector<Int> casa::ImageMoments< T >::nxy_p [private]

Definition at line 548 of file ImageMoments.h.

template<class T>

Vector<Int> casa::ImageMoments< T >::moments_p [private]

Definition at line 549 of file ImageMoments.h.

template<class T>

Vector<T> casa::ImageMoments< T >::selectRange_p [private]

Definition at line 550 of file ImageMoments.h.

template<class T>

Vector<Int> casa::ImageMoments< T >::smoothAxes_p [private]

Definition at line


Public Types
enum	MomentTypes
	This `enum MomentTypes` is provided for use with the `setMoments` function. More...
enum	MethodTypes
	The `enum MethodTypes` is provided for use with the `setWinFitMethod` function. More...
Public Member Functions
	ImageMoments (ImageInterface< T > &image, LogIO &os, Bool overWriteOutput=False, Bool showProgress=True)
	Constructor takes an image and a `LogIO` object for logging purposes.
	ImageMoments (const ImageMoments< T > &other)
	Copy constructor.
	ImageMoments (ImageMoments< T > &other)
	Copy constructor.
	~ImageMoments ()
	Destructor.
ImageMoments< T > &	operator= (const ImageMoments< T > &other)
	Assignment operator.
Bool	setMoments (const Vector< Int > &moments)
	Set the desired moments via an `Int` array.
Bool	setMomentAxis (const Int &momentAxis)
	Set the moment axis (0 relative).
Bool	setWinFitMethod (const Vector< Int > &method)
	The method by which you compute the moments is specified by calling (or not calling) the `setWinFitMethod` and `setSmoothMethod` functions.
Bool	setInExCludeRange (const Vector< T > &include, const Vector< T > &exclude)
	You may specify a pixel intensity range as either one for which all pixels in that range are included in the moment calculation, or one for which all pixels in that range are excluded from the moment calculations.
Bool	setSnr (const T &peakSNR, const T &stdDeviation)
	This function is used to help assess whether a spectrum along the moment axis is all noise or not.
Bool	setSmoothOutName (const String &smOut)
	This is the output file name for the smoothed image.
Bool	setPlotting (PGPlotter &device, const Vector< Int > &nxy, const Bool yInd=False)
	This sets the name of the PGPLOT plotting device, the number of subplots in x and y per page and whether each spectrum plot is autoscaled individually (`yInd=False`) or they are plotted with the same range automatically determined from the image.
void	setVelocityType (MDoppler::Types type)
	Set Velocity type.
void	closePlotting ()
	CLose plotter.
void	resetError ()
	Reset argument error condition.
String	errorMessage () const
	Recover last error message.
Bool	createMoments (PtrBlock< MaskedLattice< T > * > &images, Bool doTemp, const String &outFileName, Bool removeAxes=True)
	This is the function that does all the computational work.
Bool	setNewImage (ImageInterface< T > &image)
	Set a new image.
CoordinateSystem	coordinates () const
	Get CoordinateSystem.

Bool	setSmoothMethod (const Vector< Int > &smoothAxes, const Vector< Int > &kernelTypes, const Vector< Quantum< Double > > &kernelWidths)
	This function invokes smoothing of the input image.
Bool	setSmoothMethod (const Vector< Int > &smoothAxes, const Vector< Int > &kernelTypes, const Vector< Double > &kernelWidths)
Static Public Member Functions
static Vector< Int >	toMethodTypes (const String &methods)
	Helper function to convert a string containing a list of desired methods to the correct `Vector<Int>` required for the `setWinFitMethod` function.
Private Member Functions
Bool	checkMethod ()
	Check that the combination of methods that the user has requested is valid List a handy dandy table if not.
Bool	setIncludeExclude (Vector< T > &range, Bool &noInclude, Bool &noExclude, const Vector< T > &include, const Vector< T > &exclude, ostream &os)
	Take the user's data inclusion and exclusion data ranges and generate the range and Booleans to say what sort it is.
Bool	setOutThings (String &suffix, Unit &momentUnits, const Unit &imageUnits, const String &momentAxisUnits, const Int moment, Bool convertToVelocity)
	Set the output image suffixes and units.
Bool	smoothImage (PtrHolder< ImageInterface< T > > &pSmoothedImage, String &smoothName)
	Smooth an image.
Bool	whatIsTheNoise (T &noise, ImageInterface< T > &image)
	Determine the noise by fitting a Gaussian to a histogram of the entire image above the 25% levels.
CoordinateSystem	makeOutputCoordinates (IPosition &outShape, const CoordinateSystem &cSysIn, const IPosition &inShape, Int momentAxis, Bool removeAxis)
	Make output Coordinates.
Static Private Member Functions
static void	drawHistogram (const Vector< T > &values, const Vector< T > &counts, PGPlotter &plotter)
	Plot a histogram.
static void	drawLine (const Vector< T > &x, const Vector< T > &y, PGPlotter &plotter)
	Plot a line.
static void	drawVertical (const T &x, const T &yMin, const T &yMax, PGPlotter &plotter)
	Draw a vertical line of the given length at a given abcissa.
static Bool	getLoc (T &x, T &y, PGPlotter &plotter)
	Read the cursor and return its coordinates.
static Float	convertT (const T value)
	Convert a <T> to a <Float> for plotting.
static T	convertF (const Float value)
	Convert a <Float> (from plotting) to a <T>.
static Bool	readCursor (PGPlotter &plotter, Float &x, Float &y, String &ch)
	Fish out cursor values.
Private Attributes
LogIO	os_p
ImageInterface< T > *	pInImage_p
Bool	showProgress_p
Int	momentAxisDefault_p
T	peakSNR_p
T	stdDeviation_p
T	yMin_p
T	yMax_p
String	out_p
String	smoothOut_p
Bool	goodParameterStatus_p
Bool	doWindow_p
Bool	doFit_p
Bool	doAuto_p
Bool	doSmooth_p
Bool	noInclude_p
Bool	noExclude_p
Bool	fixedYLimits_p
Int	momentAxis_p
Int	worldMomentAxis_p
Vector< Int >	kernelTypes_p
Vector< Quantum< Double > >	kernelWidths_p
Vector< Int >	nxy_p
Vector< Int >	moments_p
Vector< T >	selectRange_p
Vector< Int >	smoothAxes_p
PGPlotter	plotter_p
Bool	overWriteOutput_p
String	error_p
Bool	convertToVelocity_p
MDoppler::Types	velocityType_p
Friends
class	MomentCalcBase< T >
	Note that if I don't put MomentCalcBase as a forward declaration and use instead "friend class MomentCalcBase<T>" The gnu compiler fails with a typedef problem.

casa::ImageMoments< T > Class Template Reference [Images]

Detailed Description

template<class T> class casa::ImageMoments< T >

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Example

Motivation

To Do

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

casa::ImageMoments< T > Class Template Reference
[Images]

template<class T>
class casa::ImageMoments< T >