nifreeze.model.base module

Base infrastructure for nifreeze’s models.

class nifreeze.model.base.BaseModel(self, dataset, **kwargs)

Bases: ABC

Defines the interface and default methods.

Implements the interface of dipy.reconst.base.ReconstModel. Instead of inheriting from the abstract base, this implementation follows type adaptation principles, as it is easier to maintain and to read (see https://www.youtube.com/watch?v=3MNVP9-hglc).

Base initialization.

abstract fit_predict(index: int | None = None, **kwargs) → ndarray | None

Fit and predict the indicated index of the dataset (abstract signature).

If index is None, then the model is executed in single-fit mode meaning that it will be run only once in all the data available. Please note that all the predictions of this model will suffer from data leakage from the original volume.

Parameters:

index (int or None) – The index to predict. If None, no prediction will be executed.

class nifreeze.model.base.ExpectationModel(self, dataset, stat='median', **kwargs)

Bases: BaseModel

A trivial model that returns an expectation map (for example, average).

Initialize a new model.

fit_predict(index: int | None = None, **kwargs) → ndarray

Return the expectation map.

Parameters:

index (int) – The volume index that is left-out in fitting, and then predicted.

nifreeze.model.base.MASK_ABSENCE_WARN_MSG = 'No mask provided; consider using a mask to avoid issues in model optimization.'

Mask warning message.

class nifreeze.model.base.ModelFactory(self, /, *args, **kwargs)

Bases: object

A factory for instantiating data models.

static init(model: str | None = None, **kwargs)

Instantiate a diffusion model.

Parameters:

model (str) – Diffusion model. Options: "DTI", "DKI", "S0", "AverageDWI"

Returns:

model – A model object compliant with DIPY’s interface.

Return type:

ReconstModel

nifreeze.model.base.PREDICTED_MAP_ERROR_MSG = 'This model requires the predicted map at initialization'

Oracle requirement error message.

class nifreeze.model.base.TrivialModel(self, dataset, predicted=None, **kwargs)

Bases: BaseModel

A trivial model that returns a given map always.

Implement object initialization.

fit_predict(*_, **kwargs) → ndarray | None

Return the reference map.

nifreeze.model.base.UNSUPPORTED_MODEL_ERROR_MSG = 'Unsupported model <{model}>.'

Unsupported model error message