carputils
Doxygen code documentation for the python framework controlling openCARP
Classes | Functions
bin.insert_endo_layer Namespace Reference

TBD. More...

Classes

class  TagHandler
 simple class to handle element-tag data More...
 

Functions

def argument_parser ()
 
def jobID (args)
 
def check_cutoff_regions (rv_apba_min_max, lv_apba_min_max)
 Check the rho and apba bounds of the input arguments for the LV and the RV. More...
 
def check_binary_mesh (job, meshname)
 
def run (args, job)
 
def get_tag_split (meshname)
 
def check_mesh (job, meshname)
 
def extract_endo_surfaces (job, mesh_name, endo_surf_filename)
 
def load_tags (meshname, tags_list=None)
 
def generate (job, mesh_name, output_dir, rv_tag, lv_tag, rv_apba_min_max=[0, 1.0], lv_apba_min_max=[0, 1.0], visualize=False, dry=False)
 
def restrict_ucc_vtx_data (bounds, ucc_data, filename, vtx_data)
 Restrict vtx_data list according to bounds in certain ucc_data. More...
 
def generate_tagging_files (job, mesh_name, regions, output_dir)
 Generate the tagging files for the mesh from provided regions. More...
 

Detailed Description

TBD.

Function Documentation

◆ argument_parser()

def bin.insert_endo_layer.argument_parser ( )

◆ check_binary_mesh()

def bin.insert_endo_layer.check_binary_mesh (   job,
  meshname 
)

◆ check_cutoff_regions()

def bin.insert_endo_layer.check_cutoff_regions (   rv_apba_min_max,
  lv_apba_min_max 
)

Check the rho and apba bounds of the input arguments for the LV and the RV.

@par Parameters

args str Carputils argument parser consisting of bound args.

◆ check_mesh()

def bin.insert_endo_layer.check_mesh (   job,
  meshname 
)

◆ extract_endo_surfaces()

def bin.insert_endo_layer.extract_endo_surfaces (   job,
  mesh_name,
  endo_surf_filename 
)

◆ generate()

def bin.insert_endo_layer.generate (   job,
  mesh_name,
  output_dir,
  rv_tag,
  lv_tag,
  rv_apba_min_max = [0, 1.0],
  lv_apba_min_max = [0, 1.0],
  visualize = False,
  dry = False 
)

◆ generate_tagging_files()

def bin.insert_endo_layer.generate_tagging_files (   job,
  mesh_name,
  regions,
  output_dir 
)

Generate the tagging files for the mesh from provided regions.

@par Parameters

job carputils.job Job operator from carputils. mesh_name str Full file pathname to the mesh regions data array List of regions to be tagged within the Mesh. Each region has 3 entries: [label, vtx_filename, tag] output_dir str Specify the directory where the files are written.

@return

Writes restricted vertex data to filenmae +'.vtx'

◆ get_tag_split()

def bin.insert_endo_layer.get_tag_split (   meshname)

◆ jobID()

def bin.insert_endo_layer.jobID (   args)

◆ load_tags()

def bin.insert_endo_layer.load_tags (   meshname,
  tags_list = None 
)

◆ restrict_ucc_vtx_data()

def bin.insert_endo_layer.restrict_ucc_vtx_data (   bounds,
  ucc_data,
  filename,
  vtx_data 
)

Restrict vtx_data list according to bounds in certain ucc_data.

@par Parameters

bounds 2-element array Bounds of the ucc coordinate data. For example, [0,0.3] ucc_data data array (N,1) Single coordinate data array. Vtx data must correspond to this ucc_data array. filename str Output filename returned with ending '.vtx' vtx_data data array (M,1) s.t. M in N array of indices to perform the bounding on.

@return

Writes restricted vertex data to filenmae +'.vtx'

◆ run()

def bin.insert_endo_layer.run (   args,
  job 
)