casa::DisplayCoordinateSystem Class Reference

#include <DisplayCoordinateSystem.h>

List of all members.

Public Member Functions
	DisplayCoordinateSystem ()
	DisplayCoordinateSystem (const DisplayCoordinateSystem &o)
	DisplayCoordinateSystem (const CoordinateSystem &c)
virtual	~DisplayCoordinateSystem ()
	operator const CoordinateSystem & () const
const DisplayCoordinateSystem &	operator= (const DisplayCoordinateSystem &o)
const DisplayCoordinateSystem &	operator= (const CoordinateSystem &o)
String	showType (uInt whichCoordinate) const
uInt	nCoordinates () const
unsigned int	nPixelAxes () const
unsigned int	nWorldAxes () const
bool	isDirectionAbscissaLongitude () const
	is the first direction axis RA or Dec.
ObsInfo	obsInfo () const
void	setObsInfo (const ObsInfo &obsinfo)
Vector< String >	worldAxisUnits () const
Vector< String >	worldAxisNames () const
bool	setWorldAxisUnits (const Vector< String > &units)
bool	setWorldAxisNames (const Vector< String > &names)
Vector< int >	worldAxes (uInt whichCoord) const
Vector< int >	pixelAxes (uInt whichCoord) const
Vector< double >	worldMixMin () const
Vector< double >	worldMixMax () const
bool	setWorldMixRanges (const IPosition &shape)
bool	near (const Coordinate &other, Double tol=1e-6) const
bool	near (const Coordinate &other, const Vector< Int > &excludePixelAxes, Double tol=1e-6) const
void	makePixelRelative (Vector< double > &pixel) const
void	makePixelAbsolute (Vector< double > &pixel) const
void	makeWorldAbsolute (Vector< double > &world) const
void	makeWorldRelative (Vector< double > &world) const
Vector< double >	referencePixel () const
bool	setReferencePixel (const Vector< double > &refPix)
Vector< double >	referenceValue () const
bool	setReferenceValue (const Vector< double > &refval)
bool	setIncrement (const Vector< double > &inc)
Coordinate::Type	type (unsigned int whichCoordinate) const
bool	hasDirectionCoordinate () const
const DirectionCoordinate &	directionCoordinate (int which=-1) const
Vector< int >	directionAxesNumbers () const
bool	hasSpectralAxis () const
const SpectralCoordinate &	spectralCoordinate (int which=-1) const
int	spectralAxisNumber (bool doWorld=false) const
const LinearCoordinate &	linearCoordinate (unsigned int which) const
bool	hasPolarizationCoordinate () const
Int	polarizationAxisNumber (Bool doWorld=False) const
const StokesCoordinate &	stokesCoordinate (int which=-1) const
const TabularCoordinate &	tabularCoordinate (unsigned int which) const
const QualityCoordinate &	qualityCoordinate (unsigned int which) const
int	qualityAxisNumber () const
int	worldAxisToPixelAxis (unsigned int worldAxis) const
int	pixelAxisToWorldAxis (unsigned int pixelAxis) const
void	findWorldAxis (int &coordinate, int &axisInCoordinate, unsigned int axisInCoordinateSystem) const
void	findPixelAxis (int &coordinate, int &axisInCoordinate, unsigned int axisInCoordinateSystem) const
const Coordinate &	coordinate (unsigned int which) const
int	findCoordinate (Coordinate::Type type, int afterCoord=-1) const
bool	replaceCoordinate (const Coordinate &newCoordinate, unsigned int whichCoordinate)
void	addCoordinate (const Coordinate &coord)
bool	removeWorldAxis (unsigned int axis, double replacement)
bool	removePixelAxis (unsigned int axis, double replacement)
void	transpose (const Vector< int > &newWorldOrder, const Vector< int > &newPixelOrder)
String	format (String &units, Coordinate::formatType format, double worldValue, unsigned int worldAxis, bool isAbsolute=true, bool showAsAbsolute=true, int precision=-1, bool usePrecForMixed=false) const
const String &	errorMessage () const
	coordinate mapping.
bool	toWorld (Vector< double > &world, const Vector< double > &pixel) const
bool	toPixel (Vector< double > &pixel, const Vector< double > &world) const
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
void	subImageInSitu (const Vector< float > &originShift, const Vector< float > &incrFac, const Vector< int > &newShape)
Vector< double >	increment () const
bool	save (RecordInterface &container, const String &fieldName) const
bool	setRestFrequency (String &errorMsg, const String &unit, const Double &value)
	CoordinateUtil wrappers.
bool	setSpectralState (String &errorMsg, const String &unit, const String &spcquant)
bool	setSpectralConversion (String &errorMsg, const String frequencySystem)
bool	setSpectralFormatting (String &errorMsg, const String &unit, const String &spcquant)
bool	setDirectionUnit (const string &unit, Int which=-1)
void	setNiceAxisLabelUnits ()
bool	setVelocityState (String &errorMsg, const String &unit, const String &spcquant)
bool	removePixelAxes (Vector< Double > &pixelReplacement, const Vector< Int > &pixelAxes, const Bool remove)
bool	removeAxes (Vector< double > &worldReplacement, const Vector< int > &worldAxes, bool remove)
void	worldWidthsToPixel (LogIO &, Vector< double > &dParameters, const Vector< Quantum< Double > > &parameters, const IPosition &pixelAxes, bool doRef=false) const
	from ImageUtilities.
void	match (const DisplayCoordinateSystem &other)
	adjust this coordinate system to match the 'other' coordinate system
Vector< int >	transposeShape (const Vector< int > &original_shape, bool world=true)
Static Public Member Functions
static DisplayCoordinateSystem	restore (const RecordInterface &container, const String &fieldName)
Private Types
typedef vector< pair< Vector < int >, Vector< int > > >	transposition_log_t
Private Attributes
CoordinateSystem	cs_
transposition_log_t	transposition_log

---

Detailed Description

Definition at line 38 of file DisplayCoordinateSystem.h.

---

Member Typedef Documentation

typedef vector<pair<Vector<int>,Vector<int> > > casa::DisplayCoordinateSystem::transposition_log_t [private]

Definition at line 230 of file DisplayCoordinateSystem.h.

---

Constructor & Destructor Documentation

casa::DisplayCoordinateSystem::DisplayCoordinateSystem

(

)

[inline]

Definition at line 41 of file DisplayCoordinateSystem.h.

casa::DisplayCoordinateSystem::DisplayCoordinateSystem

(

const DisplayCoordinateSystem &

o

)

[inline]

Definition at line 42 of file DisplayCoordinateSystem.h.

casa::DisplayCoordinateSystem::DisplayCoordinateSystem

(

const CoordinateSystem &

c

)

[inline]

Definition at line 44 of file DisplayCoordinateSystem.h.

virtual casa::DisplayCoordinateSystem::~DisplayCoordinateSystem

(

)

[virtual]

---

Member Function Documentation

void casa::DisplayCoordinateSystem::addCoordinate

(

const Coordinate &

coord

)

[inline]

Definition at line 159 of file DisplayCoordinateSystem.h.

References cs_.

const Coordinate& casa::DisplayCoordinateSystem::coordinate

(

unsigned int

which

)

const [inline]

Definition at line 152 of file DisplayCoordinateSystem.h.

References cs_.

Vector<int> casa::DisplayCoordinateSystem::directionAxesNumbers

(

)

const

const DirectionCoordinate& casa::DisplayCoordinateSystem::directionCoordinate

(

int

which = -1

)

const [inline]

Definition at line 115 of file DisplayCoordinateSystem.h.

References cs_.

const String& casa::DisplayCoordinateSystem::errorMessage

(

)

const [inline]

coordinate mapping.

.\.

Definition at line 171 of file DisplayCoordinateSystem.h.

References cs_.

int casa::DisplayCoordinateSystem::findCoordinate	(	Coordinate::Type	type,
		int	afterCoord = -1
	)			const [inline]

Definition at line 154 of file DisplayCoordinateSystem.h.

References cs_.

void casa::DisplayCoordinateSystem::findPixelAxis	(	int &	coordinate,
		int &	axisInCoordinate,
		unsigned int	axisInCoordinateSystem
	)			const [inline]

Definition at line 149 of file DisplayCoordinateSystem.h.

References cs_.

void casa::DisplayCoordinateSystem::findWorldAxis	(	int &	coordinate,
		int &	axisInCoordinate,
		unsigned int	axisInCoordinateSystem
	)			const [inline]

Definition at line 147 of file DisplayCoordinateSystem.h.

References cs_.

String casa::DisplayCoordinateSystem::format	(	String &	units,
		Coordinate::formatType	format,
		double	worldValue,
		unsigned int	worldAxis,
		bool	isAbsolute = true,
		bool	showAsAbsolute = true,
		int	precision = -1,
		bool	usePrecForMixed = false
	)			const

bool casa::DisplayCoordinateSystem::hasDirectionCoordinate

(

)

const [inline]

Definition at line 114 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::hasPolarizationCoordinate

(

)

const [inline]

Definition at line 126 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::hasSpectralAxis

(

)

const [inline]

Definition at line 119 of file DisplayCoordinateSystem.h.

References cs_.

Vector<double> casa::DisplayCoordinateSystem::increment

(

)

const [inline]

Definition at line 189 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::isDirectionAbscissaLongitude

(

)

const [inline]

is the first direction axis RA or Dec.

.\.

Definition at line 68 of file DisplayCoordinateSystem.h.

References cs_.

const LinearCoordinate& casa::DisplayCoordinateSystem::linearCoordinate

(

unsigned int

which

)

const [inline]

Definition at line 124 of file DisplayCoordinateSystem.h.

References cs_.

void casa::DisplayCoordinateSystem::makePixelAbsolute

(

Vector< double > &

pixel

)

const

void casa::DisplayCoordinateSystem::makePixelRelative

(

Vector< double > &

pixel

)

const

void casa::DisplayCoordinateSystem::makeWorldAbsolute

(

Vector< double > &

world

)

const

void casa::DisplayCoordinateSystem::makeWorldRelative

(

Vector< double > &

world

)

const

void casa::DisplayCoordinateSystem::match

(

const DisplayCoordinateSystem &

other

)

adjust this coordinate system to match the 'other' coordinate system

uInt casa::DisplayCoordinateSystem::nCoordinates

(

)

const [inline]

Definition at line 63 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::near	(	const Coordinate &	other,
		const Vector< Int > &	excludePixelAxes,
		Double	tol = 1e-6
	)			const [inline]

Definition at line 92 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::near	(	const Coordinate &	other,
		Double	tol = 1e-6
	)			const [inline]

Definition at line 90 of file DisplayCoordinateSystem.h.

References cs_.

unsigned int casa::DisplayCoordinateSystem::nPixelAxes

(

)

const [inline]

Definition at line 64 of file DisplayCoordinateSystem.h.

References cs_.

unsigned int casa::DisplayCoordinateSystem::nWorldAxes

(

)

const [inline]

Definition at line 65 of file DisplayCoordinateSystem.h.

References cs_.

ObsInfo casa::DisplayCoordinateSystem::obsInfo

(

)

const [inline]

Definition at line 71 of file DisplayCoordinateSystem.h.

References cs_.

casa::DisplayCoordinateSystem::operator const CoordinateSystem &

(

)

const [inline]

Definition at line 47 of file DisplayCoordinateSystem.h.

References cs_.

const DisplayCoordinateSystem& casa::DisplayCoordinateSystem::operator=

(

const CoordinateSystem &

o

)

[inline]

Definition at line 54 of file DisplayCoordinateSystem.h.

References cs_, and transposition_log.

const DisplayCoordinateSystem& casa::DisplayCoordinateSystem::operator=

(

const DisplayCoordinateSystem &

o

)

[inline]

Definition at line 49 of file DisplayCoordinateSystem.h.

References cs_, and transposition_log.

Vector<int> casa::DisplayCoordinateSystem::pixelAxes

(

uInt

whichCoord

)

const

int casa::DisplayCoordinateSystem::pixelAxisToWorldAxis

(

unsigned int

pixelAxis

)

const [inline]

Definition at line 144 of file DisplayCoordinateSystem.h.

References cs_.

Int casa::DisplayCoordinateSystem::polarizationAxisNumber

(

Bool

doWorld = False

)

const [inline]

Definition at line 128 of file DisplayCoordinateSystem.h.

References cs_.

int casa::DisplayCoordinateSystem::qualityAxisNumber

(

)

const [inline]

Definition at line 139 of file DisplayCoordinateSystem.h.

References cs_.

const QualityCoordinate& casa::DisplayCoordinateSystem::qualityCoordinate

(

unsigned int

which

)

const [inline]

Definition at line 137 of file DisplayCoordinateSystem.h.

References cs_.

Vector<double> casa::DisplayCoordinateSystem::referencePixel

(

)

const [inline]

Definition at line 100 of file DisplayCoordinateSystem.h.

References cs_.

Vector<double> casa::DisplayCoordinateSystem::referenceValue

(

)

const [inline]

Definition at line 104 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::removeAxes	(	Vector< double > &	worldReplacement,
		const Vector< int > &	worldAxes,
		bool	remove
	)			[inline]

Definition at line 213 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::removePixelAxes	(	Vector< Double > &	pixelReplacement,
		const Vector< Int > &	pixelAxes,
		const Bool	remove
	)			[inline]

Definition at line 211 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::removePixelAxis	(	unsigned int	axis,
		double	replacement
	)			[inline]

Definition at line 163 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::removeWorldAxis	(	unsigned int	axis,
		double	replacement
	)			[inline]

Definition at line 161 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::replaceCoordinate	(	const Coordinate &	newCoordinate,
		unsigned int	whichCoordinate
	)			[inline]

Definition at line 156 of file DisplayCoordinateSystem.h.

References cs_.

static DisplayCoordinateSystem casa::DisplayCoordinateSystem::restore	(	const RecordInterface &	container,
		const String &	fieldName
	)			[static]

bool casa::DisplayCoordinateSystem::save	(	RecordInterface &	container,
		const String &	fieldName
	)			const [inline]

Definition at line 192 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::setDirectionUnit	(	const string &	unit,
		Int	which = -1
	)			[inline]

Definition at line 205 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::setIncrement

(

const Vector< double > &

inc

)

[inline]

Definition at line 108 of file DisplayCoordinateSystem.h.

References cs_.

void casa::DisplayCoordinateSystem::setNiceAxisLabelUnits

(

)

[inline]

Definition at line 207 of file DisplayCoordinateSystem.h.

References cs_.

void casa::DisplayCoordinateSystem::setObsInfo

(

const ObsInfo &

obsinfo

)

[inline]

Definition at line 73 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::setReferencePixel

(

const Vector< double > &

refPix

)

[inline]

Definition at line 102 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::setReferenceValue

(

const Vector< double > &

refval

)

[inline]

Definition at line 106 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::setRestFrequency	(	String &	errorMsg,
		const String &	unit,
		const Double &	value
	)			[inline]

CoordinateUtil wrappers.

.\.

Definition at line 197 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::setSpectralConversion	(	String &	errorMsg,
		const String	frequencySystem
	)			[inline]

Definition at line 201 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::setSpectralFormatting	(	String &	errorMsg,
		const String &	unit,
		const String &	spcquant
	)			[inline]

Definition at line 203 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::setSpectralState	(	String &	errorMsg,
		const String &	unit,
		const String &	spcquant
	)			[inline]

Definition at line 199 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::setVelocityState	(	String &	errorMsg,
		const String &	unit,
		const String &	spcquant
	)			[inline]

Definition at line 209 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::setWorldAxisNames

(

const Vector< String > &

names

)

bool casa::DisplayCoordinateSystem::setWorldAxisUnits

(

const Vector< String > &

units

)

bool casa::DisplayCoordinateSystem::setWorldMixRanges

(

const IPosition &

shape

)

[inline]

Definition at line 87 of file DisplayCoordinateSystem.h.

References cs_.

String casa::DisplayCoordinateSystem::showType

(

uInt

whichCoordinate

)

const [inline]

Definition at line 60 of file DisplayCoordinateSystem.h.

References cs_.

int casa::DisplayCoordinateSystem::spectralAxisNumber

(

bool

doWorld = false

)

const [inline]

Definition at line 122 of file DisplayCoordinateSystem.h.

References cs_.

Referenced by casa::viewer::ImageProperties::spectralAxisNumber().

const SpectralCoordinate& casa::DisplayCoordinateSystem::spectralCoordinate

(

int

which = -1

)

const [inline]

Definition at line 120 of file DisplayCoordinateSystem.h.

References cs_.

const StokesCoordinate& casa::DisplayCoordinateSystem::stokesCoordinate

(

int

which = -1

)

const [inline]

Definition at line 131 of file DisplayCoordinateSystem.h.

References cs_.

void casa::DisplayCoordinateSystem::subImageInSitu	(	const Vector< float > &	originShift,
		const Vector< float > &	incrFac,
		const Vector< int > &	newShape
	)			[inline]

Definition at line 185 of file DisplayCoordinateSystem.h.

References cs_.

const TabularCoordinate& casa::DisplayCoordinateSystem::tabularCoordinate

(

unsigned int

which

)

const [inline]

Definition at line 134 of file DisplayCoordinateSystem.h.

References cs_.

bool casa::DisplayCoordinateSystem::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

bool casa::DisplayCoordinateSystem::toPixel	(	Vector< double > &	pixel,
		const Vector< double > &	world
	)			const

bool casa::DisplayCoordinateSystem::toWorld	(	Vector< double > &	world,
		const Vector< double > &	pixel
	)			const

void casa::DisplayCoordinateSystem::transpose	(	const Vector< int > &	newWorldOrder,
		const Vector< int > &	newPixelOrder
	)

Vector<int> casa::DisplayCoordinateSystem::transposeShape	(	const Vector< int > &	original_shape,
		bool	world = true
	)

Coordinate::Type casa::DisplayCoordinateSystem::type

(

unsigned int

whichCoordinate

)

const [inline]

Definition at line 112 of file DisplayCoordinateSystem.h.

References cs_.

Vector<int> casa::DisplayCoordinateSystem::worldAxes

(

uInt

whichCoord

)

const

Vector<String> casa::DisplayCoordinateSystem::worldAxisNames

(

)

const

int casa::DisplayCoordinateSystem::worldAxisToPixelAxis

(

unsigned int

worldAxis

)

const [inline]

Definition at line 142 of file DisplayCoordinateSystem.h.

References cs_.

Vector<String> casa::DisplayCoordinateSystem::worldAxisUnits

(

)

const

Vector<double> casa::DisplayCoordinateSystem::worldMixMax

(

)

const [inline]

Definition at line 85 of file DisplayCoordinateSystem.h.

References cs_.

Vector<double> casa::DisplayCoordinateSystem::worldMixMin

(

)

const [inline]

Definition at line 83 of file DisplayCoordinateSystem.h.

References cs_.

void casa::DisplayCoordinateSystem::worldWidthsToPixel	(	LogIO &	,
		Vector< double > &	dParameters,
		const Vector< Quantum< Double > > &	parameters,
		const IPosition &	pixelAxes,
		bool	doRef = false
	)			const [inline]

from ImageUtilities.

.\.

Definition at line 219 of file DisplayCoordinateSystem.h.

References cs_.

---

Member Data Documentation

CoordinateSystem casa::DisplayCoordinateSystem::cs_ [private]

Definition at line 229 of file DisplayCoordinateSystem.h.

Referenced by addCoordinate(), coordinate(), directionCoordinate(), errorMessage(), findCoordinate(), findPixelAxis(), findWorldAxis(), hasDirectionCoordinate(), hasPolarizationCoordinate(), hasSpectralAxis(), increment(), isDirectionAbscissaLongitude(), linearCoordinate(), nCoordinates(), near(), nPixelAxes(), nWorldAxes(), obsInfo(), operator const CoordinateSystem &(), operator=(), pixelAxisToWorldAxis(), polarizationAxisNumber(), qualityAxisNumber(), qualityCoordinate(), referencePixel(), referenceValue(), removeAxes(), removePixelAxes(), removePixelAxis(), removeWorldAxis(), replaceCoordinate(), save(), setDirectionUnit(), setIncrement(), setNiceAxisLabelUnits(), setObsInfo(), setReferencePixel(), setReferenceValue(), setRestFrequency(), setSpectralConversion(), setSpectralFormatting(), setSpectralState(), setVelocityState(), setWorldMixRanges(), showType(), spectralAxisNumber(), spectralCoordinate(), stokesCoordinate(), subImageInSitu(), tabularCoordinate(), type(), worldAxisToPixelAxis(), worldMixMax(), worldMixMin(), and worldWidthsToPixel().

transposition_log_t casa::DisplayCoordinateSystem::transposition_log [private]

Definition at line 231 of file DisplayCoordinateSystem.h.

Referenced by operator=().

---

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

• code/display/Display/DisplayCoordinateSystem.h