FastSurfer
Overview
- This GEAR wraps FastSurferCNN part of FastSurfer.
Summary
- FastSurferCNN is an advanced deep learning architecture capable of whole brain segmentation into 95 classes in under 1 minute, mimicking FreeSurfer anatomical segmentation and cortical parcellation (DKTatlas).
Cite
Henschel L, Conjeti S, Estrada S, Diers K, Fischl B, Reuter M, FastSurfer - A fast and accurate deep learning based neuroimaging pipeline, NeuroImage 219 (2020), 117012
License: MIT
Classification
Category: Analysis Gear
Gear Level:
- Project
- Subject
- Session
- Acquisition
- Analysis
[[TOC]]
Inputs
- 3DT1-Weighted Volume
- Name: T1w
- Type: file
- Optional: false
- Classification: file
- Description: Input 3D-T1w nifti in zipped format
- Notes: {Gear accepts one zipped nifti file}
Config
- {Config-Option}
- Name: use-gpu
- Type: boolean
- Description: Use GPU for computing the FastSurfer segmentation. Gear will default to CPU if no GPU is available.
- Default: true
Outputs
Files
-
{Output-File}
- Name: aparc+aseg.nii.gz
- Type: file
- Optional: false
- Classification: file
- Description: Segmentation output with 95 labels
- Notes: The segmentation is based on the DKT atlas
-
{Output-File}
- Name: deep-seg.log
- Type: file
- Optional: false
- Classification: file
- Description: Log file containing all processing details
-
{Output-File}
- Name: 001.mgz
- Type: file
- Optional: false
- Classification: file
- Description: intermediate file generated during inference
-
{Output-File}
- Name: orig.mgz
- Type: file
- Optional: false
- Classification: file
- Description: intermediate file generated during inference
Usage
Description
- This gears operates by using the Eval script from FastSurferCNN.
- The input is a 3D-T1w MRI exam in zipped nifti format.
- The output is saved to the Analysis section in the Flywheel platform.
File Specifications
This Gear has only 1 required input file. The details are below:
{Input-File}
A 3D-T1w brain MRI exam is required for this gear. Ideal acquistions are 1mm isotropic. The Gear can handle non-isotropic data such as 0.9mmx0.9mmx1.0mm.
Workflow
graph LR;
A[Input-File]:::input --> C;
C[Upload] --> D[Parent Container <br> Project, Subject, etc];
D:::container --> E((Gear));
E:::gear --> F[Analysis]:::container;
classDef container fill:#57d,color:#fff
classDef input fill:#7a9,color:#fff
classDef gear fill:#659,color:#fff
Description of workflow
- Upload file to container
- Select file as input to gear
- Gear places output in Analysis. All output files can be downloaded from Analysis.
- The output files are available under "Outputs" section in job log. The aparc+aseg.nii.gz can be seen with OHIF viewer.
Use Cases
Use Case 1
*Conditions*:
[x] Collection of 3D-T1w brain MRI exams for which a fast Freesurfer-style segmentation is needed. [x] For each timepoint, the data is available as a zipped nifti file.
Steps
-
Upload the zipped nifti files to your Flywheel instance a. Follow these steps to upload de-identified data to Flywheel
-
Select the subjects' sessions that are to be analyzed
a.
-
Navigate to "Run Gear", select "Analysis Gear", and select Fast Surfer under the "Image Processing - Segmentation" section. a.
-
Select the zipped nifti file to be segmented.
-
Run gear and review the results under Analysis or in the job log output section.
Logging
- Logging will indicate if the processing was run on a GPU or CPU.
- Three models are run to generate the final output.
- The processing time for each model will be displayed in the log.
FAQ
Contributing
[For more information about how to get started contributing to that gear, checkout CONTRIBUTING.md.]
Metadata
Release files for fw-gear-fast-surfer 1.0.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| fw_gear_fast_surfer-1.0.7-py3-none-any.whl | Python 3 | none | any | Details for fw_gear_fast_surfer-1.0.7-py3-none-any.whl |
Release files / fw_gear_fast_surfer-1.0.7-py3-none-any.whl
| Download URL | fw_gear_fast_surfer-1.0.7-py3-none-any.whl |
|---|---|
| Size | 4.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1e3978828a2e0eed903e02df9b1349227b98eeb1da6763ae76be034fe81cb6e7
|
|
BLAKE2b-256 checksum How to use checksums |
974a73a8d3891d4f61ebfa008a1c6a4009fd5713da1f48cd6c4f8940d1b4ea5b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.11.9 Linux/5.15.154+
|
Security for fw-gear-fast-surfer 1.0.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.