next up previous 264
Next: astColumnSize - Get the number of bytes needed to hold a full column of data
Up: AST Function Descriptions
Previous: astColumnNull - Get or set the null value for an integer column of a FITS table


astColumnShape - Returns the shape of the values in a named column

Description:
This function 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 astAddColumn.
Synopsis:
void astColumnShape( AstTable $*$this, const char $*$column, int mxdim, int $*$ndim, int $*$dims, int $*$status )
Parameters:
this
Pointer to the Table.
column
The character string holding the upper case name of the column. Trailing spaces are ignored.
mxdim
The length of the "dims" array.
ndim
Pointer to an int in which to return the number of dimensions spanned by values in the named column. This will be zero if the column contains scalar values.
dims
Pointer to an array in which to return the length of each dimension. Any excess trailing elements will be filled with the value 1.
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 up previous 264
Next: astColumnSize - Get the number of bytes needed to hold a full column of data
Up: AST Function Descriptions
Previous: astColumnNull - 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 211
R.F. Warren-Smith & D.S. Berry
24th May 2011
E-mail:ussc@star.rl.ac.uk

Copyright (C) 2009 Science \& Technology Facilities Council