Loading...
Searching...
No Matches
LELSpectralIndex.h
Go to the documentation of this file.
//# LELSpectralIndex.h: LEL function to calculate spectral index/
//# Copyright (C) 2001
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef LATTICES_LELSPECTRALINDEX_H
#define LATTICES_LELSPECTRALINDEX_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/lattices/LEL/LELFunction.h>
#include <casacore/casa/Containers/Block.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
// <summary>
// This LEL class handles calculation of the spectral index.
// </summary>
// <use visibility=local>
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class="Lattice"> Lattice</linkto>
// <li> <linkto class="LatticeExpr"> LatticeExpr</linkto>
// <li> <linkto class="LatticeExprNode"> LatticeExprNode</linkto>
// <li> <linkto class="LELInterface"> LELInterface</linkto>
// <li> <linkto class="LELFunctionEnums"> LELFunctionEnums</linkto>
// </prerequisite>
// <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)
// </synopsis>
// <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.
// </motivation>
template<class T> class LELSpectralIndex : public LELInterface<T>
{
//# Make members of parent class known.
protected:
using LELInterface<T>::setAttr;
public:
// Constructor takes operation and expressions to be operated upon
LELSpectralIndex (const Block<LatticeExprNode>& expr);
// Destructor
~LELSpectralIndex();
// Recursively evaluate the expression
virtual void eval (LELArray<T>& result,
const Slicer& section) const;
// Get the result of a scalar subexpression.
// Throws an exception as it is not possible.
virtual LELScalar<T> getScalar() const;
// Do further preparations (e.g. optimization) on the expression.
// Returns False.
virtual Bool prepareScalarExpr();
// Get class name
virtual String className() const;
// Handle locking/syncing of a lattice in a lattice expression.
// <group>
virtual Bool lock (FileLocker::LockType, uInt nattempts);
virtual void unlock();
virtual Bool hasLock (FileLocker::LockType) const;
virtual void resync();
// </group>
private:
Int itsFreqAxis;
Block<Double> itsLogFreq; //# log(f0/f1)
LatticeExprNode arg0_p;
LatticeExprNode arg1_p;
};
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/lattices/LEL/LELSpectralIndex.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
casacore::Block
Definition Block.h:140
casacore::FileLocker::LockType
LockType
Define the possible lock types.
Definition FileLocker.h:93
casacore::LELArray
Definition LELArray.h:61
casacore::LELInterface
Definition LELInterface.h:149
casacore::LELInterface::setAttr
void setAttr(const LELAttribute &attrib)
Set the expression attributes of this object.
casacore::LELScalar
Definition LELScalar.h:58
casacore::LELSpectralIndex::arg0_p
LatticeExprNode arg0_p
Definition LELSpectralIndex.h:109
casacore::LELSpectralIndex::className
virtual String className() const
Get class name.
casacore::LELSpectralIndex::eval
virtual void eval(LELArray< T > &result, const Slicer &section) const
Recursively evaluate the expression.
casacore::LELSpectralIndex::~LELSpectralIndex
~LELSpectralIndex()
Destructor.
casacore::LELSpectralIndex::unlock
virtual void unlock()
casacore::LELSpectralIndex::prepareScalarExpr
virtual Bool prepareScalarExpr()
Do further preparations (e.g.
casacore::LELSpectralIndex::itsFreqAxis
Int itsFreqAxis
Definition LELSpectralIndex.h:107
casacore::LELSpectralIndex::resync
virtual void resync()
casacore::LELSpectralIndex::lock
virtual Bool lock(FileLocker::LockType, uInt nattempts)
Handle locking/syncing of a lattice in a lattice expression.
casacore::LELSpectralIndex::hasLock
virtual Bool hasLock(FileLocker::LockType) const
casacore::LELSpectralIndex::LELSpectralIndex
LELSpectralIndex(const Block< LatticeExprNode > &expr)
Constructor takes operation and expressions to be operated upon.
casacore::LELSpectralIndex::itsLogFreq
Block< Double > itsLogFreq
Definition LELSpectralIndex.h:108
casacore::LELSpectralIndex::arg1_p
LatticeExprNode arg1_p
Definition LELSpectralIndex.h:110
casacore::LELSpectralIndex::getScalar
virtual LELScalar< T > getScalar() const
Get the result of a scalar subexpression.
casacore::LatticeExprNode
Definition LatticeExprNode.h:439
casacore::Slicer
Definition Slicer.h:287
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::uInt
unsigned int uInt
Definition aipstype.h:49
casacore::Int
int Int
Definition aipstype.h:48
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40