AST_REMOVEREGIONS

Remove any Regions from a Mapping

Description:

This function searches the suppliedMapping (which may be a compound Mapping such as a CmpMap) for any component Mappings that are instances of the AST Region class. It then creates a new Mapping from which all Regions have been removed. If a Region cannot simply be removed (for instance, if it is a component of a parallel CmpMap), then it is replaced with an equivalent UnitMap in the returned Mapping.

Invocation

RESULT = AST_REMOVEREGIONS( THIS, STATUS )

Arguments

THIS = INTEGER (Given)
Pointer to the original Mapping.
STATUS = INTEGER (Given and Returned)
The global status.

Applicability

CmpFrame
If the supplied Mapping is a CmpFrame, any component Frames that are instances of the Region class are replaced by the equivalent Frame.
FrameSet
If the supplied Mapping is a FrameSet, the returned Mapping will be a copy of the supplied FrameSet in which Regions have been removed from all the inter-Frame Mappings, and any Frames which are instances of the Region class are replaced by the equivalent Frame.
Mapping
This function applies to all Mappings.
Region
If the supplied Mapping is a Region, the returned Mapping will be the equivalent Frame.

Returned Value

AST_REMOVEREGIONS = INTEGER
A new pointer to the (possibly modified) Mapping.

Notes: