preprocess_image

Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.

preprocess_image(image: habit.image.ImageVolume, steps: Mapping[str, Mapping[str, Any]], *, mask: 'habit.image.MaskVolume' | None = None, modality: str = 'image') → habit.image.ImageVolume

Apply an ordered image-preprocessing chain to one volume in memory.

Recipe twin of habit.recipes.preprocess_workflow.preprocess_image().

Parameters:

• image – Intensity volume to process.

• steps – Ordered {step_name: params} mapping.

• mask – Optional ROI mask.

• modality – Synthetic modality key used internally.

Returns:

The processed intensity volume.