#include <UnitMap.h>

Public Member Functions
	UnitMap ()
	Default constructor of maps. More...

	~UnitMap ()
	Destructor. More...

Static Public Member Functions
static Bool	getPref (const String &s, UnitName &name, UMaps *maps=0)
	Check if a unit name is known, and return its value if True More...

static Bool	getUnit (const String &s, UnitName &name, UMaps *maps=0)
	Get a standard unit definition (search order: User, Customary, SI) More...

static Bool	getCache (const String &s, UnitVal &val)
	Get a cached definition. More...

static void	putCache (const String &s, const UnitVal &val)
	Save a definition of a full unit name in the cache (the cache will be cleared if getting too large (200 entries) More...

static void	putUser (const String &s, const UnitVal &val)
	Define a user defined standard unit. More...

static void	putUser (const String &s, const UnitVal &val, const String &name)

static void	putUser (const UnitName &name)

static void	removeUser (const String &name)
	Remove a user unit. More...

static void	removeUser (const UnitName &name)

static void	clearCache ()
	Clear out the cache. More...

static void	addFITS ()
	Define FITS related unit names. More...

static void	clearFITS ()
	Clear FITS related units from user list. More...

static Unit	fromFITS (const Unit &un)
	Translate a FITS unit to the proper units. More...

static Unit	toFITS (const Unit &un)
	Translate to a FITS unit. More...

static void	list (ostream &os)
	List some part of the standard unit lists on cout or stream More...

static void	list ()

static void	listCache (ostream &os)
	List all units in cache. More...

static void	listCache ()

static void	listPref (ostream &os)
	List all prefixes. More...

static void	listPref ()

static void	listDef (ostream &os)
	List all defining units. More...

static void	listDef ()

static void	listSI (ostream &os)
	List all SI units. More...

static void	listSI ()

static void	listCust (ostream &os)
	List all customary units. More...

static void	listCust ()

static void	listUser (ostream &os)
	List all user defined units. More...

static void	listUser ()

static const map< String, UnitName > &	givePref ()
	Return the different maps. More...

static const map< String, UnitName > &	giveDef ()

static const map< String, UnitName > &	giveSI ()

static const map< String, UnitName > &	giveCust ()

static const map< String, UnitName > &	giveUser ()

static const map< String, UnitVal > &	giveCache ()

Private Member Functions
	UnitMap (const UnitMap &other)
	Copy constructor (not implemented) More...

UnitMap &	operator= (const UnitMap &other)
	Copy assignment (not implemented) More...

Static Private Member Functions
static UMaps &	getMaps ()
	Get the static UMaps struct. More...

static map< String, UnitVal > &	getMapCache ()
	Get the static mapCache object. More...

static Bool	getNameFITS (const UnitName *&name, uInt which)
	Get the name of a FITS unit. More...

static const String &	getStringFITS (uInt which)
	Get the belonging unit to a FITS unit. More...

static void	initUM ()

static void	initUMPrefix (UMaps &)
	Bits and pieces of initUM() to get compilation speed improved. More...

static void	initUMSI1 (UMaps &)

static void	initUMSI2 (UMaps &)

static void	initUMCust1 (UMaps &)

static void	initUMCust2 (UMaps &)

static void	initUMCust3 (UMaps &)

Static Private Attributes
static std::mutex	fitsMutex

Friends
class	UMaps

Detailed Description

contains all simple known physical units

Intended use:

Public interface

Review Status

Reviewed By:: UNKNOWN
Date Reviewed:: before2004/08/25
Test programs:: tUnit

Prerequisite

Unit

Etymology

Based on Units and the Casacore container classes called 'Map'

Synopsis

Physical units are strings consisting of one or more names of known basic units, separated by '.' or ' ' (for multiplication) or '/' (for division). Each name can optionally be preceded by a standard decimal prefix, and/or followed by an (optionally signed) exponent. Example: km/s/(Mpc.s)2 is identical to km.s-1.Mpc-2.s-2

See the Unit class for more details.

The UnitMap class contains the known standard basic units, and any other basic unit defined by the user of the Unit related classes. The known units are divided into 5 different groups:

Defining units: m, kg, s, A, K, cd, mol, rad, sr, _
SI units: including a.o. Jy, AU etc)
Customary units: e.g. lb, hp, ly etc
User defined units: defined by user (e.g. Beam, KPH, KM)
Cached units: cached unit strings for speed in operations

The full list of known units can be viewed by running the tUnit test program.
Caution: There is a difference between units without a dimension (non-dimensioned I will call them), and undimensioned units; Non-dimensioned examples are "", "%"; undimensioned examples: "beam", "pixel";

Information about the contents of the unit maps can be obtained by the Bool functions (False if not present):

UnitMap::getPref("string", UnitName &) prefix
UnitMap::getUnit("string", UnitName &) search user, customary, SI (in that order)
UnitMap::getCache("string", UnitVal &) search cache

The standard units can be viewed by the following commands, which output to cout:

UnitMap::list() all prefixes and SI, Cust and User units
UnitMap::listCache() current cache contents
UnitMap::listPref() all prefixes
UnitMap::listDef() all defining units
UnitMap::listSI() all SI Units
UnitMap::listCust() all customary units
UnitMap::listUser() all user defined units

Units can be defined in the user list by:
Tip: The cache will be cleared if a user defined unit is overwritten, to make sure no old value will be used;

UnitMap::putUser("tag", UnitVal(factor,"unit"), "full name (optional)");
or:
UnitMap::putUser(UnitName);

Caution: If using an explicit Unit variable (e;g; Unit a("5Bolton/beam")), the check on the legality of the given string, and the conversion to the cached canonical value in the variable 'a', is only done at creation time; This means that if the user changes the value of a unit involved by the putUser() method, the unit using it should be re-created ( a = Unit("5Bolton/beam"););
A special set of 'units' used in FITS datasets can be added by the command

UnitMap::addFITS();

casacore::UnitMap::addFITS

static void addFITS()

Define FITS related unit names.

This set can be cleared from the user table by:

UnitMap::clearFITS();

casacore::UnitMap::clearFITS

static void clearFITS()

Clear FITS related units from user list.

Note that Unitmap keeps track of the inclusion of the FITS inclusion, making multiple calls inexpensive. The list of current FITS units can be viewed by running the tUnit program, or looking at the FITSunit table.

Once the UnitMap::addFITS() has been run, the FITS units can be used as any other unit. In addition, a FITS unit can be translated to standard SI units by a call to Unit UnitMap::fromFITS(const Unit). Any unit that is defined as a standard FITS unit will be translated. Unknown ones will not be translated, making the way clear for having standard units in a FITS units string. A comparable toFITS() translates in the same way in the reversed direction.

The cache can be cleared by:

UnitMap::clearCache();

casacore::UnitMap::clearCache

static void clearCache()

Clear out the cache.

Example

Check for legal prefix:

UnitName myUnit;

if (UnitMap::getPref("k", myUnit)) { cout << "k has value " << myUnit;}

casacore::UnitMap::getPref

static Bool getPref(const String &s, UnitName &name, UMaps *maps=0)

Check if a unit name is known, and return its value if True

Define a value for the unit 'beam':

UnitMap::putUser("beam",UnitVal(C::pi * 0.1, "\"_2"),"telescope beam");

casacore::C::pi

const Double pi

Pi and functions thereof:

List current cache:

UnitMap::listCache();

casacore::UnitMap::listCache

static void listCache()

Motivation

Standard list available to try to enhance use of SI and related units

To Do

Some inlining (did not work first go)

Definition at line 212 of file UnitMap.h.

Constructor & Destructor Documentation

◆ UnitMap() [1/2]

casacore::UnitMap::UnitMap ( )

Default constructor of maps.

◆ ~UnitMap()

casacore::UnitMap::~UnitMap ( )

Destructor.

◆ UnitMap() [2/2]

casacore::UnitMap::UnitMap ( const UnitMap & other )

private

Copy constructor (not implemented)

Member Function Documentation

◆ addFITS()

static void casacore::UnitMap::addFITS ( )

static

Define FITS related unit names.

◆ clearCache()

static void casacore::UnitMap::clearCache ( )

static

Clear out the cache.

◆ clearFITS()

static void casacore::UnitMap::clearFITS ( )

static

Clear FITS related units from user list.

◆ fromFITS()

static Unit casacore::UnitMap::fromFITS ( const Unit & un )

static

Translate a FITS unit to the proper units.

Note that this is a translation of the string only, no conversion. Unknown FITS units are not translated. Hence any new definition of the FITS units will work ok

◆ getCache()

static Bool casacore::UnitMap::getCache	(	const String &	s,
		UnitVal &	val
	)

static

Get a cached definition.

◆ getMapCache()

static map<String, UnitVal>& casacore::UnitMap::getMapCache ( )

staticprivate

Get the static mapCache object.

This cannot be part of the UMaps struct, because the UnitVal ctor is called in the initialization of UMaps, but uses mapCache resulting in a recursive call.

◆ getMaps()

static UMaps& casacore::UnitMap::getMaps ( )

staticprivate

Get the static UMaps struct.

◆ getNameFITS()

static Bool casacore::UnitMap::getNameFITS	(	const UnitName *&	name,
		uInt	which
	)

staticprivate

Get the name of a FITS unit.

◆ getPref()

static Bool casacore::UnitMap::getPref	(	const String &	s,
		UnitName &	name,
		UMaps *	maps = `0`
	)

static

Check if a unit name is known, and return its value if True

Get a prefix definition from key

◆ getStringFITS()

static const String& casacore::UnitMap::getStringFITS ( uInt which )

staticprivate

Get the belonging unit to a FITS unit.

◆ getUnit()

static Bool casacore::UnitMap::getUnit	(	const String &	s,
		UnitName &	name,
		UMaps *	maps = `0`
	)

static

Get a standard unit definition (search order: User, Customary, SI)

◆ giveCache()

static const map<String, UnitVal>& casacore::UnitMap::giveCache ( )

static

◆ giveCust()

static const map<String, UnitName>& casacore::UnitMap::giveCust ( )

static

◆ giveDef()

static const map<String, UnitName>& casacore::UnitMap::giveDef ( )

static

◆ givePref()

static const map<String, UnitName>& casacore::UnitMap::givePref ( )

static

Return the different maps.

◆ giveSI()

static const map<String, UnitName>& casacore::UnitMap::giveSI ( )

static

◆ giveUser()

static const map<String, UnitName>& casacore::UnitMap::giveUser ( )

static

◆ initUM()

static void casacore::UnitMap::initUM ( )

staticprivate

◆ initUMCust1()

static void casacore::UnitMap::initUMCust1 ( UMaps & )

staticprivate

◆ initUMCust2()

static void casacore::UnitMap::initUMCust2 ( UMaps & )

staticprivate

◆ initUMCust3()

static void casacore::UnitMap::initUMCust3 ( UMaps & )

staticprivate

◆ initUMPrefix()

static void casacore::UnitMap::initUMPrefix ( UMaps & )

staticprivate

Bits and pieces of initUM() to get compilation speed improved.

◆ initUMSI1()

static void casacore::UnitMap::initUMSI1 ( UMaps & )

staticprivate

◆ initUMSI2()

static void casacore::UnitMap::initUMSI2 ( UMaps & )

staticprivate

◆ list() [1/2]

static void casacore::UnitMap::list ( )

static

◆ list() [2/2]

static void casacore::UnitMap::list ( ostream & os )

static

List some part of the standard unit lists on cout or stream

List all known unit symbols

◆ listCache() [1/2]

static void casacore::UnitMap::listCache ( )

static

◆ listCache() [2/2]

static void casacore::UnitMap::listCache ( ostream & os )

static

List all units in cache.

◆ listCust() [1/2]

static void casacore::UnitMap::listCust ( )

static

◆ listCust() [2/2]

static void casacore::UnitMap::listCust ( ostream & os )

static

List all customary units.

◆ listDef() [1/2]

static void casacore::UnitMap::listDef ( )

static

◆ listDef() [2/2]

static void casacore::UnitMap::listDef ( ostream & os )

static

List all defining units.

◆ listPref() [1/2]

static void casacore::UnitMap::listPref ( )

static

◆ listPref() [2/2]

static void casacore::UnitMap::listPref ( ostream & os )

static

List all prefixes.

◆ listSI() [1/2]

static void casacore::UnitMap::listSI ( )

static

◆ listSI() [2/2]

static void casacore::UnitMap::listSI ( ostream & os )

static

List all SI units.

◆ listUser() [1/2]

static void casacore::UnitMap::listUser ( )

static

◆ listUser() [2/2]

static void casacore::UnitMap::listUser ( ostream & os )

static

List all user defined units.

◆ operator=()

UnitMap& casacore::UnitMap::operator= ( const UnitMap & other )

private

Copy assignment (not implemented)

◆ putCache()

static void casacore::UnitMap::putCache	(	const String &	s,
		const UnitVal &	val
	)

static

Save a definition of a full unit name in the cache (the cache will be cleared if getting too large (200 entries)

◆ putUser() [1/3]

static void casacore::UnitMap::putUser	(	const String &	s,
		const UnitVal &	val
	)

static

Define a user defined standard unit.

If the unit is being redefined, and it has already been used in a user's Unit variable, the value cached in that variable will not change.

◆ putUser() [2/3]

static void casacore::UnitMap::putUser	(	const String &	s,
		const UnitVal &	val,
		const String &	name
	)

static

◆ putUser() [3/3]

static void casacore::UnitMap::putUser ( const UnitName & name )

static

◆ removeUser() [1/2]

static void casacore::UnitMap::removeUser ( const String & name )

static

Remove a user unit.

◆ removeUser() [2/2]

static void casacore::UnitMap::removeUser ( const UnitName & name )

static

◆ toFITS()

static Unit casacore::UnitMap::toFITS ( const Unit & un )

static

Translate to a FITS unit.

Friends And Related Function Documentation

◆ UMaps

friend class UMaps

friend

Definition at line 214 of file UnitMap.h.

Member Data Documentation

◆ fitsMutex

std::mutex casacore::UnitMap::fitsMutex

staticprivate

Definition at line 336 of file UnitMap.h.

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

casa/Quanta/UnitMap.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Static Private Attributes

Friends

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Example

Motivation

To Do

Constructor & Destructor Documentation

◆ UnitMap() [1/2]

◆ ~UnitMap()

◆ UnitMap() [2/2]

Member Function Documentation

◆ addFITS()

◆ clearCache()

◆ clearFITS()

◆ fromFITS()

◆ getCache()

◆ getMapCache()

◆ getMaps()

◆ getNameFITS()

◆ getPref()

◆ getStringFITS()

◆ getUnit()

◆ giveCache()

◆ giveCust()

◆ giveDef()

◆ givePref()

◆ giveSI()

◆ giveUser()

◆ initUM()

◆ initUMCust1()

◆ initUMCust2()

◆ initUMCust3()

◆ initUMPrefix()

◆ initUMSI1()

◆ initUMSI2()

◆ list() [1/2]

◆ list() [2/2]

◆ listCache() [1/2]

◆ listCache() [2/2]

◆ listCust() [1/2]

◆ listCust() [2/2]

◆ listDef() [1/2]

◆ listDef() [2/2]

◆ listPref() [1/2]

◆ listPref() [2/2]

◆ listSI() [1/2]

◆ listSI() [2/2]

◆ listUser() [1/2]

◆ listUser() [2/2]

◆ operator=()

◆ putCache()

◆ putUser() [1/3]

◆ putUser() [2/3]

◆ putUser() [3/3]

◆ removeUser() [1/2]

◆ removeUser() [2/2]

◆ toFITS()

Friends And Related Function Documentation

◆ UMaps

Member Data Documentation

◆ fitsMutex