nifreeze.estimator module

A model-based algorithm for the realignment of dMRI data.

class nifreeze.estimator.Estimator(self, model: 'BaseModel | str', strategy: 'str' = 'random', prev: 'Estimator | Filter | None' = None, model_kwargs: 'dict | None' = None, **kwargs)

Bases: object

Estimates rigid-body head-motion and distortions derived from eddy-currents.

run(dataset: DatasetT, **kwargs) → Self

Trigger execution of the workflow this estimator belongs.

Parameters:

dataset (BaseDataset) – The input dataset this estimator operates on.

Returns:

The estimator, after fitting.

Return type:

Estimator

class nifreeze.estimator.Filter(self, /, *args, **kwargs)

Bases: object

Alters an input data object (e.g., downsampling).

run(dataset: DatasetT, **kwargs) → DatasetT

Trigger execution of the designated filter.

Parameters:

dataset (BaseDataset) – The input dataset this estimator operates on.

Returns:

dataset – The dataset, after filtering.

Return type:

BaseDataset