geopyv.geometry.exclusions

Module Contents

Functions

circular_exclusion(coord, radius, size)	Function to define an array of circular exclusion coordinates.
circular_exclusion_list(coords, radius, size)	Function to define a list of circular exclusion coordinates.

geopyv.geometry.exclusions.circular_exclusion(coord, radius, size)

Function to define an array of circular exclusion coordinates.

Parameters:

• coord (numpy.ndarray (x, y)) – Coordinate of exclusion in pixels.

• radius (int) – Radius of exclusion in pixels.

• size (int) – Required subset spacing on exclusion boundary in pixels.

Returns:

exclusion – Array of coordinates defining the exclusion.

Return type:

np.ndarray (Nx,Ny)

geopyv.geometry.exclusions.circular_exclusion_list(coords, radius, size)

Function to define a list of circular exclusion coordinates.

Parameters:

• coord (np.ndarray (x,y)) – Coordinate of exclusion in pixels.

• radius (int) – Radius of exclusion in pixels.

• size (int) – Required subset spacing on exclusion boundary in pixels.

Returns:

exclusion – List of coordinates defining the exclusion.

Return type:

list [np.ndarray (Nx, Ny)]