Mean#

class zrad.filtering.spatial.Mean(padding_type, support, dimensionality)[source]#

Mean filter for local intensity smoothing.

The filter replaces each voxel by the average intensity in a square 2D or cubic 3D neighbourhood. Use it as a simple low-pass filter before feature extraction when local noise reduction is desired.

Parameters:
  • padding_type ({"constant", "nearest", "wrap", "reflect"}) – Boundary handling mode used during convolution.

  • support (int) – Kernel side length in voxels.

  • dimensionality ({"2D", "3D"}) – Apply the filter slice-wise in 2D or volumetrically in 3D.

Methods

apply(image)

Apply the filter to an image or set RoiData.filtered_image.

get_params()

Return filter parameters mapped to their configured values.

Mean.apply(image)#

Apply the filter to an image or set RoiData.filtered_image.

Parameters:

image (Image or RoiData) – Input image to filter. If RoiData is supplied, filtering is applied to image.image and the result is stored as filtered_image in the returned ROI data. Existing intensity, texture, and IVH prepared fields are cleared.

Returns:

filtered – Filtered image, or ROI data with filtered_image updated.

Return type:

Image or RoiData

Mean.get_params()#

Return filter parameters mapped to their configured values.

Returns:

params – Constructor parameters stored by the filter instance.

Return type:

dict