LV_FiberEstimator#

class project_heart.lv.modules.lv_fiber_estimator.LV_FiberEstimator(log_level=20, enums={}, *args, **kwargs)#
compute_fibers(surf_region_key: str, fiber_space='P_1', alpha_endo_lv=60, alpha_epi_lv=- 60, beta_endo_lv=0, beta_epi_lv=0, markers={}, ldrb_kwargs={}, save_xdmfs=False, xdmfs_dir=None, xdmfs_basename=None, del_generated_files=True)#

DOC PENDING.

This is a wrap method for the LDRB library: https://github.com/finsberg/ldrb. Credits should be to the owners of the original LDRB library.

Parameters

  • surf_region_key (str) – _description_

  • fiber_space (str, optional) – _description_. Defaults to “P_1”.

  • alpha_endo_lv (int, optional) – _description_. Defaults to 60.

  • ldrb_kwargs (dict, optional) – _description_. Defaults to {}.

  • save_xdmfs (bool, optional) – _description_. Defaults to False.

  • xdmfs_dir (_type_, optional) – _description_. Defaults to None.

  • xdmfs_basename (_type_, optional) – _description_. Defaults to None.

  • del_generated_files (bool, optional) – _description_. Defaults to True.

Raises

  • ImportError – _description_

  • ImportError – _description_

  • ValueError – _description_

  • ValueError – _description_

  • ValueError – _description_

  • ValueError – _description_

  • ImportError – _description_

  • ValueError – _description_

  • ValueError – _description_

  • ValueError – _description_

identify_fibers_regions_ldrb(mode: str) → tuple#

Identifies mesh surface regions for fiber computation based on nodesets. LDRB only accpets three regions: ‘endo’, ‘epi’ and ‘border(s)’, therefore, we must combine aortic and mitral regions of interest into a single region. This method wraps all implemented modes to identify surfaces for LDRB. The main difference between each method is the union1d of ‘BASE_BORDER’:

LDRB_1: BORDER_MITRAL and BORDER_AORTIC

LDRB_2: EPI_MITRAL, BORDER_MITRAL and BORDER_AORTIC

LDRB_3: ENDO_MITRAL, EPI_MITRAL, BORDER_MITRAL and BORDER_AORTIC

Parameters

mode (str or Enum) – Mode of fiber regions to identify. Check LV Enum for details.

Raises

NotImplementedError – If mode is not supported or not implemented, it will raise Error.

Returns

_description_

Return type

tuple

identify_fibers_regions_ldrb_1() → tuple#

Identifies mesh surface regions for fiber computation based on nodesets. LDRB only accpets three regions: ‘endo’, ‘epi’ and ‘border(s)’, therefore, we must combine aortic and mitral regions of interest into a single region. This method we combine: BORDER_MITRAL and BORDER_AORTIC

Raises

RuntimeError – Length of one of required nodesets is 0.

Returns

(surface regions ids, mesh regions ids)

Return type

tuple

identify_fibers_regions_ldrb_2() → tuple#

Identifies mesh surface regions for fiber computation based on nodesets. LDRB only accpets three regions: ‘endo’, ‘epi’ and ‘border(s)’, therefore, we must combine aortic and mitral regions of interest into a single region. This method we combine: EPI_MITRAL, BORDER_MITRAL and BORDER_AORTIC

Raises

RuntimeError – Length of one of required nodesets is 0.

Returns

(surface regions ids, mesh regions ids)

Return type

tuple

identify_fibers_regions_ldrb_3() → tuple#

Identifies mesh surface regions for fiber computation based on nodesets. LDRB only accpets three regions: ‘endo’, ‘epi’ and ‘border(s)’, therefore, we must combine aortic and mitral regions of interest into a single region. This method we combine: ENDO_MITRAL, EPI_MITRAL, BORDER_MITRAL and BORDER_AORTIC

Raises

RuntimeError – Length of one of required nodesets is 0.

Returns

(surface regions ids, mesh regions ids)

Return type

tuple