casa::ImageTwoPtCorr< T > Class Template Reference

Compute two point correlation functions from images. More...

#include <ImageTwoPtCorr.h>

Public Member Functions
	ImageTwoPtCorr ()
	Default constructor. More...
	ImageTwoPtCorr (const ImageTwoPtCorr &other)=delete
	Copy constructor (reference semantics) More...
ImageTwoPtCorr &	operator= (const ImageTwoPtCorr &other)
	Assignment (reference semantics) More...
	~ImageTwoPtCorr ()
	Destructor. More...
void	autoCorrelation (casacore::ImageInterface< T > &out, const casacore::ImageInterface< T > &in, const casacore::IPosition &axes, typename casacore::LatticeTwoPtCorr< T >::Method method, casacore::Bool progress=true) const
	Compute the desired autocorrelation function for the specified plane. More...
void	autoCorrelation (casacore::ImageInterface< T > &out, const casacore::ImageInterface< T > &in, typename casacore::LatticeTwoPtCorr< T >::Method method, casacore::Bool progress=true) const

Static Public Member Functions
static casacore::IPosition	setUpAxes (const casacore::IPosition &axes, const casacore::CoordinateSystem &cSys)
	Helper function to set up the axes vector. More...
static casacore::IPosition	setUpShape (const casacore::IPosition &inShape, const casacore::IPosition &axes)
	Helper function to provide output image shape given the input shape and the axes to find the structure function over. More...

Private Member Functions
void	copyMiscellaneous (casacore::ImageInterface< T > &out, const casacore::ImageInterface< T > &in) const
	Copy MiscInfo, casacore::ImageInfo, and logSInk to output. More...
void	setCoordinateSystem (casacore::ImageInterface< T > &out, const casacore::ImageInterface< T > &in, const casacore::IPosition &axes) const
	Overwrite the CoordinateSystem. More...
void	setUnit (casacore::ImageInterface< T > &out) const
	Set the brightness unit. More...

Detailed Description

template<class T>
class casa::ImageTwoPtCorr< T >

Compute two point correlation functions from images.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Prerequisite

• LatticeTwoPtCorr
• ImageInterface
• TempImage

Etymology

Compute the two point correlation function of an image

Synopsis

This class allows you to compute two point correlation functions from an image over planes of the specified two axes. Presently only autocorrelations and in particualt the structure function are implemented.

The structure function is S(x,y) = < [image(i,j) - image(i+x,j+y)]**2 > where x and y are absolute integer shifts (or lags) and the ensemble average is for each lag pair, x&y.

Example

Motivation

Taking the Structure casacore::Function of an image is a basic part of image analysis

To Do

• Add more types
• Add crosscorrelation

Definition at line 88 of file ImageTwoPtCorr.h.

Constructor & Destructor Documentation

template<class T >

casa::ImageTwoPtCorr< T >::ImageTwoPtCorr

(

)

Default constructor.

template<class T >

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

delete

Copy constructor (reference semantics)

template<class T >

casa::ImageTwoPtCorr< T >::~ImageTwoPtCorr

(

)

Destructor.

Member Function Documentation

template<class T >

void casa::ImageTwoPtCorr< T >::autoCorrelation	(	casacore::ImageInterface< T > &	out,
		const casacore::ImageInterface< T > &	in,
		const casacore::IPosition &	axes,
		typename casacore::LatticeTwoPtCorr< T >::Method	method,
		casacore::Bool	progress = true
	)		const

Compute the desired autocorrelation function for the specified plane.

You specify which two axes to compute the structure function over. If the axes array is empty (or not an argument), then the Sky plane is selected if it exists, otherwise the first two axes are selected. The casacore::CoordinateSystem of the output image is overwritten. The miscellaneous items (casacore::ImageInfo, MiscInfo, Logger) are copied from the input image to the output.

template<class T >

void casa::ImageTwoPtCorr< T >::autoCorrelation	(	casacore::ImageInterface< T > &	out,
		const casacore::ImageInterface< T > &	in,
		typename casacore::LatticeTwoPtCorr< T >::Method	method,
		casacore::Bool	progress = true
	)		const

template<class T >

void casa::ImageTwoPtCorr< T >::copyMiscellaneous ( casacore::ImageInterface< T > &  out, const casacore::ImageInterface< T > &  in  ) const

private

Copy MiscInfo, casacore::ImageInfo, and logSInk to output.

template<class T >

ImageTwoPtCorr& casa::ImageTwoPtCorr< T >::operator=

(

const ImageTwoPtCorr< T > &

other

)

Assignment (reference semantics)

template<class T >

void casa::ImageTwoPtCorr< T >::setCoordinateSystem ( casacore::ImageInterface< T > &  out, const casacore::ImageInterface< T > &  in, const casacore::IPosition &  axes  ) const

private

Overwrite the CoordinateSystem.

template<class T >

void casa::ImageTwoPtCorr< T >::setUnit ( casacore::ImageInterface< T > &  out ) const

private

Set the brightness unit.

template<class T >

static casacore::IPosition casa::ImageTwoPtCorr< T >::setUpAxes ( const casacore::IPosition &  axes, const casacore::CoordinateSystem &  cSys  )

static

Helper function to set up the axes vector.

If axes is of length 0, it looks for the Sky (casacore::DirectionCoordinate). If that's not there, you get the first two axes in the image.

template<class T >

static casacore::IPosition casa::ImageTwoPtCorr< T >::setUpShape ( const casacore::IPosition &  inShape, const casacore::IPosition &  axes  )

static

Helper function to provide output image shape given the input shape and the axes to find the structure function over.

---

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

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