atlMatchRegion

Ensure the axes in a Region match those in a Frame

Description:

This function checks for matching axes in a supplied Region and Frame. If possible, a new region is created containing a set of axes that correspond in number and type (but not necessarily in specific attributes) to those in the supplied Frame. This means that astConvert should be able to find a Mapping between the supplied Frame and the returned Region. Note, the order of the axes in the returned Region may not match those in the Frame, but astConvert will be able to identify any required re-ordering.

If it is not possible to find a matching Region (for instance, if there are no axes in common between the supplied Region and Frame), an error is reported.

Invocation

AstRegion atlMatchRegion( AstRegion region, AstFrame frm, int status )

Arguments

region
An AST pointer for the Region to be modified.
frm
An AST pointer for a Frame to be matched.
status
The global status.

Returned Value

An AST pointer for a Region that matches Frame, or NULL if
an error occurs.

Notes: