src/coramf/Mask.c File Reference

Functions
MASK	newMask (int r, int c, int m)
void	destroyMask (MASK *m)
bool	isEmptyMask (const MASK *m)
MASK	readMasks (char *basedir, char *filenames[], int nFiles)
void	insertXYPlaneIntoMask (MATRIX xyPlane, int map, MASK *tdptr)
MATRIX	extractXYPlaneFromMask (int map, MASK masks)
MATRIX	extractMapZ1FromMask (int kx, int ky, const MASK *masks)
void	printMask (const MASK *mask)

---

Function Documentation

void destroyMask

(

MASK *

m

)

Free memory used to store data in mask

Parameters:

[in]

m

A mask

MATRIX extractXYPlaneFromMask	(	int	map,
		MASK	masks
	)

Extract the mask associated with a map.

Parameters:

[in]	map	Which map number.
[in]	masks	The 3D matrix containing masks for all maps.

Returns:

The mask as a 2D MATRIX of boolean.

void insertXYPlaneIntoMask	(	MATRIX	xyPlane,
		int	map,
		MASK *	tdptr
	)

Insert 2D boolean matrix into 3D mask matrix. The 2D matrix is the xy-mask for a map.

Parameters:

[in]	xyPlane	A single mask which is a 2D MATRIX of boolean for a single map.
[in]	map	The mask corresponds to this map number.
[in,out]	tdptr	A pointer to a 3D MASK matrix. The single mask is inserted into this matrix.

bool isEmptyMask

(

const MASK *

m

)

Test if Mask is empty.

Parameters:

[in]

m

Pointer to a 3D MASK matrix.

Returns:

true if empty; false otherwise.

void printMask

(

const MASK *

mask

)

Print the masks.

Parameters:

[in]

mask

A pointer to a MASK matrix.