casa::Util Class Reference

#include <Util.h>

Static Public Member Functions
static void	showUserMessage (QString &msg, QWidget *parent)
static double	degMinSecToRadians (int degrees, int mins, float secs)
static double	hrMinSecToRadians (int hours, int mins, float secs)
static QString	toHTML (const QString &baseStr)
static int	getCenter (const Vector< Double > &values, Double &mean)
static void	getRa (double radians, int &raHour, int &raMin, double &raSec)
static void	getDec (double radians, int &decDeg, int &decMin, double &decSec)
static void	minMax (double &min, double &max, const Vector< Double > &values)
static QString	toDegreeString (int hrs, int mins, double secs)
static QString	toDecString (int hrs, int mins, double secs)
static void	appendSign (double rad, QString &degreeString)
static QList< QString >	getTitleCaseVariations (QString source)
static QString	toTitleCase (QString word)
static String	mainImageName (String path)
static QString	stripBrackets (QString unitStr)
	Designed to take an input string of the format '[km/s]' and return 'km/s'.
static QString	stripFont (QString unitStr)
	Designed to take an input string of the format <font color="black">km/s</font>' and return 'km/s'.
static int	getTabularFrequencyAxisIndex (SHARED_PTR< const ImageInterface< Float > > img)
	Support for tabular axes that are frequency.
static Record	getRegionRecord (String shape, const DisplayCoordinateSystem &cSys, const Vector< Double > &x, const Vector< Double > &y)
static std::pair< Vector < Float >, Vector< Float > >	getProfile (SHARED_PTR< const casa::ImageInterface< Float > > &imagePtr, const Vector< Double > &x, const Vector< Double > &y, const String &shape, int tabularAxis, ImageCollapserData::AggregateType, String unit, const String &coordinateType, const Quantity *const restFreq=0, const String &frame="")
static Record	getEllipticalRegion3D (const DisplayCoordinateSystem &cSys, const Vector< Double > &x, const Vector< Double > &y, int channelMin, int channelMax, int spectralAxisNumber)
	Returns the record of a 3-dimension region with the base in the shape of an ellipse and height given by the channel range.
static Record	getPolygonalRegion3D (const DisplayCoordinateSystem &cSys, const Vector< Double > &x, const Vector< Double > &y, int channelMin, int channelMax, int spectralAxisNumber)
	Returns the record of a 3-dimension region with the base in the shape of a polygon and height given by the channel range.
static ImageRegion *	getEllipsoid (const DisplayCoordinateSystem &cSys, const Vector< Double > &x, const Vector< Double > &y)
	Return a 2D region in the shape of an ellipse.
static ImageRegion *	getPolygon (const DisplayCoordinateSystem &cSys, const Vector< Double > &x, const Vector< Double > &y)
	Return a 2D region in the shape of a polygon.
static bool	arrayEquals (const Vector< Double > &a, const Vector< Double > &b)
	Tests whether the contents of the two arrays are the same.
Static Public Attributes
static const QString	ORGANIZATION
static const QString	APPLICATION
Private Member Functions
	Util ()
virtual	~Util ()
Static Private Member Functions
static double	toRadians (double degrees)
static double	toDecimalDegrees (int hrs, int mins, float seconds)
static Record	make3DRegion (const DisplayCoordinateSystem &cSys, ImageRegion *shape3D, int channelMin, int channelMax, int spectralAxisNumber)
Static Private Attributes
static const double	PI
static const double	TIME_CONV
static const double	RAD_DEGREE_CONVERSION

Detailed Description

Definition at line 41 of file Util.h.

Constructor & Destructor Documentation

casa::Util::Util ( ) [private]

virtual casa::Util::~Util ( ) [private, virtual]

Member Function Documentation

static void casa::Util::appendSign	(	double	rad,
		QString &	degreeString
	)			`[static]`

static bool casa::Util::arrayEquals	(	const Vector< Double > &	a,
		const Vector< Double > &	b
	)			`[static]`

Tests whether the contents of the two arrays are the same.

Returns true if the arrays have the same size and contents; false otherwise.

static double casa::Util::degMinSecToRadians	(	int	degrees,
		int	mins,
		float	secs
	)			`[static]`

static int casa::Util::getCenter	(	const Vector< Double > &	values,
		Double &	mean
	)			`[static]`

static void casa::Util::getDec	(	double	radians,
		int &	decDeg,
		int &	decMin,
		double &	decSec
	)			`[static]`

static ImageRegion* casa::Util::getEllipsoid	(	const DisplayCoordinateSystem &	cSys,
		const Vector< Double > &	x,
		const Vector< Double > &	y
	)			`[static]`

Return a 2D region in the shape of an ellipse.

Parameters:

	cSys	the image coordinate system.
	x	the x-coordinates of the ellipse bounding box.
	y	the y-coordinates of the ellipse bounding box.

Returns:: the 2D image region of the ellipse.

static Record casa::Util::getEllipticalRegion3D	(	const DisplayCoordinateSystem &	cSys,
		const Vector< Double > &	x,
		const Vector< Double > &	y,
		int	channelMin,
		int	channelMax,
		int	spectralAxisNumber
	)			`[static]`

Returns the record of a 3-dimension region with the base in the shape of an ellipse and height given by the channel range.

Parameters:

	cSys	the image coordinate system.
	x	the x-coordinates of the ellipse bounding box.
	y	the y-coordinates of the ellipse bounding box.

Returns:: a Record describing cylindrical volume with a elliptical base.

static ImageRegion* casa::Util::getPolygon	(	const DisplayCoordinateSystem &	cSys,
		const Vector< Double > &	x,
		const Vector< Double > &	y
	)			`[static]`

Return a 2D region in the shape of a polygon.

Parameters:

	cSys	the image coordinate system.
	x	the x-coordinates of the polygon corner points.
	y	the y-coordinates of the polygon corner points.

Returns:: the 2D image region of the polygon.

static Record casa::Util::getPolygonalRegion3D	(	const DisplayCoordinateSystem &	cSys,
		const Vector< Double > &	x,
		const Vector< Double > &	y,
		int	channelMin,
		int	channelMax,
		int	spectralAxisNumber
	)			`[static]`

Returns the record of a 3-dimension region with the base in the shape of a polygon and height given by the channel range.

Parameters:

	cSys	the image coordinate system.
	x	the x-coordinates of the polygon corner points.
	y	the y-coordinates of the polygon corner points.

Returns:: a Record describing cylindrical volume with a polygonal base.

static std::pair<Vector<Float>,Vector<Float> > casa::Util::getProfile	(	SHARED_PTR< const casa::ImageInterface< Float > > &	imagePtr,
		const Vector< Double > &	x,
		const Vector< Double > &	y,
		const String &	shape,
		int	tabularAxis,
		ImageCollapserData::AggregateType	,
		String	unit,
		const String &	coordinateType,
		const Quantity *const	restFreq = `0`,
		const String &	frame = `""`
	)			`[static]`

static void casa::Util::getRa	(	double	radians,
		int &	raHour,
		int &	raMin,
		double &	raSec
	)			`[static]`

static Record casa::Util::getRegionRecord	(	String	shape,
		const DisplayCoordinateSystem &	cSys,
		const Vector< Double > &	x,
		const Vector< Double > &	y
	)			`[static]`

static int casa::Util::getTabularFrequencyAxisIndex ( SHARED_PTR< const ImageInterface< Float > > img ) [static]

Support for tabular axes that are frequency.

Returns -1 if there is no tabular index in the image in frequency units.

static QList<QString> casa::Util::getTitleCaseVariations ( QString source ) [static]

static double casa::Util::hrMinSecToRadians	(	int	hours,
		int	mins,
		float	secs
	)			`[static]`

static String casa::Util::mainImageName ( String path ) [static]

static Record casa::Util::make3DRegion	(	const DisplayCoordinateSystem &	cSys,
		ImageRegion *	shape3D,
		int	channelMin,
		int	channelMax,
		int	spectralAxisNumber
	)			`[static, private]`

static void casa::Util::minMax	(	double &	min,
		double &	max,
		const Vector< Double > &	values
	)			`[static]`

static void casa::Util::showUserMessage	(	QString &	msg,
		QWidget *	parent
	)			`[static]`

static QString casa::Util::stripBrackets ( QString unitStr ) [static]

Designed to take an input string of the format '[km/s]' and return 'km/s'.

static QString casa::Util::stripFont ( QString unitStr ) [static]

Designed to take an input string of the format <font color="black">km/s</font>' and return 'km/s'.

static double casa::Util::toDecimalDegrees	(	int	hrs,
		int	mins,
		float	seconds
	)			`[static, private]`

static QString casa::Util::toDecString	(	int	hrs,
		int	mins,
		double	secs
	)			`[static]`

static QString casa::Util::toDegreeString	(	int	hrs,
		int	mins,
		double	secs
	)			`[static]`

static QString casa::Util::toHTML ( const QString & baseStr ) [static]

static double casa::Util::toRadians ( double degrees ) [static, private]

static QString casa::Util::toTitleCase ( QString word ) [static]

Member Data Documentation

const QString casa::Util::APPLICATION [static]

Definition at line 46 of file Util.h.

const QString casa::Util::ORGANIZATION [static]

Definition at line 45 of file Util.h.

const double casa::Util::PI [static, private]

Definition at line 142 of file Util.h.

const double casa::Util::RAD_DEGREE_CONVERSION [static, private]

Definition at line 144 of file Util.h.

const double casa::Util::TIME_CONV [static, private]

Definition at line 143 of file Util.h.

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

code/display/QtPlotter/Util.h

casa::Util Class Reference

Static Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation