RoiData#

class zrad.preprocessing.roi.RoiData(image: Image, filtered_image: Image | None = None, morphological_mask: Image | None = None, intensity_mask: Image | None = None, intensity_range: tuple[float, float] | None = None, texture_discretized_image: Image | None = None, ivh_intensity_image: Image | None = None, ivh_discretization_method: str | None = None, ivh_discretization_step: float | None = None)[source]#

Current image and ROI masks used for feature calculation.

RoiData groups the image and ROI representations that move through a preprocessing pipeline. The morphological mask defines the anatomical ROI; the intensity mask stores feature-image values inside that ROI and NaN outside it. Derived discretization fields are cleared by preprocessing steps that change the image, mask, or valid intensity population.

Parameters:

  • image (Image) – Original image used as the spatial reference for ROI processing.

  • filtered_image (Image, optional) – Filtered image used for intensity-based feature calculation. If this is None, image is used as the feature image.

  • morphological_mask (Image, optional) – Binary ROI mask used for morphology-based feature calculation and as the base mask for intensity ROI construction.

  • intensity_mask (Image, optional) – Image containing feature-image intensities inside the ROI and NaN outside it. This mask is used by intensity-based feature families.

  • intensity_range (tuple[float, float], optional) – Absolute re-segmentation range applied to intensity_mask. The lower bound is reused as the fixed-bin-size discretization anchor.

  • texture_discretized_image (Image, optional) – Discretized intensity image used by intensity histogram and texture feature families.

  • ivh_intensity_image (Image, optional) – Intensity image prepared for intensity-volume histogram features.

  • ivh_discretization_method (str, optional) – IVH preparation method used for ivh_intensity_image.

  • ivh_discretization_step (float, optional) – Intensity interval used to sample IVH features.

Properties

RoiData.feature_image#

Return the image used for intensity-based feature calculation.

Returns:

image – filtered_image when present; otherwise the original image.

Return type:

Image