Skip to main content

Module config

Module config 

Source
Expand description

Pipeline configuration types

Defines the configuration structs and enums for the QSM pipeline runner. These are pure algorithm config types (no serde). Consumers that need serialization (e.g. qsmxt-config) provide their own serde wrappers and convert to these types.

Structs§

BgRemovalConfig
Background removal configuration
BgRemovalResult
Results from background removal stage
FieldMappingConfig
Field mapping configuration
FieldMappingResult
Results from field mapping stage
InversionConfig
Dipole inversion configuration
MaskSection
A mask section: input source + generator + refinements
MaskingConfig
Masking configuration
QsmPipelineConfig
Complete QSM pipeline configuration.
ScanMetadata
Metadata about the scan
SeparationConfig
Configuration for the χ-separation stage.

Enums§

B0EstimationMethod
B0 estimation method
BgRemovalAlgorithm
Background field removal algorithm
InversionAlgorithm
Dipole inversion algorithm
MaskOp
A single mask operation (generator or refinement)
MaskThresholdMethod
Threshold method for mask generation
MaskingInput
Input data source for mask generation
OrientationSupport
Whether an algorithm is valid when B0 does not lie along the voxel +z axis.
PipelineError
Pipeline error type
QsmReference
QSM referencing method
SeparationAlgorithm
Susceptibility source-separation algorithm (χ+ / χ−).
UnwrappingAlgorithm
Phase unwrapping algorithm