HeartModelUtils

class ansys.health.heart.models_utils.HeartModelUtils

Stateless methods for the heart model.

Overview

Static methods

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.

Import detail

from ansys.health.heart.models_utils import HeartModelUtils

Method detail

static HeartModelUtils.define_sino_atrial_node(model: ansys.health.heart.models.FullHeart | ansys.health.heart.models.FourChamber, target_coord: numpy.ndarray | list = None) → LandMarks | None

Define Sino-atrial node.

Parameters:

modelmodels.FullHeart | models.FourChamber

Heart model.

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:

LandMarks | None

SA node.

static HeartModelUtils.define_atrio_ventricular_node(model: ansys.health.heart.models.FullHeart | ansys.health.heart.models.FourChamber, target_coord: numpy.ndarray | list = None) → LandMarks | None

Define Atrio-ventricular node.

Parameters:

modelmodels.FullHeart | models.FourChamber

Heart model.

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:

LandMarks | None

AV node.

static HeartModelUtils.define_his_bundle_bifurcation_node(model: ansys.health.heart.models.FourChamber | ansys.health.heart.models.FullHeart, target_coord: numpy.ndarray | list = None) → LandMarks | None

Define His bundle bifurcation node.

Parameters:

modelmodels.FourChamber | models.FullHeart

Heart model.

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:

LandMarks | None

HIS bifurcation node.

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

Define His bundle end node.

Parameters:

modelmodels.FullHeart | models.FourChamber

Heart model.

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:

LandMarks | None

End node of His left or right bundle.

static HeartModelUtils.define_bachman_bundle_end_node(model: ansys.health.heart.models.FullHeart | ansys.health.heart.models.FourChamber, target_coord=None) → LandMarks | None

Define Bachmann bundle end node.

static HeartModelUtils.define_fascile_bundle_end_node(model: ansys.health.heart.models.FullHeart | ansys.health.heart.models.FourChamber, target_coord=None) → LandMarks | None

Define fascile bundle end node.

static HeartModelUtils.define_full_conduction_system(model: ansys.health.heart.models.FullHeart | ansys.health.heart.models.FourChamber, purkinje_folder: str) → list[ansys.health.heart.pre.conduction_path.ConductionPath]

Define the full conduction system.

Parameters:

modelmodels.FullHeart | models.FourChamber

Heart model.

purkinje_folderstr

Folder with LS-DYNA’s Purkinje generation.

Returns:

list[ConductionPath]

List of conduction paths.