nifreeze.model.base module¶

Base infrastructure for nifreeze’s models.

class nifreeze.model.base.BaseModel(self, dataset, **kwargs)[source]¶

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, **kwargs) → ndarray[source]¶: Fit and predict the indicate index of the dataset (abstract signature).

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

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

Initialize a new model.

fit_predict(index: int, **kwargs)[source]¶

Return the expectation map.

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

class nifreeze.model.base.ModelFactory(self, /, *args, **kwargs)[source]¶

A factory for instantiating data models.

static init(model: str | None = None, **kwargs)[source]¶

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

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

A trivial model that returns a given map always.

Implement object initialization.