Skip to content

Repository files navigation

sc-crop — Spinal cord detection and cropping

image

Segmentation models for spinal cord pathologies (tumors, lesions, SC itself) are typically trained and run on full volumes where the spinal cord occupies only a small fraction of the volume. sc-crop solves this by automatically detecting the spinal cord and cropping the volume tightly around it, so your segmentation model only ever sees the relevant region.

This reduces memory usage, speeds up inference, and often improves model accuracy by removing irrelevant background. The recommended workflow is:

  1. Preprocessing — crop all training images and labels around the detected spinal cord, adding a fixed security margin
  2. Training — train your segmentation model on the cropped volumes
  3. Inference — apply the same sc-crop preprocessing to new images, run your model, then optionally restore the segmentation to the original space

Works on both MRI and CT, across contrasts (T1, T2, MP2RAGE, DWI…), field strengths, and pathologies. Based on a YOLO26n model trained on multiple datasets covering cervical and lumbar spine. Available as a CLI tool and as an importable Python package.

image

Install

Fresh dedicated environment (for testing):

conda create -n sc_crop python=3.13 && conda activate sc_crop
pip install sc-crop

Or into an existing environment:

pip install sc-crop

To pin in a requirements.txt: add sc-crop>=0.6.0

To install from source (latest development version):

pip install git+https://github.com/ivadomed/sc-crop.git

Command-line interface: detect and crop spinal cord volumes

The environment where sc-crop was installed must be active for the sc_crop command to be available.

Quick start — download the test data

Image and label are available from the same release:

mkdir ~/sc-crop-test && cd ~/sc-crop-test
curl -L https://github.com/ivadomed/sc-crop/releases/download/test-data/t2.nii.gz -o t2.nii.gz
curl -L https://github.com/ivadomed/sc-crop/releases/download/test-data/t2_seg.nii.gz -o t2_seg.nii.gz

Crop the image

sc_crop -i t2.nii.gz

Three files are written:

File Content
t2_crop.nii.gz Cropped image (affine origin updated)
t2_cropbox.nii.gz Binary mask of the bounding box used (FSLeyes overlay)
t2_bbox.txt Bounding box coordinates in voxel space (human-readable)

The command also prints a ready-to-use FSLeyes command to visualise the crop and its bounding box:

fsleyes t2.nii.gz t2_crop.nii.gz t2_cropbox.nii.gz -ot mask -mc 1 0 0 --outline -w 3 &
FSLeyes bounding box overlay FSLeyes overlay panel

Crop a label with the same bounding box

Use the t2_cropbox.nii.gz (or t2_bbox.txt) produced above to crop any other volume — label, atlas, or additional contrast — with the exact same boundaries:

sc_crop -i t2_seg.nii.gz --bbox t2_cropbox.nii.gz -o t2_seg_crop.nii.gz

Adjust the bounding box margin

sc_crop -i t2.nii.gz --pad-sup 50 --pad-inf 80 --pad-left 10 --pad-right 10 --pad-ant 15 --pad-post 15
sc_crop -i t2.nii.gz --pad-si 30 --pad-rl 10 --pad-ap 15

Priority: individual (e.g. --pad-sup) > symmetric (e.g. --pad-si) > default.

Use --detect to run detection only (outputs cropbox + bbox.txt, skips the crop step).

Run sc_crop --help for all options.


Python API

Three functions cover all use cases:

Function Description
detect(img_path) Runs the SC detector and returns the bounding box coordinates
crop(img, bbox) Crops any NIfTI volume (image or label) to the bounding box
uncrop(seg, bbox) Restores a segmentation from the cropped space back to the original full image space
check_label_crop(label, bbox) Checks the crop preserves every label voxel; reports the extra padding (mm) needed per face if not
CropReport Accumulates per-volume check_label_crop results and writes a CSV report + JSON summary
from sc_crop import detect, crop, uncrop
import nibabel as nib

img  = nib.load("t2.nii.gz")
bbox = detect(img)                              # detect the spinal cord, return bounding box
from sc_crop import crop
import nibabel as nib

crop_img = crop(nib.load("t2.nii.gz"), bbox)   # also works on t2_seg.nii.gz
from sc_crop import uncrop

full_img = uncrop(crop_img, bbox)               # restore to the original space

Bounding box padding

The margin around the detected spinal cord is adjustable per face (in mm).

# Adjust SI only (most common)
bbox = detect(img, pad_superior=50, pad_inferior=80)

# All 3 symmetric
bbox = detect(img, pad_si=30, pad_rl=10, pad_ap=15)

# Symmetric + override one face
bbox = detect(img, pad_si=30, pad_inferior=60)

# Full per-face control
bbox = detect(img, pad_superior=40, pad_inferior=100,
                   pad_left=15,     pad_right=15,
                   pad_anterior=15, pad_posterior=22)

Padding is always clamped to the image boundaries. Priority per face: individual > symmetric > default (sup=40, inf=100, left=right=15, ant=15, post=22).


Use in a training + inference pipeline

⚠️ Critical: use the same padding at training and inference

sc-crop must be applied with identical padding around the detected spinal cord at both training and inference time. Different padding changes the crop boundaries and the distribution of what the model sees, which degrades performance. Pick your padding values once and keep them fixed throughout.

Step 1 — Preprocess training data

Crop all images and their labels with the same padding. Use check_label_crop and CropReport to verify no label voxel is cut by the crop — any loss means the detected box (plus padding) does not fully contain the cord, which would silently remove ground-truth voxels from training:

from sc_crop import detect, crop, check_label_crop, CropReport
import nibabel as nib

# Use the same padding for every subject
PAD = dict(pad_superior=40, pad_inferior=100, pad_left=15, pad_right=15,
           pad_anterior=15, pad_posterior=22)

report = CropReport()                       # accumulates per-volume QC

for subject in subjects:
    bbox       = detect(subject.image, **PAD)
    label_nii  = nib.load(subject.label)

    qc = check_label_crop(label_nii, bbox)  # check BEFORE cropping
    report.add(subject.label, qc)           # qc["ok"], voxels_before/after,
                                            # extra_pad_<face>_mm if a face is short

    crop_img   = crop(nib.load(subject.image), bbox)
    crop_label = crop(label_nii, bbox)
    nib.save(crop_img,   subject.image_crop)
    nib.save(crop_label, subject.label_crop)

report.save("crop_qc_report.csv")           # one row per volume
report.save_summary("crop_qc_summary.json") # totals + max extra padding needed per face
print(f"{report.n_failed()} / {len(report)} crops lost label voxels")

If report.n_failed() > 0, inspect crop_qc_summary.json: its max_extra_padding_mm field tells you how many mm to add on each face (e.g. raise pad_posterior) so every cord is fully contained. The defaults above were tuned this way.

Step 2 — Train your model on the cropped volumes

Train normally on *_crop.nii.gz images and labels.

Step 3 — Inference on a new image

Apply the same padding, run your model on the crop, then restore the segmentation to the original space:

from sc_crop import detect, crop, uncrop
import nibabel as nib

PAD = dict(pad_superior=40, pad_inferior=100, pad_left=15, pad_right=15,
           pad_anterior=15, pad_posterior=22)  # identical to training

bbox      = detect("new_subject.nii.gz", **PAD)
crop_img = crop(nib.load("new_subject.nii.gz"), bbox)

seg_crop = my_model(crop_img)                  # run your segmentation model
seg_full = uncrop(seg_crop, bbox) # back to original space + affine
nib.save(seg_full, "new_subject_seg.nii.gz")

nnUNet integration

sc-crop is applied before nnUNet's own preprocessing. The cropped images go directly into the nnUNet raw dataset folder; nnUNet never sees the original full volumes.

Step 1 — Populate nnUNet_raw/Dataset{ID}_{Name}/

nnUNet expects images in imagesTr/ named {case}_{0000}.nii.gz and labels in labelsTr/ named {case}.nii.gz. Crop image and label with the same bbox before saving there:

from sc_crop import detect, crop
import nibabel as nib
from pathlib import Path

RAW = Path("nnUNet_raw/Dataset001_MyTask")
PAD = dict(pad_superior=40, pad_inferior=100, pad_left=15, pad_right=15,
           pad_anterior=15, pad_posterior=22)

for case_id, img_path, lbl_path in subjects:
    bbox = detect(img_path, **PAD)                                          # detect once
    nib.save(crop(nib.load(img_path), bbox),
             RAW / "imagesTr" / f"{case_id}_0000.nii.gz")                  # cropped image
    nib.save(crop(nib.load(lbl_path), bbox),
             RAW / "labelsTr" / f"{case_id}.nii.gz")                       # same bbox

Step 2 — Run the standard nnUNet pipeline

nnUNetv2_plan_and_preprocess -d 001 --verify_dataset_integrity
nnUNetv2_train 001 3d_fullres 0

Step 3 — Inference on a new image

Same detect → crop → infer → uncrop pattern as any other model — see examples/infer_with_sc_crop.py for a full runnable template:

from sc_crop import detect, crop, uncrop
import nibabel as nib

img  = nib.load("new_subject.nii.gz")
bbox = detect(img, **PAD)              # same padding as Step 1
crop_img = crop(img, bbox)

seg_crop = my_nnunet_predictor(crop_img)   # run your trained nnUNet model

seg = uncrop(seg_crop, bbox)
nib.save(seg, "seg.nii.gz")

SpinalCordToolbox (SCT) integration

If you're releasing a model for use with SCT's sct_deepseg, it needs a crop_metadata.json at the root of your release .zip, so SCT knows to run the sc-crop pipeline (and with which padding) for that specific model — this travels with the model artifact itself rather than being hardcoded in SCT's own source.

Call write_crop_metadata() right where you call detect() to build your training crops, with the same padding kwargs passed to both — this way the recorded values (and the recorded sc_crop version) can't drift from what was actually used:

pad_kwargs = dict(pad_superior=40, pad_inferior=100, pad_left=15,
                  pad_right=15, pad_anterior=15, pad_posterior=22)
bbox = sc_crop.detect(img, **pad_kwargs)
sc_crop.write_crop_metadata("crop_metadata.json", **pad_kwargs)

Or, from the command line, after the fact (pip install sc-crop is enough, no need to clone):

sc_crop write-metadata \
    --pad-superior 40 --pad-inferior 100 --pad-left 15 --pad-right 15 --pad-anterior 15 --pad-posterior 22

Then include the resulting crop_metadata.json at the root of your release zip (alongside every mirror/fold zip, if the model has more than one).


Examples

The example scripts are part of the repository — clone it to run them:

git clone https://github.com/ivadomed/sc-crop.git
cd sc-crop

examples/api_examples.py — Python API cookbook covering all usage patterns. If no image is provided, the SCT tutorial T2 is downloaded automatically:

python examples/api_examples.py                  # auto-download tutorial data
python examples/api_examples.py t2.nii.gz        # use your own image
python examples/api_examples.py t2.nii.gz --ex 3 # run example 3 only (padding)
# Pattern
1 Basic detect() + crop()
2 Multi-volume: detect once, crop image + label with the same bbox
3 Padding variants: default / symmetric / mixed / full individual
4 detect_and_crop() one-liner
5 Fake segmentation model + uncrop() round-trip
6 GPU inference (device="cuda")

examples/infer_with_sc_crop.py — Full inference pipeline template with a built-in fake model (center-cylinder segmentation). If no input is provided, the SCT tutorial T2 is downloaded automatically:

python examples/infer_with_sc_crop.py                        # auto-download tutorial data
python examples/infer_with_sc_crop.py -i t2.nii.gz -o seg.nii.gz

Replace fake_sc_segmentation() with your own model to use in production.


Requirements

Python ≥ 3.8. Dependencies installed automatically: nibabel, numpy, onnxruntime, pillow, pyyaml, scipy, ultralytics (includes opencv).


Training the detector

The detection model was trained using ivadomed/model_cropping_sc_contrast-agnostic_yolo. The link between package versions, model versions, and training runs is documented in VERSIONS.md. To publish a new model version, see the release procedure in VERSIONS.md.

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages