shamo.core.problems.single.components.tissue_property.CompTissueProp

class shamo.core.problems.single.components.tissue_property.CompTissueProp(**kwargs)

Bases: shamo.core.problems.single.components.abc.CompABC

Store information about a tissue property.

Methods

check	Check if the tissue property is properly set.
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.
set	Set the property for a tissue.
setdefault	Insert key with a value of default if key is not in the dictionary.
sets	Set multiple properties at once.
to_pro_param	Return the parameters required to generate the PRO file.
to_py_param	Return the parameters required to generate the PY file.
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

check(name, **kwargs)

Check if the tissue property is properly set.

Parameters

namestr

The name of the property.

Other Parameters

tissuesdict [str, shamo.Tissue]

The tissues of the model.

Raises

RuntimeError

If no property is set for an existing tissue. If a field set for a tissue does not exist.

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.

set(tissue, prop, field=None)

Set the property for a tissue.

Parameters

tissuestr

The name of the tissue.

propfloat

The value of the property.

fieldstr, optional

The name of the field associated.

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.

sets(props)

Set multiple properties at once.

Parameters

propsdict [str, float]

The properties of the tissues.

to_pro_param(name='', **kwargs)

Return the parameters required to generate the PRO file.

Parameters

namestr

The name of the property.

Returns

list [dict [str, float|str]]

The tissue properties.

Other Parameters

tissuesdict [str, shamo.Tissue]

The tissues of the model.

Notes

If a field was set for the property of a tissue, its formula is fed with all the named parameters and evaluated to produce the expression.

to_py_param(**kwargs)

Return the parameters required to generate the PY file.

Returns

list [dict [str, str|float]]

The tissue properties.

Notes

Each element of the list is formatted as {"tissue": name, "prop": value, "field": field_name}.

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