nifreeze.model.base module

Base infrastructure for nifreeze’s models.

class nifreeze.model.base.AverageModel(self, **kwargs)

Bases: BaseModel

A trivial model that returns an average map.

Initialize a new model.

fit(data, **kwargs)

Calculate the average.

property is_fitted

predict(*_, **kwargs)

Return the average map.

class nifreeze.model.base.BaseModel(self, mask=None, **kwargs)

Bases: object

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.

fit(data, **kwargs)

Abstract member signature of fit().

property is_fitted

predict(*args, **kwargs)

Abstract member signature of predict().

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

Bases: object

A factory for instantiating diffusion models.

static init(model='DTI', **kwargs)

Instantiate a diffusion model.

Parameters:

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

Returns:

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

Return type:

ReconstModel

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

Bases: BaseModel

A trivial model that returns a given map always.

Implement object initialization.

fit(data, **kwargs)

Do nothing.

property is_fitted

predict(*_, **kwargs)

Return the b=0 map.