habit.recipes: named study designs
L4 recipes: named study designs, assembled from L3 components.
A recipe is the shortest path from “I want a two-step habitat analysis” to a result object, and nothing more. It contains no engine of its own: no run loop, no resume, no configuration parsing, no output directory. Those live in the execution backends (L1/L2), the writers (L1) and the CLI (L5) respectively, which is what keeps a recipe callable from a notebook, a web service or someone else’s pipeline.
User guide: Habitat Guide Habitat Guide (especially 4. Three habitat designs) · Python API guide (v2.0). Component names: Habitat Spec component catalog.
Primary entry: Study (sklearn-style
fit() / fit_predict() /
predict()). Factories
two_step_habitat / one_step_habitat / direct_pooling_habitat
build a Study with a declared design.
Tabular ML helpers that also live in this package (train_model,
cross_validate, …) are on Tabular ML (bookmark), not in the tables below.
Image-preprocessing recipes are on Image preprocessing (bookmark).
Report and figure atoms are on habit.report: run-scoped persistence and figures.
Classes
A habitat analysis declared independently of any cohort. |
|
What a fitted study hands back, entirely in memory. |
Functions
Declare a classical two-step habitat study. |
|
Declare a one-step habitat study (habitats defined inside each subject). |
|
Declare a direct-pooling habitat study (voxels pooled across the cohort). |
|
Extract features from pre-computed habitat maps ( |
|
Run standalone PyRadiomics with all declared YAML processing controls. |
|
Identify the voxel features precise enough to define habitats. |
|
Build the default extractor: the bundled voxel preset at one grid point. |
|
Overlay Prior 2024 |
|
Run a YAML configuration document through the matching recipe. |
Supporting recipes
DICOM / table utilities still exported from habit.recipes:
Run ICC reliability analysis from a validated config ( |
|
Run the standalone DICOM sort pipeline ( |
|
Compute pairwise Dice coefficients between two mask batches. |
|
Extract selected DICOM tags from files or directories. |
|
Merge feature tables horizontally on a shared index column. |