NAME

cxPyrLayerGet - returns the lattice and connection list from one layer of a pyramid
#include <cx/DataAccess.h>

cxErrorCode cxPyrLayerGet(cxPyramid *src, long index, cxConnection **conn, cxLattice **lat)
integer function cxPyrLayerGet(src, index, conn, lat)
integer src, index, conn, lat
src
Input pyramid data structure.
index
Input number of the pyramid layer to query.
conn
Output pointer to the connection list in the specified pyramid layer.
lat
Output pointer to the lattice in the specified pyramid layer.
The return value for this function is an integer error code enumeration. cxPyrLayerGet returns the lattice and connection list for one layer of a pyramid. cxPyrLayerGet does not change the shared memory reference count of the lattice or the connection list in the source pyramid. Layers are numbered from one through src->count and index must lie within this range. cxPyrLayerGet can be used in conjunction with cxPyrGet to access the base lattice and the layers of a pyramid. A return value of cx_err_none indicates success, while another value indicates a NULL input pyramid, a bad index, or an error in memory allocation.

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 cxPyrLayerGet, because the request is simply ignored when the pointer comes in NULL.

cxPyrGet(3E), cxPyrLayerSet(3E)
Last modified: Mon Nov 6 16:33:45 GMT 2000
[ Documentation Home ]
© The Numerical Algorithms Group Ltd, Oxford UK. 1996