matador.orm package¶
-
class
matador.orm.
DataContainer
(data=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.
-
Subpackages¶
Submodules¶
matador.orm.magres module¶
This file implements classes to store and manipulate magnetic resonance data.
-
class
matador.orm.magres.
MagneticResonance
(data=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=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.
-