casa::LatticeTwoPtCorr< T > Class Template Reference [Lattices_module]

Compute two point auto-correlation functions from a lattice. More...

#include <LatticeTwoPtCorr.h>

List of all members.

Public Types
enum	Method {   UNDEFINED,   STRUCTUREFUNCTION,   NMETHODS }
Public Member Functions
	LatticeTwoPtCorr ()
	Default constructor.
	~LatticeTwoPtCorr ()
	Destructor.
void	autoCorrelation (MaskedLattice< T > &out, const MaskedLattice< T > &in, const IPosition &axes, Method method, Bool showProgress=True) const
	Compute specified autocorrelation function for the planes of the given TWO axes.
Static Public Member Functions
static IPosition	setUpShape (const IPosition &inShape, const IPosition &axes)
	Helper function to provide output lattice shape give the input shape and the axes to find the structure function over.
static Method	fromString (const String &method)
	Helper functions to convert method types to and from strings.
static String	toString (Method method)
Private Types
typedef T(LatticeTwoPtCorr< T >::*	FuncPtr )(T d1, T d2) const
	Function Pointer typedef.
Private Member Functions
void	autoCorrelation (MaskedLattice< T > &out, const MaskedLattice< T > &in, const IPosition &axes, FuncPtr, Bool showProgress) const
	Do the iteration work.
void	check (LogIO &os, const MaskedLattice< T > &latOut, const MaskedLattice< T > &latIn, const IPosition &axes) const
	Check Output lattice shape.
T	structureFunction (T d1, T d2) const
	Compute structure function.

---

Detailed Description

template<class T>
class casa::LatticeTwoPtCorr< T >

Compute two point auto-correlation functions from a lattice.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Prerequisite

• MaskedLattice

Synopsis

This class allows you to compute two point correlation functions from lattices over planes of the specified two axes. At present, only autocorrelation is implemented and only the structure function is available.

The structure function is S(x,y) = < [lat(i,j) - lat(i+x,j+y)]**2 > where x and y are absolute integer shifts (or lags).

Example

To Do

• Add additional algorithms other than the structure function
• Allow cross correlation algorithms as well as autocorrelation

Definition at line 81 of file LatticeTwoPtCorr.h.

---

Member Typedef Documentation

template<class T>

typedef T(LatticeTwoPtCorr<T>::* casa::LatticeTwoPtCorr< T >::FuncPtr)(T d1, T d2) const [private]

Function Pointer typedef.

Definition at line 128 of file LatticeTwoPtCorr.h.

---

Member Enumeration Documentation

template<class T>

enum casa::LatticeTwoPtCorr::Method

Enumerator:

UNDEFINED	Undefined.
STRUCTUREFUNCTION	Structure Function.
NMETHODS	nMethods

Definition at line 85 of file LatticeTwoPtCorr.h.

---

Constructor & Destructor Documentation

template<class T>

casa::LatticeTwoPtCorr< T >::LatticeTwoPtCorr

(

)

[inline]

Default constructor.

Definition at line 99 of file LatticeTwoPtCorr.h.

template<class T>

casa::LatticeTwoPtCorr< T >::~LatticeTwoPtCorr

(

)

[inline]

Destructor.

Definition at line 103 of file LatticeTwoPtCorr.h.

---

Member Function Documentation

template<class T>

void casa::LatticeTwoPtCorr< T >::autoCorrelation	(	MaskedLattice< T > &	out,
		const MaskedLattice< T > &	in,
		const IPosition &	axes,
		Method	method,
		Bool	showProgress = True
	)			const

Compute specified autocorrelation function for the planes of the given TWO axes.

If the output lattice has a mask, it will first be set to False (bad) and then any output pixel with some contributing values will be set to True (good).

template<class T>

void casa::LatticeTwoPtCorr< T >::autoCorrelation	(	MaskedLattice< T > &	out,
		const MaskedLattice< T > &	in,
		const IPosition &	axes,
		FuncPtr	,
		Bool	showProgress
	)			const [private]

Do the iteration work.

template<class T>

void casa::LatticeTwoPtCorr< T >::check	(	LogIO &	os,
		const MaskedLattice< T > &	latOut,
		const MaskedLattice< T > &	latIn,
		const IPosition &	axes
	)			const [private]

Check Output lattice shape.

template<class T>

static Method casa::LatticeTwoPtCorr< T >::fromString

(

const String &

method

)

[static]

Helper functions to convert method types to and from strings.

template<class T>

static IPosition casa::LatticeTwoPtCorr< T >::setUpShape	(	const IPosition &	inShape,
		const IPosition &	axes
	)			[static]

Helper function to provide output lattice shape give the input shape and the axes to find the structure function over.

template<class T>

T casa::LatticeTwoPtCorr< T >::structureFunction	(	T	d1,
		T	d2
	)			const [inline, private]

Compute structure function.

Definition at line 142 of file LatticeTwoPtCorr.h.

References casa::square().

template<class T>

static String casa::LatticeTwoPtCorr< T >::toString

(

Method

method

)

[static]

---

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

• lattices/Lattices/LatticeTwoPtCorr.h