casacore
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
casacore::LELImageCoord Class Reference

The letter class for image coordinates. More...

#include <LELImageCoord.h>

Inheritance diagram for casacore::LELImageCoord:
casacore::LELLattCoord casacore::LELLattCoordBase

Public Member Functions

 LELImageCoord ()
 
 LELImageCoord (const CoordinateSystem &coords, const ImageInfo &imageInfo, const Unit &unit, const RecordInterface &miscInfo)
 
virtual ~LELImageCoord ()
 
const CoordinateSystemcoordinates () const
 Get the coordinates. More...
 
const ImageInfoimageInfo () const
 Get the ImageInfo. More...
 
const Unitunit () const
 Get the brightness unit. More...
 
const TableRecordmiscInfo () const
 Get the MiscInfo. More...
 
virtual LatticeExprNode makeSubLattice (const LatticeExprNode &expr, const LattRegionHolder &region) const
 Create a SubLattice for an expression node. More...
 
virtual LatticeExprNode makeExtendLattice (const LatticeExprNode &expr, const IPosition &newShape, const LELLattCoordBase &newCoord) const
 Create an extension for an expression node. More...
 
virtual LatticeExprNode makeRebinLattice (const LatticeExprNode &expr, const IPosition &binning) const
 Create a rebinning for an expression node. More...
 
virtual Bool hasCoordinates () const
 The class has true coordinates (thus returns True). More...
 
virtual uInt getSpectralInfo (Vector< Double > &worldCoordinates, const IPosition &shape) const
 Get the coordinates of the spectral axis for the given shape. More...
 
virtual String classname () const
 The name of the class. More...
 
virtual Int compare (const LELLattCoordBase &other) const
 Check how the coordinates of this and that compare. More...
 
virtual Int doCompare (const LELImageCoord &other) const
 Check how the coordinates of this and that image compare. More...
 
- Public Member Functions inherited from casacore::LELLattCoord
 LELLattCoord ()
 
virtual ~LELLattCoord ()
 A virtual destructor is needed so that it will use the actual destructor in the derived class. More...
 
- Public Member Functions inherited from casacore::LELLattCoordBase
 LELLattCoordBase ()
 
virtual ~LELLattCoordBase ()
 A virtual destructor is needed so that it will use the actual destructor in the derived class. More...
 

Private Attributes

CountedPtr< CoordinateSystemcoords_p
 
ImageInfo imageInfo_p
 
Unit unit_p
 
TableRecord miscInfo_p
 

Detailed Description

The letter class for image coordinates.

Intended use:

Internal

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Synopsis

This class is a letter class for the envelope class LELCoordinates. It acts as the coordinates class for Lattice objects with proper coordinates (like PagedImage).

Motivation

It must be possible to handle image coordinates in a lattice. expression.

Definition at line 77 of file LELImageCoord.h.

Constructor & Destructor Documentation

casacore::LELImageCoord::LELImageCoord ( )
casacore::LELImageCoord::LELImageCoord ( const CoordinateSystem coords,
const ImageInfo imageInfo,
const Unit unit,
const RecordInterface miscInfo 
)
virtual casacore::LELImageCoord::~LELImageCoord ( )
virtual

Member Function Documentation

virtual String casacore::LELImageCoord::classname ( ) const
virtual

The name of the class.

Reimplemented from casacore::LELLattCoord.

virtual Int casacore::LELImageCoord::compare ( const LELLattCoordBase other) const
virtual

Check how the coordinates of this and that compare.

The return value tells how they compare.
-1: this is subset
0: equal
1: this is superset
9: invalid (mismatch)

Reimplemented from casacore::LELLattCoord.

const CoordinateSystem & casacore::LELImageCoord::coordinates ( ) const
inline

Get the coordinates.

Definition at line 149 of file LELImageCoord.h.

References coords_p.

virtual Int casacore::LELImageCoord::doCompare ( const LELImageCoord other) const
virtual

Check how the coordinates of this and that image compare.

This function is used by conform to make a double virtual dispatch possible.

Reimplemented from casacore::LELLattCoord.

virtual uInt casacore::LELImageCoord::getSpectralInfo ( Vector< Double > &  worldCoordinates,
const IPosition shape 
) const
virtual

Get the coordinates of the spectral axis for the given shape.

It returns the pixel axis number of the spectral coordinates. -1 indicates that there is no pixel spectral axis. An exception is thrown if there are no world spectral coordinates.

Reimplemented from casacore::LELLattCoord.

virtual Bool casacore::LELImageCoord::hasCoordinates ( ) const
virtual

The class has true coordinates (thus returns True).

Reimplemented from casacore::LELLattCoord.

const ImageInfo & casacore::LELImageCoord::imageInfo ( ) const
inline

Get the ImageInfo.

Definition at line 154 of file LELImageCoord.h.

References imageInfo_p.

virtual LatticeExprNode casacore::LELImageCoord::makeExtendLattice ( const LatticeExprNode expr,
const IPosition newShape,
const LELLattCoordBase newCoord 
) const
virtual

Create an extension for an expression node.

Reimplemented from casacore::LELLattCoord.

virtual LatticeExprNode casacore::LELImageCoord::makeRebinLattice ( const LatticeExprNode expr,
const IPosition binning 
) const
virtual

Create a rebinning for an expression node.

Reimplemented from casacore::LELLattCoord.

virtual LatticeExprNode casacore::LELImageCoord::makeSubLattice ( const LatticeExprNode expr,
const LattRegionHolder region 
) const
virtual

Create a SubLattice for an expression node.

Reimplemented from casacore::LELLattCoord.

const TableRecord & casacore::LELImageCoord::miscInfo ( ) const
inline

Get the MiscInfo.

Definition at line 164 of file LELImageCoord.h.

References miscInfo_p.

const Unit & casacore::LELImageCoord::unit ( ) const
inline

Get the brightness unit.

Definition at line 159 of file LELImageCoord.h.

References unit_p.

Member Data Documentation

CountedPtr<CoordinateSystem> casacore::LELImageCoord::coords_p
private

Definition at line 142 of file LELImageCoord.h.

Referenced by coordinates().

ImageInfo casacore::LELImageCoord::imageInfo_p
private

Definition at line 143 of file LELImageCoord.h.

Referenced by imageInfo().

TableRecord casacore::LELImageCoord::miscInfo_p
private

Definition at line 145 of file LELImageCoord.h.

Referenced by miscInfo().

Unit casacore::LELImageCoord::unit_p
private

Definition at line 144 of file LELImageCoord.h.

Referenced by unit().


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