AST_INTRAMAP

Create an IntraMap

Description:

This function creates a new IntraMap and optionally initialises its attributes.

An IntraMap is a specialised form of Mapping which encapsulates a privately-defined coordinate transformation routine (e.g. written in Fortran) so that it may be used like any other AST Mapping. This allows you to create Mappings that perform any conceivable coordinate transformation.

However, an IntraMap is intended for use within a single program or a private suite of software, where all programs have access to the same coordinate transformation functions (i.e. can be linked against them). IntraMaps should not normally be stored in datasets which may be exported for processing by other software, since that software will not have the necessary transformation functions available, resulting in an error.

You must register any coordinate transformation functions to be used using AST_INTRAREG before creating an IntraMap.

Invocation

RESULT = AST_INTRAMAP( NAME, NIN, NOUT, OPTIONS, STATUS )

Arguments

NAME = CHARACTER ( ) (Given)
A character string containing the name of the transformation routine to use (which should previously have been registered using AST_INTRAREG). This name is case sensitive. All white space will be removed before use.
NIN = INTEGER (Given)
The number of input coordinates. This must be compatible with the number of input coordinates accepted by the transformation routine (as specified when this routine was registered using AST_INTRAREG).
NOUT = INTEGER (Given)
The number of output coordinates. This must be compatible with the number of output coordinates produced by the transformation routine (as specified when this routine was registered using AST_INTRAREG).
OPTIONS = CHARACTER ( ) (Given)
A character string containing an optional comma-separated list of attribute assignments to be used for initialising the new IntraMap. The syntax used is identical to that for the AST_SET routine.
STATUS = INTEGER (Given and Returned)
The global status.

Returned Value

AST_INTRAMAP = INTEGER
A pointer to the new IntraMap.

Notes: