NDF_DIM - Enquire the dimension sizes of an NDF

Description:

The routine returns the size in pixels of each dimension of an NDF, together with the total number of dimensions (the size of a dimension is the difference between that dimension's upper and lower pixel-index bounds $+$ 1).

Invocation:

CALL NDF_DIM( INDF, NDIMX, DIM, NDIM, STATUS )

Arguments:

INDF = INTEGER (Given)

NDF identifier.

NDIMX = INTEGER (Given)

Maximum number of dimension sizes to return (i.e. the declared size of the DIM argument).

DIM( NDIMX ) = INTEGER (Returned)

Size of each dimension in pixels.

NDIM = INTEGER (Returned)

Total number of NDF dimensions.

STATUS = INTEGER (Given and Returned)

The global status.

Notes:

• If the NDF has fewer than NDIMX dimensions, then any remaining elements of the DIM argument will be filled with 1's.

• If the NDF has more than NDIMX dimensions, then the NDIM argument will return the actual number of dimensions. In this case only the first NDIMX dimension sizes will be returned, and an error will result if the size of any of the excluded dimensions exceeds 1.

• If this routine is called with STATUS set, then a value of 1 will be returned for all elements of the DIM array and for the NDIM argument, although no further processing will occur. The same values will also be returned if the routine should fail for any reason.

• The symbolic constant NDF__MXDIM may be used to declare the size of the DIM argument so that it will be able to hold the maximum number of NDF dimension sizes that this routine can return. This constant is defined in the include file NDF_PAR.