casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Attributes
casa::LELImageCoord Class Reference

The letter class for image coordinates. More...

#include <LELImageCoord.h>

Inheritance diagram for casa::LELImageCoord:
casa::LELLattCoord casa::LELLattCoordBase

List of all members.

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.
const ImageInfoimageInfo () const
 Get the ImageInfo.
const Unitunit () const
 Get the brightness unit.
const TableRecordmiscInfo () const
 Get the MiscInfo.
virtual LatticeExprNode makeSubLattice (const LatticeExprNode &expr, const LattRegionHolder &region) const
 Create a SubLattice for an expression node.
virtual LatticeExprNode makeExtendLattice (const LatticeExprNode &expr, const IPosition &newShape, const LELLattCoordBase &newCoord) const
 Create an extension for an expression node.
virtual LatticeExprNode makeRebinLattice (const LatticeExprNode &expr, const IPosition &binning) const
 Create a rebinning for an expression node.
virtual Bool hasCoordinates () const
 The class has true coordinates (thus returns True).
virtual uInt getSpectralInfo (Vector< Double > &worldCoordinates, const IPosition &shape) const
 Get the coordinates of the spectral axis for the given shape.
virtual String classname () const
 The name of the class.
virtual Int compare (const LELLattCoordBase &other) const
 Check how the coordinates of this and that compare.
virtual Int doCompare (const LELImageCoord &other) const
 Check how the coordinates of this and that image compare.

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 76 of file LELImageCoord.h.


Constructor & Destructor Documentation

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

Member Function Documentation

virtual String casa::LELImageCoord::classname ( ) const [virtual]

The name of the class.

Reimplemented from casa::LELLattCoord.

virtual Int casa::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 casa::LELLattCoord.

Get the coordinates.

Definition at line 148 of file LELImageCoord.h.

References coords_p.

virtual Int casa::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 casa::LELLattCoord.

virtual uInt casa::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 casa::LELLattCoord.

virtual Bool casa::LELImageCoord::hasCoordinates ( ) const [virtual]

The class has true coordinates (thus returns True).

Reimplemented from casa::LELLattCoord.

const ImageInfo & casa::LELImageCoord::imageInfo ( ) const [inline]

Get the ImageInfo.

Definition at line 153 of file LELImageCoord.h.

References imageInfo_p.

virtual LatticeExprNode casa::LELImageCoord::makeExtendLattice ( const LatticeExprNode expr,
const IPosition newShape,
const LELLattCoordBase newCoord 
) const [virtual]

Create an extension for an expression node.

Reimplemented from casa::LELLattCoord.

virtual LatticeExprNode casa::LELImageCoord::makeRebinLattice ( const LatticeExprNode expr,
const IPosition binning 
) const [virtual]

Create a rebinning for an expression node.

Reimplemented from casa::LELLattCoord.

virtual LatticeExprNode casa::LELImageCoord::makeSubLattice ( const LatticeExprNode expr,
const LattRegionHolder region 
) const [virtual]

Create a SubLattice for an expression node.

Reimplemented from casa::LELLattCoord.

const TableRecord & casa::LELImageCoord::miscInfo ( ) const [inline]

Get the MiscInfo.

Definition at line 163 of file LELImageCoord.h.

References miscInfo_p.

const Unit & casa::LELImageCoord::unit ( ) const [inline]

Get the brightness unit.

Definition at line 158 of file LELImageCoord.h.

References unit_p.


Member Data Documentation

Definition at line 141 of file LELImageCoord.h.

Referenced by coordinates().

Definition at line 142 of file LELImageCoord.h.

Referenced by imageInfo().

Definition at line 144 of file LELImageCoord.h.

Referenced by miscInfo().

Definition at line 143 of file LELImageCoord.h.

Referenced by unit().


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