NAME

cxPyrLayerGet - returns the lattice and connection list from one layer of a pyramid

C SPECIFICATION

#include <cx/DataAccess.h>

cxErrorCode cxPyrLayerGet(cxPyramid *src, long index,
cxConnection **conn, cxLattice **lat)

FORTRAN SPECIFICATION

integer function cxPyrLayerGet(src, index, conn, lat)
integer src, index, conn, lat

PARAMETERS

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.

FUNCTION RETURN VALUE

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

DESCRIPTION

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.