elevation¶

elevation(shape: List, voxel_size: float, axis: int = 0)[source]¶

Generates a image of distances from given axis

Parameters:

shape (ndarray or list) – This dictates the shape of the output image. If an image is supplied, then it’s shape is used. Otherwise, the shape should be supplied as a N-D long list of the shape for each axis (i.e. [200, 200] or [300, 300, 300]).
voxel_size (scalar) – The size of the voxels in physical units (i.e. 100e-6 would be 100 um per voxel side).
axis (int, optional, default is 0) – The direction along which the height is calculated. The default is 0, which is the ‘x-axis’.

Returns:

elevation – A numpy array of the specified shape with the values in each voxel indicating the height of that voxel from the beginning of the specified axis.

Return type:

ndarray