Next: KPG1_SECSH - Shifts bounds of upper dimensions that have one element to index one
Up: Routine Descriptions
Previous: KPG1_SCLWx - Copies array values into a INTEGER2 array, scaling them in the process
KPG1_SDIMP
- Obtains up to a number of significant dimensions of an NDF
- Description:
- This routine finds the dimensions which are significant in an
NDF, i.e. those with greater than one element. The significant
dimensions are recorded and returned. If the number of
significant dimensions found is less than a specified value, the
insignificant dimensions pad out the array of dimension indices
returned; and all the dimensions are returned in order of
increasing dimensionality. However, should the number of
significant dimensions exceed the required number a bad status,
SAI_ERROR, is returned. Likewise there is an error when there
are no significant dimensions.
- Invocation:
- CALL KPG1_SDIMP( NDF, NDIM, DIMV, STATUS )
- Arguments:
-
-
NDF = INTEGER (Given)
-
The NDF identifier.
-
NDIM = INTEGER (Given)
-
The desired number of dimensions.
-
DIMV( NDIM ) = INTEGER (Returned)
-
The significant dimensions i.e. the ones that are greater than
one. There is an execption when there are fewer than NDIM
present in the NDF, whereupon this array includes in dimension
order those that are insignificant too.
-
STATUS = INTEGER (Given and Returned)
-
The global status.
-
Prior Requirements
-
Next: KPG1_SECSH - Shifts bounds of upper dimensions that have one element to index one
Up: Routine Descriptions
Previous: KPG1_SCLWx - Copies array values into a INTEGER2 array, scaling them in the process
KAPLIBS -- Internal subroutines used within the KAPPA package.
Starlink User Note 238
D.S. Berry
Malcolm J. Currie
2011 April 12
E-mail:ussc@star.rl.ac.uk
Copyright © 2011 Science and Technology Facilities Council