Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

coordsys.findcoordinate - Function

	Package	general
	Module	images
	Tool	coordsys

Find axes of specified coordinate

Synopsis
findcoordinate(pixel, world, type, which)

Arguments

pixel	out	Pixel axes
		Allowed:	Vector of integers
world	out	World axes
		Allowed:	Vector of integers
type	in	Type of coordinate to find
		Allowed:	String from "direction", "stokes", "spectral", "linear", "tabular"
		Default:	"direction"
which	in	Which coordinate if more than one
		Allowed:	Integer
		Default:	First (1)

Returns
T, F or fail

Description

This function (short-hand name fc) finds the axes in the Coordinate System for the specified coordinate (minimum match is active for argument type). By default it finds the first coordinate, but if there is more than one (can happen for linear coordinates), you can specify which. If the coordinate does not exist, it returns F (not fail).

See also the function axesmap which returns the mapping between pixel and world axes.

Example

- cs := coordsys(direction=T)
- local pa, wa;
- cs.findcoordinate(pa, wa, 'direction')
- print 'pixel, world axes =', pa, wa
pixel, world axes = [1 2] [1 2]