shamo.hd_tdcs.simulation.single.solution.SolHDTDCSSim¶

class shamo.hd_tdcs.simulation.single.solution.SolHDTDCSSim(name, parent_path, **kwargs)[source]¶

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

Store information about a HD-tDCS simulation.

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.
referenceslist [str]: The names of the references.
sourcelist [str]: The name of the electrode used as a source.
currentfloat: The injected current.

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_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.
`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

`current`	Return the injected current.
`j_pro_path`	Return the path to the PRO file containing the current density.
`json_path`	Return the path to the object JSON file.
`mag_j_pro_path`	Return the path to the PRO file containing the norm of the current density.
`model_json_path`	Return the path to the model JSON file.
`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.
`references`	Return the names of the electrodes used as references.
`sigmas`	Return the electrical conductivity of the tissues.
`source`	Return the name of the electrode used as source.
`v_pro_path`	Return the path to the PRO file containing the electric potential.

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

copy() → a shallow copy of D¶

property current¶

Return the injected current.

Returns

float: The injected current.

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_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 j_pro_path¶

Return the path to the PRO file containing the current density.

Returns

pathlib.Path: The path to the PRO file containing the current density.

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 mag_j_pro_path¶

Return the path to the PRO file containing the norm of the current density.

Returns

pathlib.Path: The path to the PRO file containing the norm of the current density.

property model_json_path¶

Return the path to the model JSON file.

Returns

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

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 references¶

Return the names of the electrodes used as references.

Returns

list [str]: The names of the electrodes used as references.

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.

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 sigmas¶

Return the electrical conductivity of the tissues.

Returns

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

property source¶

Return the name of the electrode used as source.

Returns

str: The name of the electrode used as source.

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 v_pro_path¶

Return the path to the PRO file containing the electric potential.

Returns

pathlib.Path: The path to the PRO file containing the electric potential.

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