shamo.eeg.leadfield.single.solution.SolEEGLeadfield¶

class shamo.eeg.leadfield.single.solution.SolEEGLeadfield(name, parent_path, **kwargs)[source]¶

Bases: shamo.core.solutions.single.getdp.SolGetDP

Store information about an EEG leadfield matrix.

Parameters

namestr: The name of the solution.
parent_pathstr, byte or os.PathLike: The path to the parent directory of the solution.

Other Parameters

sigmasdict [str, list [float, str]]: The electrical conductivity of the tissues.
model_json_pathstr: The relative path of the model JSON file.
markerslist [str]: The names of the markers.
referencelist [str]: The name of the reference.
roislist [str]: The names of the tissues of the region of interest.
sensorslist [str]: The names of the active sensors.
shapetuple [int]: The shape of the matrix.
use_gridbool: If True, the source space is based on a grid.

Methods

`clear`
`copy`
`fromkeys`	Create a new dictionary with keys from iterable and values set to value.
`get`	Return the value for key if key is in the dictionary, else default.
`get_matrix`	Return the matrix.
`get_relative_path`	Return the relative path from the object to a file or directory.
`items`
`keys`
`load`	Load an object from a JSON file.
`pop`	If key is not found, d is returned if given, otherwise KeyError is raised
`popitem`	Remove and return a (key, value) pair as a 2-tuple.
`save`	Save the object to a JSON file.
`set_matrix`	Set the matrix of the solution.
`setdefault`	Insert key with a value of default if key is not in the dictionary.
`update`	If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
`values`

Attributes

`json_path`	Return the path to the object JSON file.
`markers`	Return the names of the markers.
`matrix_path`	Return the path to the matrix HDF5 file.
`model_json_path`	Return the path to the model JSON file.
`n_sensors`	Return the number of active sensors.
`n_sources`	Return the number of sources.
`name`	Return the name of the object.
`parent_path`	Return the path to the parent directory of the object.
`path`	Return the path to the object directory.
`reference`	Return the name of the reference.
`rois`	Return the names of the tissues of the region of interest.
`sensors`	Return the names of the active sensors.
`shape`	Return the shape of the matrix.
`sigmas`	Return the electrical conductivity of the tissues.
`source_sp_path`	Return the path to the source space file.
`use_grid`	Return `True` if the source space is based on a grid.

clear() → None. Remove all items from D.¶

copy() → a shallow copy of D¶

fromkeys(iterable, value=None, /)¶: Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)¶: Return the value for key if key is in the dictionary, else default.

get_matrix()[source]¶

Return the matrix.

Returns

h5py.Dataset: The dataset containing the matrix.

get_relative_path(path)¶

Return the relative path from the object to a file or directory.

Parameters

pathstr, byte or os.PathLike: The path to the file or directory to compute the relative path for.

Returns

pathlib.Path: The relative path to the file or directory.

items() → a set-like object providing a view on D’s items¶

property json_path¶

Return the path to the object JSON file.

Returns

pathlib.Path: The path to the object JSON file.

keys() → a set-like object providing a view on D’s keys¶

classmethod load(json_path)¶

Load an object from a JSON file.

Parameters

json_pathstr, byte or os.PathLike: The path to the JSON file containing the object data.

Raises

TypeError: If argument json_path is not a str, byte or os.PathLike.

property markers¶

Return the names of the markers.

Returns

list [str]: The names of the markers.

property matrix_path¶

Return the path to the matrix HDF5 file.

Returns

pathlib.Path: The path to the matrix HDF5 file.

property model_json_path¶

Return the path to the model JSON file.

Returns

pathlib.Path: The path to the model JSON file.

property n_sensors¶

Return the number of active sensors.

Returns

int: The number of active sensors.

property n_sources¶

Return the number of sources.

Returns

int: The number of sources.

property name¶

Return the name of the object.

Returns

str: The name of the object.

property parent_path¶

Return the path to the parent directory of the object.

Returns

pathlib.Path: The path to the parent directory of the object.

property path¶

Return the path to the object directory.

Returns

pathlib.Path: The path to the object directory.

pop(k[, d]) → v, remove specified key and return the corresponding value.¶: If key is not found, d is returned if given, otherwise KeyError is raised

popitem(/)¶

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

property reference¶

Return the name of the reference.

Returns

str: The name of the reference.

property rois¶

Return the names of the tissues of the region of interest.

Returns

list [str]: The names of the tissues of the region of interest.

save(exist_ok=True)¶

Save the object to a JSON file.

Parameters

exist_okbool, optional: If set to True, any already existing object is overriden. Otherwise, if the object already exists, a FileExistsError. The default is True.

Raises

FileExistsError: If exist_ok is set to False and the object already exists.
TypeError: If any of the keys/values to be stored is not a str, int, float, bool or None.

property sensors¶

Return the names of the active sensors.

Returns

list [str]: The names of the active sensors.

set_matrix(matrix)[source]¶

Set the matrix of the solution.

Parameters

numpy.ndarray: The leadfield matrix.

setdefault(key, default=None, /)¶

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

property shape¶

Return the shape of the matrix.

Returns

tuple [int]: The shape of the matrix.

property sigmas¶

Return the electrical conductivity of the tissues.

Returns

dict [str, list [float, str]]: The electrical conductivity of the tissues.

property source_sp_path¶

Return the path to the source space file.

Returns

pathlib.Path: The path to the source space file.

update([E, ]**F) → None. Update D from dict/iterable E and F.¶: If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

property use_grid¶

Return True if the source space is based on a grid.

Returns

bool: True if the source space is based on a grid, False otherwise.

values() → an object providing a view on D’s values¶