matador.orm package

class matador.orm.DataContainer(data: Optional[Dict] = None, **kwargs)[source]

Bases: abc.ABC

Base class for matador data classes. This class is a read-only store of the underlying dictionary of raw data; its children can implement useful methods to inspect and analyse the underlying data.

Initalise copy of raw data.

required_keys = []
property root_source
property source

Return the source of the data.

get(*args)[source]

Overload dictionary.get() method.

Parameters

key (str) – key to try and obtain.

Keyword Arguments

default – return value raise if key is not present.

Returns

_data[key] if it exists, else None.

Subpackages

Submodules

matador.orm.magres module

This file implements classes to store and manipulate magnetic resonance data.

class matador.orm.magres.MagneticResonance(data: Optional[Dict] = None, **kwargs)[source]

Bases: matador.orm.orm.DataContainer

Initalise copy of raw data.

matador.orm.orm module

This file implements the base DataContainer class which wraps raw matador dictionaries and adds useful methods to be inherited by its children.

class matador.orm.orm.DataContainer(data: Optional[Dict] = None, **kwargs)[source]

Bases: abc.ABC

Base class for matador data classes. This class is a read-only store of the underlying dictionary of raw data; its children can implement useful methods to inspect and analyse the underlying data.

Initalise copy of raw data.

required_keys = []
property root_source
property source

Return the source of the data.

get(*args)[source]

Overload dictionary.get() method.

Parameters

key (str) – key to try and obtain.

Keyword Arguments

default – return value raise if key is not present.

Returns

_data[key] if it exists, else None.