casacore: casa::Coordinate Class Reference

Interface for converting between world and pixel coordinates. More...

#include <Coordinate.h>

Inheritance diagram for casa::Coordinate:

Public Types
enum	Type { LINEAR, DIRECTION, SPECTRAL, STOKES, TABULAR, COORDSYS }
	This enum lists the types of the derived classes. More...
enum	formatType { DEFAULT, SCIENTIFIC, FIXED, MIXED, TIME }
	This enum is used for formatting world values into Strings. More...
Public Member Functions
virtual	~Coordinate ()
	Destructor.
virtual Type	type () const =0
	List the type of this Coordinate object.
virtual String	showType () const =0
virtual uInt	nPixelAxes () const =0
	How many world/pixel axes are there in this Coordinate? While the number of world and pixel axes will generally be the same, it is not a requirement.
virtual uInt	nWorldAxes () const =0
virtual Bool	toWorld (Vector< Double > &world, const Vector< Double > &pixel) const =0
	Convert an absolute pixel position to an absolute world position or vice versa.
virtual Bool	toPixel (Vector< Double > &pixel, const Vector< Double > &world) const =0
virtual Bool	toMix (Vector< Double > &worldOut, Vector< Double > &pixelOut, const Vector< Double > &worldIn, const Vector< Double > &pixelIn, const Vector< Bool > &worldAxes, const Vector< Bool > &pixelAxes, const Vector< Double > &worldMin, const Vector< Double > &worldMax) const
	Mixed absolute pixel/world coordinate conversion.
virtual Bool	setWorldMixRanges (const IPosition &shape)
	Set the world min and max ranges, for use in function `toMix`, for a lattice of the given shape for this coordinate.
virtual void	setDefaultWorldMixRanges ()
Vector< Double >	worldMixMin () const
Vector< Double >	worldMixMax () const
virtual Bool	toWorldMany (Matrix< Double > &world, const Matrix< Double > &pixel, Vector< Bool > &failures) const
	Batch up a lot of transformations.
virtual Bool	toPixelMany (Matrix< Double > &pixel, const Matrix< Double > &world, Vector< Bool > &failures) const
virtual void	makePixelRelative (Vector< Double > &pixel) const
	Make absolute coordinates relative and vice-versa (with respect to the reference value).
virtual void	makePixelAbsolute (Vector< Double > &pixel) const
virtual void	makeWorldRelative (Vector< Double > &world) const
virtual void	makeWorldAbsolute (Vector< Double > &world) const
virtual void	makeWorldAbsoluteRef (Vector< Double > &world, const Vector< Double > &refVal) const
	Make absolute coordinates relative and vice versa with respect to the given reference value.
virtual void	makePixelRelativeMany (Matrix< Double > &pixel) const
	Batch up a lot of absolute/relative transformations.
virtual void	makePixelAbsoluteMany (Matrix< Double > &pixel) const
virtual void	makeWorldRelativeMany (Matrix< Double > &world) const
virtual void	makeWorldAbsoluteMany (Matrix< Double > &world) const
virtual Vector< String >	worldAxisNames () const =0
	Return the requested attributed.
virtual Vector< Double >	referencePixel () const =0
virtual Matrix< Double >	linearTransform () const =0
virtual Vector< Double >	increment () const =0
virtual Vector< Double >	referenceValue () const =0
virtual Vector< String >	worldAxisUnits () const =0
virtual Bool	setWorldAxisNames (const Vector< String > &names)=0
	Set the requested attribute.
virtual Bool	setReferencePixel (const Vector< Double > &refPix)=0
virtual Bool	setLinearTransform (const Matrix< Double > &xform)=0
virtual Bool	setIncrement (const Vector< Double > &inc)=0
virtual Bool	setReferenceValue (const Vector< Double > &refval)=0
virtual Bool	setWorldAxisUnits (const Vector< String > &units)=0
	Change the units.
virtual Coordinate *	makeFourierCoordinate (const Vector< Bool > &axes, const Vector< Int > &shape) const
	Find the Coordinate for when we Fourier Transform ourselves.
const String &	errorMessage () const
	If the last conversion to world or pixel coordinates resulted in an error, report that error.
virtual Bool	near (const Coordinate &other, Double tol=1.0e-6) const =0
	Comparison to fractional tolerance (for floating point values).
virtual Bool	near (const Coordinate &other, const Vector< Int > &excludeAxes, Double tol=1.0e-6) const =0
virtual void	getPrecision (Int &precision, Coordinate::formatType &format, Bool showAsAbsolute, Int defPrecScientific, Int defPrecFixed, Int defPrecTime) const
	Provide a common interface to getting formatted representations of coordinate values.
virtual String	format (String &units, Coordinate::formatType format, Double worldValue, uInt axis, Bool isAbsolute=True, Bool showAsAbsolute=True, Int precision=-1)
String	formatQuantity (String &units, Coordinate::formatType format, const Quantum<

casa::Coordinate Class Reference [Coordinates_module]

Public Types

Public Member Functions

casa::Coordinate Class Reference
[Coordinates_module]