NAME

cxPyrLayerClean - removes selected items from one layer of a pyramid

C SPECIFICATION

#include <cx/Pyramid.h>

void cxPyrLayerClean(cxPyramid *pyr, long layer, int *mark)

FORTRAN SPECIFICATION

subroutine cxPyrLayerClean(pyr, layer, mark)
integer pyr
integer layer
integer mark(*)

PARAMETERS

pyr: Input pyramid data structure.
layer: Input integer specifying which layer to modify (1-based value).
mark: Input Boolean array specifying which elements to keep at the given layer.

DESCRIPTION

cxPyrLayerClean takes a pyramid and an array of markers for the specified layer of the pyramid's elements. If the marker for an element is non-zero, cxPyrLayerClean keeps that element and its connections to the rest of the pyramid. All elements not marked are stripped out of the cxConnection structure at that layer, as well as their connections to the next layer.

The layer index is 1-based, so that a layer of 1 indicates the cxConnection structure at pyr->layer[0].relation. Note that a layer of 0 indicates the baseLattice. mark must be an array of length at least

	pyr->layer[layer - 1].relation->numElements

for layer greater than 0, or

	pyr->baseLattice->dims[0],

for layer equal to 0. As a convenience, if NULL is passed in for mark, all elements are kept.

cxPyrLayerClean does not restructure the indices of the next higher cxConnection structure; cxConnRemap performs this function. Therefore using cxPyrLayerClean at internals layers of the pyramid without also using cxConnRemap may produce erroneous output.

NAME

C SPECIFICATION

FORTRAN SPECIFICATION

PARAMETERS

DESCRIPTION

SEE ALSO