Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

coordsys.units - Function

	Package	general
	Module	images
	Tool	coordsys

Recover the units for each axis

Synopsis
units(type)

Arguments

type	in	Coordinate type
		Allowed:	String from 'direction', 'stokes', 'spectral', 'linear' or unset
		Default:	All

Returns
Vector of strings or fail

Description

Each axis associated with the Coordinate System has a unit. This function (short-hand name u) returns those units (in world axis order).

You can recover the units either for all coordinates (leave type unset) or for a specific coordinate type (mimumum match of the allowed types will do). If you ask for a non-existent coordinate an exception is generated.

You can set the units with function setunits.

Example

- cs := coordsys(direction=T, spectral=T)
- cs.units(T)
' ' Hz 
-
- cs.units('spec')
Hz