NAME

cxPyrGet - returns a pointer to the base lattice and the number of layers from a pyramid

C SPECIFICATION

#include <cx/DataAccess.h>


cxErrorCode cxPyrGet(cxPyramid *src, cxLattice **baseLat,
 long *count)

FORTRAN SPECIFICATION

integer function cxPyrGet(src, baselat, count)
integer src
integer baselat
integer count

PARAMETERS

src
Input pyramid data structure.
baseLat
On output, the lowest level lattice in the pyramid.
count
On output, the number of layers in the pyramid.

FUNCTION RETURN VALUE

The return value for this function is an integer error code enumeration.

DESCRIPTION

cxPyrGet extracts two pieces of information from a pyramid data structure, a pointer to the base lattice and the number of lattice-connection layers in the pyramid. The base lattice resides at the lowest level in the pyramid. Each lattice-connection layer stores higher-dimensional data and its relation to data of dimension one lower. Given the number of layers in a pyramid, another routine cxPyrLayerGet can be used to access the individual lattices and connection list structures within the source pyramid. A return value of cx_err_none indicates success, while another value indicates a NULL input pyramid.

The user can tell the function not to get information on a particular field by passing a NULL pointer value. You need not create dummy variables in the calling routine which calls cxPyrGet, because the request is simply ignored when the pointer comes in NULL.

SEE ALSO

cxPyrSet(3E), cxPyrLayerGet(3E)
Last modified: Mon Nov 18 13:52:44 GMT 1996
[ Documentation Home ]
© The Numerical Algorithms Group Ltd, Oxford UK. 1996