The `models_utils.py` module#

Summary#

Functions

`define_sino_atrial_node`	Define Sino-atrial node.
`define_atrio_ventricular_node`	Define Atrio-ventricular node.
`define_his_bundle_bifurcation_node`	Define His bundle bifurcation node.
`define_his_bundle_end_node`	Define His bundle end node.
`define_bachman_bundle_end_node`	Define Bachmann bundle end node.
`define_fascile_bundle_end_node`	Define fascile bundle end node.
`define_full_conduction_system`	Define the full conduction system.

Stateless methods for the heart model.

Define Sino-atrial node.

Parameters:

modelmodels.FullHeart | models.FourChamber: Heart model.
landmarksLandMarks: Landmarks instance to store the SA node.
target_coordnp.ndarray | list, default: None: If None, the target coordinate is computed as the midpoint between the centroids of the superior and inferior vena cavae. If a coordinate is provided, the closest point on the right atrium endocardium surface to that coordinate is used.

Returns:

Define Atrio-ventricular node.

Parameters:

modelmodels.FullHeart | models.FourChamber: Heart model.
landmarksLandMarks: Landmarks instance to store the AV node.
target_coordnp.ndarray | list, default: None: If None, the target coordinate is computed as the closest point on the right atrium endocardium surface to the right ventricle septum. If a coordinate is provided, the closest point on the right atrium endocardium surface to that coordinate is used.

Returns:

Define His bundle bifurcation node.

Parameters:

modelmodels.FourChamber | models.FullHeart: Heart model.
landmarksLandMarks: Landmarks instance to get AV node and store HIS bifurcation node.
target_coordnp.ndarray | list, default: None: If None, the target coordinate is computed as the closest point in the septum to the AV node. If a coordinate is provided, the closest point in the septum to that coordinate is used.

Returns:

models_utils.define_his_bundle_end_node(model: ansys.health.heart.models.FullHeart | ansys.health.heart.models.FourChamber, landmarks: ansys.health.heart.landmarks.LandMarks, target_coord: numpy.ndarray | list = None, side: Literal['left', 'right'] = 'left', n_close: int = 20) → ansys.health.heart.objects.Point | None#

Define His bundle end node.

Parameters:

modelmodels.FullHeart | models.FourChamber: Heart model.
landmarksLandMarks: Landmarks instance to get HIS bifurcation node and store end nodes.
target_coordnp.ndarray | list, default: None: If None, the target coordinate is computed as the n-th closest point on the endocardium to the His bundle bifurcation node. Not implemented yet if a coordinate is provided.
sideLiteral["left", "right"], default: “left”: Side of the heart to define the end node for.
n_closeint, default: 20: n-th closest point to the bifurcation node, to avoid too close to the bifurcation node.

Returns:

models_utils.define_bachman_bundle_end_node(model: ansys.health.heart.models.FullHeart | ansys.health.heart.models.FourChamber, target_coord=None) → ansys.health.heart.landmarks.LandMarks | None#: Define Bachmann bundle end node.

models_utils.define_fascile_bundle_end_node(model: ansys.health.heart.models.FullHeart | ansys.health.heart.models.FourChamber, target_coord=None) → ansys.health.heart.landmarks.LandMarks | None#: Define fascile bundle end node.

Define the full conduction system.

Parameters:

modelmodels.FullHeart | models.FourChamber | models.BiVentricle: Heart model.
purkinje_folderstr: Folder with LS-DYNA’s Purkinje generation.
landmarksLandMarks, optional: Existing landmarks instance. If None, a new one is created.

Returns:

tuple[list[ConductionPath], LandMarks]: List of conduction paths and the landmarks instance.