Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

coordsys.findaxis - Function

	Package	general
	Module	images
	Tool	coordsys

Find specified axis in coordinate system

Synopsis
findaxis(coordinate, axisincoordinate, world, axis)

Arguments

coordinate	out	Coordinate number
		Allowed:	Integer
axisincoordinate	out	Axis in the coordinate
		Allowed:	Integer
world	in	is axis a world or pixel axis ?
		Allowed:	Bool
		Default:	T
axis	in	Axis in coordinate system
		Allowed:	Integer
		Default:	1

Returns
T, F or fail

Description

This function (short-hand name fa) finds the specified axis in the Coordinate System. If the axis does not exist, it returns F (not fail).

Example

- cs := coordsys(direction=T, linear=2)          # RA/DEC/Lin1/Lin2
- local coord, axisincoord;
- cs.findcoordinate(coord, axisincoord, T, 2)    # DEC
- print coord, axisincoord
1 2
- cs.findcoordinate(coord, axisincoord, T, 3)    # Lin1
- print coord, axisincoord
2 1

In these examples, the Coordinate System has 4 axes (both world and pixel the same). The first example finds the DEC axis (coordinate system axis 2) to be the second axis of the Direction Coordinate (coordinate 1). The second example finds the first linear axis (coordinate system axis 3) to be the first axis of the Linear Coordinate (coordinate 2).