astCmpFrameastCmpFrame - Create a CmpFrame

Description:
This function creates a new CmpFrameCmpFrame and optionally initialises its attributes.

A CmpFrame is a compound FrameFrame which allows two component Frames (of any class) to be merged together to form a more complex Frame. The axes of the two component Frames then appear together in the resulting CmpFrame (those of the first Frame, followed by those of the second Frame).

Since a CmpFrame is itself a Frame, it can be used as a component in forming further CmpFrames. Frames of arbitrary complexity may be built from simple individual Frames in this way.

Also since a Frame is a MappingMapping, a CmpFrame can also be used as a Mapping. Normally, a CmpFrame is simply equivalent to a UnitMapUnitMap, but if either of the component Frames within a CmpFrame is a RegionRegion (a sub-class of Frame), then the CmpFrame will use the Region as a Mapping when transforming values for axes described by the Region. Thus input axis values corresponding to positions which are outside the Region will result in bad output axis values.

Synopsis:
AstCmpFrame $*$astCmpFrame( AstFrame $*$frame1, AstFrame $*$frame2, const char $*$options, ... )
Parameters:
frame1
Pointer to the first component Frame.
frame2
Pointer to the second component Frame.
options
Pointer to a null-terminated string containing an optional comma-separated list of attribute assignments to be used for initialising the new CmpFrame. The syntax used is identical to that for the astSetastSet function and may include "printf" format specifiers identified by "%" symbols in the normal way.
...
If the "options" string contains "%" format specifiers, then an optional list of additional arguments may follow it in order to supply values to be substituted for these specifiers. The rules for supplying these are identical to those for the astSet function (and for the C "printf" function).
Returned Value:
astCmpFrame()
A pointer to the new CmpFrame.
Notes:
  • A null ObjectObject pointer (AST__NULL) will be returned if this function is invoked with the AST error status set, or if it should fail for any reason.
Status Handling
The protected interface to this function includes an extra parameter at the end of the parameter list descirbed above. This parameter is a pointer to the integer inherited status variable: "int $*$status".