shamo.hd_tdcs.simulation.single.problem.ProbHDTDCSSim

class shamo.hd_tdcs.simulation.single.problem.ProbHDTDCSSim(**kwargs)

Bases: shamo.core.problems.single.getdp.ProbGetDP

A problem definition to simulate HD-tDCS.

Attributes

sigmas	(shamo.core.problems.single.CompTissueProp) The electrical conductivity of the tissues.
references	(shamo.core.problems.single.CompSensors) The electrodes to use as the references.
source	(shamo.core.problems.single.CompSensors) The electrode to use as the source.
current	(float) The injected current.
grid	(shamo.core.problems.single.CompGridSampler) The grid sampler if the source space must be 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.
items
keys
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.
setdefault	Insert key with a value of default if key is not in the dictionary.
solve	Simulate HD-tDCS.
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

template

Return the name of the template PRO file.

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.

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

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

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.

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.

solve(name, parent_path, model, **kwargs)

Simulate HD-tDCS.

Parameters

namestr

The name of the solution.

parent_pathstr, byte or os.PathLike

The path to the parent directory of the solution.

modelshamo.fem.FEM

The finite element model to solve the problem for.

Returns

shamo.hd_tdcs.SolHDTDCSSim

The simulation results.

property template

Return the name of the template PRO file.

Returns

str

The name of the template PRO 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]

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