shamo.core.fem.sensors.surface.SurfSensorABC

class shamo.core.fem.sensors.surface.SurfSensorABC(tissue, sensor_type, real_coords, mesh_coords, surf, **kwargs)

Bases: shamo.core.fem.sensors.abc.SensorABC

The base class for any surfacic sensor.

Parameters

tissuestr

The tissue the sensor is in.

real_coordsIterable [float]

The coordinates of the sensor in the real world.

mesh_coordsIterable [float]

The coordinates of the sensor in the mesh.

surfshamo.fem.Group

The physical group of the sensor.

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
load
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.
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

TYPE_CIRCLE
TYPE_POINT
TYPE_RECT
mesh_coords	Return the mesh coordinates of the sensor.
real_coords	Return the real coordinates of the sensor.
sensor_type	Return the type of the sensor.
surf	Return the group of the sensor.
tissue	Return the tissue the sensor is in.

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

property mesh_coords

Return the mesh coordinates of the sensor.

Returns

tuple (float, float, float)

The mesh coordinates of the sensor [m].

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 real_coords

Return the real coordinates of the sensor.

Returns

tuple (float, float, float)

The real coordinates of the sensor [m].

property sensor_type

Return the type of the sensor.

Returns

str

The type of the sensor.

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 surf

Return the group of the sensor.

Returns

shamo.fem.Group

The group of the sensor.

property tissue

Return the tissue the sensor is in.

Returns

str

The tissue the sensor is in.

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