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

Translate json dictionaries into carp* command line. More...

Functions

def argument_parser ()
 
def get_mesh (mesh, cohort, case)
 
def setup_mesh (mesh_name, split_file=None)
 
def active_electrodes (elec_lst, elec)
 
def jobID (args)
 Generate name of top level output directory. More...
 
def leadfield_lookup (job, args, lfsetup, base_opts, run_num)
 Check whether the leadfields for a given configuration exists and if not, compute them. More...
 
def run (args, job)
 

Variables

string EXAMPLE_DESCRIPTIVE_NAME = 'Translate json dictionaries into carp* command line'
 
string EXAMPLE_AUTHOR = 'Gernot Plank <gernot.plank@medunigraz.at>, ' \
 
 EXAMPLE_DIR = os.path.dirname(__file__)
 

Detailed Description

Translate json dictionaries into carp* command line.

Function Documentation

◆ active_electrodes()

def bin.j2c.active_electrodes (   elec_lst,
  elec 
)

◆ argument_parser()

def bin.j2c.argument_parser ( )

◆ get_mesh()

def bin.j2c.get_mesh (   mesh,
  cohort,
  case 
)

◆ jobID()

def bin.j2c.jobID (   args)

Generate name of top level output directory.

◆ leadfield_lookup()

def bin.j2c.leadfield_lookup (   job,
  args,
  lfsetup,
  base_opts,
  run_num 
)

Check whether the leadfields for a given configuration exists and if not, compute them.

Parameters

job module job module object returned from carputils. args parser Argument parser object returned from carputils. lfsetup lfsetup plan object Obect is created during sample.set_configuration or using plan[j2c.LFSETUP] base_opts list array of carp commands k run_num The current run number

Lf_obj object and the new updated lfsetup when computed.

◆ run()

def bin.j2c.run (   args,
  job 
)

◆ setup_mesh()

def bin.j2c.setup_mesh (   mesh_name,
  split_file = None 
)

Variable Documentation

◆ EXAMPLE_AUTHOR

string bin.j2c.EXAMPLE_AUTHOR = 'Gernot Plank <gernot.plank@medunigraz.at>, ' \

◆ EXAMPLE_DESCRIPTIVE_NAME

string bin.j2c.EXAMPLE_DESCRIPTIVE_NAME = 'Translate json dictionaries into carp* command line'

◆ EXAMPLE_DIR

bin.j2c.EXAMPLE_DIR = os.path.dirname(__file__)