Configuration#
autods-pet reads parameters from an INI file. Generate a template with
autods-pet create-config or copy one of the example configs from the
configs/ folder (standard.ini, quick.ini, full.ini,
advanced.ini, brain.ini). The file is parsed by
autods_pet.config.load_config().
[paths] Section#
Parameter |
Default |
Description |
|---|---|---|
|
(required) |
Root directory containing one subfolder per patient. |
|
(empty) |
Path to a text file listing patient IDs (one per line, |
|
(empty) |
Path to a CSV with PET metadata (radiopharmaceutical tags, patient weight).
When patients have incomplete metadata, an auto-generated template is
written to |
|
(empty) |
Root directory for all outputs. Per-patient results are written to
|
[lumbar_vb] Section#
Lumbar vertebral body bone marrow ROI.
Parameter |
Default |
Description |
|---|---|---|
|
|
TotalSegmentator label IDs for L3, L4, L5. Add |
|
|
Physical erosion radius in mm. |
|
|
Statistics to compute. |
[aorta_mbp] Section#
Mediastinal blood pool reference ROI.
Parameter |
Default |
Description |
|---|---|---|
|
|
T4–T8 labels for slice-gating slab. |
|
|
SimpleITK axis for slice-gating (0=x, 1=y, 2=z). |
|
|
|
|
|
Heart buffer dilation (mode: dilate_intersection). |
|
|
Heart distance threshold (mode: distance). |
|
|
Intraluminal erosion radius. |
|
|
Statistics to compute. |
[liver] Section#
Liver reference ROI.
Parameter |
Default |
Description |
|---|---|---|
|
|
Physical erosion radius in mm. |
|
|
Fill only holes below this volume (mm3). Default |
|
|
Statistics to compute. |
[long_bones] Section#
Femoral and humeral diaphysis ROIs.
Parameter |
Default |
Description |
|---|---|---|
|
|
Central percentage of the bone axis to keep. |
|
|
Statistics to compute. |
Per-bone erosion is set via sub-sections [long_bones.femur_L],
[long_bones.femur_R], [long_bones.humerus_L],
[long_bones.humerus_R], each with an erosion_mm key.
[brain] Section#
Brain cortical grey matter ROI (for Brain-to-Liver Ratio).
Parameter |
Default |
Description |
|---|---|---|
|
|
TotalSegmentator label ID for brain. |
|
|
If true, extract cortical grey matter shell (original minus eroded). If false, use the full brain mask. |
|
|
Erosion radius in mm for the shell extraction (only when
|
|
|
Statistics to compute. |
[output] Section#
Controls mask saving during ROI extraction.
Parameter |
Default |
Description |
|---|---|---|
|
|
Save individual raw TotalSegmentator label masks as NIfTI in |
|
|
Save refined ROI masks (after erosion, slabbing, etc.) as NIfTI in |
|
|
Subtract target lesion masks (FL, PM, EM, custom) from marrow ROIs (Lumbar VB, Long bones) before computing statistics. See the note below. |
Note
Lesion subtraction and input consistency
When subtract_lesions_from_marrow is enabled, the accuracy of the
corrected marrow uptake depends entirely on the completeness and
consistency of the input lesion masks. If lesion segmentation criteria
vary across patients (e.g. only the hottest lesion is segmented in
some patients while multiple lesions are segmented in others), the
subtraction will be applied unevenly, potentially introducing a
systematic bias. To ensure valid cohort-level comparisons, users
should apply uniform lesion segmentation criteria across all patients.
[deauville] Section#
Deauville Score scoring parameters.
Parameter |
Default |
Description |
|---|---|---|
|
|
Multiplier applied to the liver reference for the DS 4 / DS 5
cutoff (DS 5 = target uptake > |
[totalsegmentator] Section#
TotalSegmentator runtime options.
Parameter |
Default |
Description |
|---|---|---|
|
(empty) |
TotalSegmentator license key (set automatically via |
|
|
Use TotalSegmentator fast mode (lower accuracy, faster). Note: the
|
[dicom] Section#
Parameter |
Default |
Description |
|---|---|---|
|
|
Minimum file size (KB) to consider as DICOM. |
Target ROIs#
Opt-in sections for user-provided manual lesion masks. Both NIfTI/NRRD and DICOM SEG inputs are supported and the discovery is recursive: the mask file may live anywhere under the patient input directory, including nested study/series sub-folders exported by DICOM viewers.
Each section may set:
mask_filename– one stem (or comma-separated list of stems) for.nii.gz/.nii/.nrrdfiles. Searched recursively underinput_dir. Existing NIfTI workflows keep working unchanged – the only difference from previous releases is that the search now descends into sub-folders as well as the patient root andsegmentations/.segment_label– one DICOM SEGSegmentLabel(or comma list, case-insensitive). The SEG file is identified by matching itsReferencedSeriesSequenceto the patient’s PETSeriesInstanceUID(read fromPET_metadata.json); no filename or location is required. A single multi-segment SEG file may supply several target sections at once. Only consulted for.dcmfiles.
Set either, both, or neither. When both formats resolve the same target for the same patient, DICOM SEG wins and a note is logged. A target with neither key set is treated as disabled.
A configured target whose mask cannot be found anywhere produces a loud warning naming the patient, the patterns searched for, and the locations checked – it never silently disappears from the output.
Sections:
[focal_lesion]– Focal lesion (FL)[paramedullary]– Paramedullary disease (PM)[extramedullary]– Extramedullary disease (EM)[targets.<name>]– Custom targets
Use autods-pet validate-config <config> --patients <id1,id2> to
preview which masks would be discovered for each patient before
launching a full extract / score run, or pass
--explain-masks to extract / score / run to print the
discovery report alongside the actual computation.
Available Statistics#
Name |
Description |
|---|---|
|
Arithmetic mean of voxel values in the mask. |
|
Voxelwise median. |
|
Minimum value. |
|
Maximum value. |
|
N-th percentile (e.g. |