Next: DAT_COPY - Copy object
Up: ROUTINE DESCRIPTIONS
Previous: DAT_CLONE - Clone locator
- Description:
Temporarily coerce an object into changing its shape.
- Invocation:
CALL DAT_COERC( LOC1, NDIM, LOC2, STATUS )
- Arguments:
-
LOC1 = CHARACTER * ( DAT__SZLOC ) (Given)
-
Object locator.
-
NDIM = INTEGER (Given)
-
Number of dimensions.
-
LOC2 = CHARACTER * ( DAT__SZLOC ) (Returned)
-
Coerced object locator.
-
STATUS = INTEGER (Given and Returned)
-
The global status.
- Notes:
If the number of dimensions in the object is to be increased,
each additional dimension size is set to 1, e.g. if loc1 is
associated with a 2-D object of shape (512,256) say, setting ndim
to 3 transforms the dimensions to (512,256,1). Likewise, if the
number of dimensions is to be reduced, the appropriate trailing
dimension sizes are discarded; the routine will fail if any of
these do not have the value 1. As with DAT_VEC, only the
appearance of the object is changed - the original shape
remains intact.
Next: DAT_COPY - Copy object
Up: ROUTINE DESCRIPTIONS
Previous: DAT_CLONE - Clone locator
HDS Hierarchical Data System
Starlink User Note 92
R.F. Warren-Smith & M.D. Lawden
23rd February 1999
E-mail:rfws@star.rl.ac.uk
Copyright (C) 1999 Central Laboratory of the Research Councils