Next: AST_COLUMNSIZE - Get the number of bytes needed to hold a full column of data
Up: AST Routine Descriptions
Previous: AST_COLUMNNULL - Get or set the null value for an integer column of a FITS table
AST_COLUMNSHAPE
-
Returns the shape of the values in a named column
- Description:
- This routine
returns the number of dimensions spaned by each value in a named
column of a Table, together with the length of each dimension.
These are the values supplied when the column was created using
AST_ADDCOLUMN.
- Invocation:
- CALL AST_COLUMNSHAPE( THIS, COLUMN, MXDIM, NDIM, DIMS, STATUS )
- Arguments:
-
THIS = INTEGER (Given)
-
Pointer to the Table.
-
COLUMN = CHARACTER
(
) (Given)
-
The character string holding the upper case name of the column. Trailing
spaces are ignored.
-
MXDIM = INTEGER (Given)
-
The length of the
DIMS array.
-
NDIM = INTEGER (Returned)
-
The
number of dimensions spanned by values in the named column.
This will be zero if the column contains scalar values.
-
DIMS( MXDIM ) = INTEGER (Returned)
-
An
array in which to return the length of each dimension. Any
excess trailing elements will be filled with the value 1.
-
STATUS = INTEGER (Given and Returned)
-
The global status.
- Notes:
- No error is reported if the requested column cannot be found in the
given Table. A value of zero is returned for
NDIM and the supplied values in DIMS
are left unchanged.
- A value of zero is returned for
NDIM
if an error occurs.
Next: AST_COLUMNSIZE - Get the number of bytes needed to hold a full column of data
Up: AST Routine Descriptions
Previous: AST_COLUMNNULL - Get or set the null value for an integer column of a FITS table
AST A Library for Handling World Coordinate Systems in Astronomy
Starlink User Note 210
R.F. Warren-Smith & D.S. Berry
24th May 2011
E-mail:ussc@star.rl.ac.uk
Copyright (C) 2009 Science \& Technology Facilities Council