casa::LELSpectralIndex< T > Class Template Reference

This LEL class handles calculation of the spectral index. More...

#include <LELSpectralIndex.h>

Inheritance diagram for casa::LELSpectralIndex< T >:

List of all members.

Public Member Functions
	LELSpectralIndex (const Block< LatticeExprNode > &expr)
	Constructor takes operation and expressions to be operated upon.
	~LELSpectralIndex ()
	Destructor.
virtual void	eval (LELArray< T > &result, const Slicer &section) const
	Recursively evaluate the expression.
virtual LELScalar< T >	getScalar () const
	Get the result of a scalar subexpression.
virtual Bool	prepareScalarExpr ()
	Do further preparations (e.g.
virtual String	className () const
	Get class name.
virtual Bool	lock (FileLocker::LockType, uInt nattempts)
	Handle locking/syncing of a lattice in a lattice expression.
virtual void	unlock ()
virtual Bool	hasLock (FileLocker::LockType) const
virtual void	resync ()
Private Attributes
Int	itsFreqAxis
Block< Double >	itsLogFreq
LatticeExprNode	arg0_p
LatticeExprNode	arg1_p

---

Detailed Description

template<class T>
class casa::LELSpectralIndex< T >

This LEL class handles calculation of the spectral index.

Intended use:

Internal

Review Status

Date Reviewed:

yyyy/mm/dd

Prerequisite

• Lattice
• LatticeExpr
• LatticeExprNode
• LELInterface
• LELFunctionEnums

Synopsis

This LEL letter class is derived from LELInterface. It is used to construct LEL objects that calculate the sepectral index from 2 other LEL expression (usually images). It operates on real types (Float,Double)

Motivation

This is a separate class (instead of being part of a LELFunction class), because the calculation of the spectral index requires extra variables (the frequencies) and some more complicated code.

Definition at line 71 of file LELSpectralIndex.h.

---

Constructor & Destructor Documentation

template<class T >

casa::LELSpectralIndex< T >::LELSpectralIndex

(

const Block< LatticeExprNode > &

expr

)

Constructor takes operation and expressions to be operated upon.

template<class T >

casa::LELSpectralIndex< T >::~LELSpectralIndex

(

)

Destructor.

---

Member Function Documentation

template<class T >

virtual String casa::LELSpectralIndex< T >::className

(

)

const [virtual]

Get class name.

Implements casa::LELInterface< T >.

template<class T >

virtual void casa::LELSpectralIndex< T >::eval	(	LELArray< T > &	result,
		const Slicer &	section
	)		const [virtual]

Recursively evaluate the expression.

Implements casa::LELInterface< T >.

template<class T >

virtual LELScalar<T> casa::LELSpectralIndex< T >::getScalar

(

)

const [virtual]

Get the result of a scalar subexpression.

Throws an exception as it is not possible.

Implements casa::LELInterface< T >.

template<class T >

virtual Bool casa::LELSpectralIndex< T >::hasLock

(

FileLocker::LockType

)

const [virtual]

Reimplemented from casa::LELInterface< T >.

template<class T >

virtual Bool casa::LELSpectralIndex< T >::lock	(	FileLocker::LockType	,
		uInt	nattempts
	)		[virtual]

Handle locking/syncing of a lattice in a lattice expression.

Reimplemented from casa::LELInterface< T >.

template<class T >

virtual Bool casa::LELSpectralIndex< T >::prepareScalarExpr

(

)

[virtual]

Do further preparations (e.g.

optimization) on the expression. Returns False.

Implements casa::LELInterface< T >.

template<class T >

virtual void casa::LELSpectralIndex< T >::resync

(

)

[virtual]

Reimplemented from casa::LELInterface< T >.

template<class T >

virtual void casa::LELSpectralIndex< T >::unlock

(

)

[virtual]

Reimplemented from casa::LELInterface< T >.

---

Member Data Documentation

template<class T >

LatticeExprNode casa::LELSpectralIndex< T >::arg0_p [private]

Definition at line 110 of file LELSpectralIndex.h.

template<class T >

LatticeExprNode casa::LELSpectralIndex< T >::arg1_p [private]

Definition at line 111 of file LELSpectralIndex.h.

template<class T >

Int casa::LELSpectralIndex< T >::itsFreqAxis [private]

Definition at line 108 of file LELSpectralIndex.h.

template<class T >

Block<Double> casa::LELSpectralIndex< T >::itsLogFreq [private]

Definition at line 109 of file LELSpectralIndex.h.

---

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

• casacore/lattices/Lattices/LELSpectralIndex.h