AST_GETREGIONFRAMESET

Obtain a pointer to the encapsulated FrameSet within a Region

Description:

This function returns a pointer to the FrameSet encapsulated by a Region. The base Frame is the Frame in which the box was originally defined, and the current Frame is the Frame into which the Region is currently mapped (i.e. it will be the same as the Frame returned by AST_GETREGIONFRAME).

Invocation

RESULT = AST_GETREGIONFRAMESET( THIS, STATUS )

Arguments

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

Returned Value

AST_GETREGIONFRAMESET = INTEGER
A pointer to a deep copy of the FrameSet represented by the Region. Using this pointer to modify the FrameSet will have no effect on the Region.

Notes:

Copyright (C) 2021 East Asian Observatory