HabitatVolumeFeatures

Note

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

class HabitatVolumeFeatures[source]

Bases: object

Voxel counts and volume fractions of every habitat for one subject.

The fraction of the ROI occupied by each habitat (the habitat burden) is the most widely used habitat-level descriptor in the literature. Counts are reported in voxels so the features stay spacing-independent and comparable with the v0.1 CSV exports.

property spec: Spec

Return the algorithm specification.

__call__(subject: Subject, habitat_map: HabitatMap) → FeatureTable[source]

Compute the volume feature family for one subject.

Parameters:

  • subject – Owning subject (labels suffice; intensities unused).

  • habitat_map – Habitat labels for that subject.

Returns:

One-row table of per-habitat voxel counts and fractions.

Examples using habit.habitat_features.HabitatVolumeFeatures