casac::coordsys Class Reference

#include <coordsys_cmpt.h>

List of all members.

---

Detailed Description

coordsys component class

// TODO: WRITE YOUR DESCRIPTION HERE!

Author:

Version:

Definition at line 37 of file coordsys_cmpt.h.

Public Member Functions
	coordsys ()
virtual	~coordsys ()
::casac::coordsys *	newcoordsys (const bool direction=false, const bool spectral=false, const std::vector< std::string > &stokes=std::vector< std::string >(1,""), const int linear=0, const bool tabular=false)
bool	addcoordinate (const bool direction=false, const bool spectral=false, const std::vector< std::string > &stokes=std::vector< std::string >(1,""), const int linear=0, const bool tabular=false)
std::vector< int >	axesmap (const bool toworld=true)
std::vector< std::string >	axiscoordinatetypes (const bool world=true)
std::string	conversiontype (const std::string &type="direction")
std::vector< double >	convert (const std::vector< double > &coordin, const std::vector< bool > &absin=std::vector< bool >(1, true), const std::string &dopplerin="radio", const std::vector< std::string > &unitsin=std::vector< std::string >(1,"Native"), const std::vector< bool > &absout=std::vector< bool >(1, true), const std::string &dopplerout="radio", const std::vector< std::string > &unitsout=std::vector< std::string >(1,"Native"), const std::vector< int > &shape=std::vector< int >(1,-1))
::casac::variant *	convertmany (const::casac::variant &coordin, const std::vector< bool > &absin=std::vector< bool >(1, true), const std::string &dopplerin="radio", const std::vector< std::string > &unitsin=std::vector< std::string >(1,"Native"), const std::vector< bool > &absout=std::vector< bool >(1, true), const std::string &dopplerout="radio", const std::vector< std::string > &unitsout=std::vector< std::string >(1,"Native"), const std::vector< int > &shape=std::vector< int >(1,-1))
std::vector< std::string >	coordinatetype (const int which=-1)
::casac::coordsys *	copy ()
bool	done ()
::casac::record *	epoch ()
bool	findaxis (int &coordinate, int &axisincoordinate, const bool world=true, const int axis=0)
bool	findcoordinate (std::vector< int > &pixel, std::vector< int > &world, const std::string &type="direction", const int which=0)
std::vector< double >	frequencytofrequency (const std::vector< double > &value, const std::string &frequnit="", const::casac::variant &velocity=::casac::initialize_variant(""), const std::string &doppler="radio")
std::vector< double >	frequencytovelocity (const std::vector< double > &value, const std::string &frequnit="", const std::string &doppler="radio", const std::string &velunit="km/s")
bool	fromrecord (const::casac::record &record)
::casac::record *	increment (const std::string &format="n", const std::string &type="")
::casac::variant *	lineartransform (const std::string &type)
std::vector< std::string >	names (const std::string &type="")
int	naxes (const bool world=true)
int	ncoordinates ()
std::string	observer ()
::casac::record *	projection (const std::string &type="")
std::vector< std::string >	referencecode (const std::string &type="", const bool list=false)
::casac::record *	referencepixel (const std::string &type="")
::casac::record *	referencevalue (const std::string &format="n", const std::string &type="")
bool	reorder (const std::vector< int > &order)
bool	replace (const::casac::record &csys, const int whichin, const int whichout)
::casac::record *	restfrequency ()
bool	setconversiontype (const std::string &direction="", const std::string &spectral="")
std::string	getconversiontype (const std::string &type="")
bool	setdirection (const std::string &refcode="", const std::string &proj="", const std::vector< double > &projpar=std::vector< double >(1,-1), const std::vector< double > &refpix=std::vector< double >(1,-1), const ::casac::variant &refval=::casac::initialize_variant(""), const ::casac::variant &incr=::casac::initialize_variant(""), const::casac::variant &xform=::casac::initialize_variant(""), const ::casac::variant &poles=::casac::initialize_variant(""))
bool	setepoch (const::casac::record &value)
bool	setincrement (const::casac::variant &value=::casac::initialize_variant(""), const std::string &type="")
bool	setlineartransform (const std::string &type, const ::casac::variant &value)
bool	setnames (const std::vector< std::string > &value, const std::string &type="")
bool	setobserver (const std::string &value)
bool	setprojection (const std::string &type, const std::vector< double > &parameters=std::vector< double >(1,-1))
bool	setreferencecode (const std::string &value, const std::string &type="direction", const bool adjust=true)
bool	setreferencelocation (const std::vector< int > &pixel=std::vector< int >(1,-1), const ::casac::variant &world=::casac::initialize_variant("-1"), const std::vector< bool > &mask=std::vector< bool >(1, false))
bool	setreferencepixel (const std::vector< double > &value, const std::string &type="")
bool	setreferencevalue (const::casac::variant &value, const std::string &type="")
bool	setrestfrequency (const::casac::variant &value, const int which=0, const bool append=false)
bool	setspectral (const std::string &refcode="", const ::casac::variant &restfreq=::casac::initialize_variant(""), const ::casac::variant &frequencies=::casac::initialize_variant("1GHz"), const std::string &doppler="", const ::casac::variant &velocities=::casac::initialize_variant("1km/s"))
bool	setstokes (const std::vector< std::string > &stokes)
bool	settabular (const std::vector< double > &pixel=std::vector< double >(1,-1), const std::vector< double > &world=std::vector< double >(1,-1), const int which=0)
bool	settelescope (const std::string &value)
bool	setunits (const std::vector< std::string > &value, const std::string &type="", const bool overwrite=false, const int which=-10)
std::vector< std::string >	stokes ()
std::vector< std::string >	summary (const std::string &doppler="RADIO", const bool list=true)
std::string	telescope ()
::casac::record *	toabs (const::casac::variant &value, const int isworld=-1)
::casac::record *	toabsmany (const::casac::variant &value, const int isworld=-1)
::casac::record *	topixel (const::casac::variant &value)
::casac::record *	topixelmany (const::casac::variant &value)
::casac::record *	torecord ()
::casac::record *	torel (const::casac::variant &value, const int isworld=-1)
::casac::record *	torelmany (const::casac::variant &value, const int isworld=-1)
::casac::record *	toworld (const::casac::variant &value=::casac::initialize_variant(""), const std::string &format="n")
::casac::record *	toworldmany (const::casac::variant &value)
std::string	type ()
std::vector< std::string >	units (const std::string &type="")
std::vector< double >	velocitytofrequency (const std::vector< double > &value, const std::string &frequnit="", const std::string &doppler="radio", const std::string &velunit="km/s")
std::string	parentname ()
bool	setparentname (const std::string &imagename)

---

Constructor & Destructor Documentation

casac::coordsys::coordsys

(

)

virtual casac::coordsys::~coordsys

(

)

[virtual]

---

Member Function Documentation

::casac::coordsys* casac::coordsys::newcoordsys	(	const bool	direction = false,
		const bool	spectral = false,
		const std::vector< std::string > &	stokes = std::vector< std::string >(1,""),
		const int	linear = 0,
		const bool	tabular = false
	)

bool casac::coordsys::addcoordinate	(	const bool	direction = false,
		const bool	spectral = false,
		const std::vector< std::string > &	stokes = std::vector< std::string >(1,""),
		const int	linear = 0,
		const bool	tabular = false
	)

std::vector<int> casac::coordsys::axesmap

(

const bool

toworld = true

)

std::vector<std::string> casac::coordsys::axiscoordinatetypes

(

const bool

world = true

)

std::string casac::coordsys::conversiontype

(

const std::string &

type = "direction"

)

std::vector<double> casac::coordsys::convert	(	const std::vector< double > &	coordin,
		const std::vector< bool > &	absin = std::vector< bool >(1, true),
		const std::string &	dopplerin = "radio",
		const std::vector< std::string > &	unitsin = std::vector< std::string >(1,"Native"),
		const std::vector< bool > &	absout = std::vector< bool >(1, true),
		const std::string &	dopplerout = "radio",
		const std::vector< std::string > &	unitsout = std::vector< std::string >(1,"Native"),
		const std::vector< int > &	shape = std::vector< int >(1,-1)
	)

::casac::variant* casac::coordsys::convertmany	(	const ::casac::variant &	coordin,
		const std::vector< bool > &	absin = std::vector< bool >(1, true),
		const std::string &	dopplerin = "radio",
		const std::vector< std::string > &	unitsin = std::vector< std::string >(1,"Native"),
		const std::vector< bool > &	absout = std::vector< bool >(1, true),
		const std::string &	dopplerout = "radio",
		const std::vector< std::string > &	unitsout = std::vector< std::string >(1,"Native"),
		const std::vector< int > &	shape = std::vector< int >(1,-1)
	)

std::vector<std::string> casac::coordsys::coordinatetype

(

const int

which = -1

)

::casac::coordsys* casac::coordsys::copy

(

)

bool casac::coordsys::done

(

)

::casac::record* casac::coordsys::epoch

(

)

bool casac::coordsys::findaxis	(	int &	coordinate,
		int &	axisincoordinate,
		const bool	world = true,
		const int	axis = 0
	)

bool casac::coordsys::findcoordinate	(	std::vector< int > &	pixel,
		std::vector< int > &	world,
		const std::string &	type = "direction",
		const int	which = 0
	)

std::vector<double> casac::coordsys::frequencytofrequency	(	const std::vector< double > &	value,
		const std::string &	frequnit = "",
		const ::casac::variant &	velocity = ::casac::initialize_variant(""),
		const std::string &	doppler = "radio"
	)

std::vector<double> casac::coordsys::frequencytovelocity	(	const std::vector< double > &	value,
		const std::string &	frequnit = "",
		const std::string &	doppler = "radio",
		const std::string &	velunit = "km/s"
	)

bool casac::coordsys::fromrecord

(

const ::casac::record &

record

)

::casac::record* casac::coordsys::increment	(	const std::string &	format = "n",
		const std::string &	type = ""
	)

::casac::variant* casac::coordsys::lineartransform

(

const std::string &

type

)

std::vector<std::string> casac::coordsys::names

(

const std::string &

type = ""

)

int casac::coordsys::naxes

(

const bool

world = true

)

int casac::coordsys::ncoordinates

(

)

std::string casac::coordsys::observer

(

)

::casac::record* casac::coordsys::projection

(

const std::string &

type = ""

)

std::vector<std::string> casac::coordsys::referencecode	(	const std::string &	type = "",
		const bool	list = false
	)

::casac::record* casac::coordsys::referencepixel

(

const std::string &

type = ""

)

::casac::record* casac::coordsys::referencevalue	(	const std::string &	format = "n",
		const std::string &	type = ""
	)

bool casac::coordsys::reorder

(

const std::vector< int > &

order

)

bool casac::coordsys::replace	(	const ::casac::record &	csys,
		const int	whichin,
		const int	whichout
	)

::casac::record* casac::coordsys::restfrequency

(

)

bool casac::coordsys::setconversiontype	(	const std::string &	direction = "",
		const std::string &	spectral = ""
	)

std::string casac::coordsys::getconversiontype

(

const std::string &

type = ""

)

bool casac::coordsys::setdirection	(	const std::string &	refcode = "",
		const std::string &	proj = "",
		const std::vector< double > &	projpar = std::vector< double >(1,-1),
		const std::vector< double > &	refpix = std::vector< double >(1,-1),
		const ::casac::variant &	refval = ::casac::initialize_variant(""),
		const ::casac::variant &	incr = ::casac::initialize_variant(""),
		const ::casac::variant &	xform = ::casac::initialize_variant(""),
		const ::casac::variant &	poles = ::casac::initialize_variant("")
	)

bool casac::coordsys::setepoch

(

const ::casac::record &

value

)

bool casac::coordsys::setincrement	(	const ::casac::variant &	value = ::casac::initialize_variant(""),
		const std::string &	type = ""
	)

bool casac::coordsys::setlineartransform	(	const std::string &	type,
		const ::casac::variant &	value
	)

bool casac::coordsys::setnames	(	const std::vector< std::string > &	value,
		const std::string &	type = ""
	)

bool casac::coordsys::setobserver

(

const std::string &

value

)

bool casac::coordsys::setprojection	(	const std::string &	type,
		const std::vector< double > &	parameters = std::vector< double >(1,-1)
	)

bool casac::coordsys::setreferencecode	(	const std::string &	value,
		const std::string &	type = "direction",
		const bool	adjust = true
	)

bool casac::coordsys::setreferencelocation	(	const std::vector< int > &	pixel = std::vector< int >(1,-1),
		const ::casac::variant &	world = ::casac::initialize_variant("-1"),
		const std::vector< bool > &	mask = std::vector< bool >(1, false)
	)

bool casac::coordsys::setreferencepixel	(	const std::vector< double > &	value,
		const std::string &	type = ""
	)

bool casac::coordsys::setreferencevalue	(	const ::casac::variant &	value,
		const std::string &	type = ""
	)

bool casac::coordsys::setrestfrequency	(	const ::casac::variant &	value,
		const int	which = 0,
		const bool	append = false
	)

bool casac::coordsys::setspectral	(	const std::string &	refcode = "",
		const ::casac::variant &	restfreq = ::casac::initialize_variant(""),
		const ::casac::variant &	frequencies = ::casac::initialize_variant("1GHz"),
		const std::string &	doppler = "",
		const ::casac::variant &	velocities = ::casac::initialize_variant("1km/s")
	)

bool casac::coordsys::setstokes

(

const std::vector< std::string > &

stokes

)

bool casac::coordsys::settabular	(	const std::vector< double > &	pixel = std::vector< double >(1,-1),
		const std::vector< double > &	world = std::vector< double >(1,-1),
		const int	which = 0
	)

bool casac::coordsys::settelescope

(

const std::string &

value

)

bool casac::coordsys::setunits	(	const std::vector< std::string > &	value,
		const std::string &	type = "",
		const bool	overwrite = false,
		const int	which = -10
	)

std::vector<std::string> casac::coordsys::stokes

(

)

std::vector<std::string> casac::coordsys::summary	(	const std::string &	doppler = "RADIO",
		const bool	list = true
	)

std::string casac::coordsys::telescope

(

)

::casac::record* casac::coordsys::toabs	(	const ::casac::variant &	value,
		const int	isworld = -1
	)

::casac::record* casac::coordsys::toabsmany	(	const ::casac::variant &	value,
		const int	isworld = -1
	)

::casac::record* casac::coordsys::topixel

(

const ::casac::variant &

value

)

::casac::record* casac::coordsys::topixelmany

(

const ::casac::variant &

value

)

::casac::record* casac::coordsys::torecord

(

)

::casac::record* casac::coordsys::torel	(	const ::casac::variant &	value,
		const int	isworld = -1
	)

::casac::record* casac::coordsys::torelmany	(	const ::casac::variant &	value,
		const int	isworld = -1
	)

::casac::record* casac::coordsys::toworld	(	const ::casac::variant &	value = ::casac::initialize_variant(""),
		const std::string &	format = "n"
	)

::casac::record* casac::coordsys::toworldmany

(

const ::casac::variant &

value

)

std::string casac::coordsys::type

(

)

std::vector<std::string> casac::coordsys::units

(

const std::string &

type = ""

)

std::vector<double> casac::coordsys::velocitytofrequency	(	const std::vector< double > &	value,
		const std::string &	frequnit = "",
		const std::string &	doppler = "radio",
		const std::string &	velunit = "km/s"
	)

std::string casac::coordsys::parentname

(

)

bool casac::coordsys::setparentname

(

const std::string &

imagename

)

---

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

• xmlcasa/implement/images/coordsys_cmpt.h

---