carputils
Doxygen code documentation for the python framework controlling openCARP
Classes | Namespaces | Functions | Variables
j2carp.py File Reference

Classes

class  carputils.forcepss.j2carp.SweepSetup
 
class  carputils.forcepss.j2carp.LeadfieldComputationOptions
 

Namespaces

 carputils.forcepss.j2carp
 

Functions

def carputils.forcepss.j2carp.load_json (file_name)
 
def carputils.forcepss.j2carp.print_subdict (key, val, shift_num=0)
 
def carputils.forcepss.j2carp.print_settings_config (config, config_header=False)
 
def carputils.forcepss.j2carp.save_json (jdata, file_name, indent=2, overwrite=True)
 
def carputils.forcepss.j2carp.write_vtx_file (filename, vtx_list)
 
def carputils.forcepss.j2carp.write_carp_par_file (filename, opts, start_num=1)
 
def carputils.forcepss.j2carp.valid_keys (jsec, key_lst)
 
def carputils.forcepss.j2carp.get_init_dir (init_dir, up)
 Retrieve/create path to initialization directory. More...
 
def carputils.forcepss.j2carp.is_mutable (sec, ignore)
 
def carputils.forcepss.j2carp.vel2List (CVs, G)
 
def carputils.forcepss.j2carp.get_bath_labels (cnf, pop=False)
 
def carputils.forcepss.j2carp.ep_secs_to_carp (cnf, fncs, use_abs_paths=True)
 
def carputils.forcepss.j2carp.ep_sec_to_carp (tags, key, ep, idx, use_abs_paths=True)
 
def carputils.forcepss.j2carp.G_secs_to_carp (cnf, fncs, ek=False, dream=False)
 
def carputils.forcepss.j2carp.G_sec_to_carp (tags, key, G, idx, cv_ref=None)
 
def carputils.forcepss.j2carp.CV_secs_to_carp (cnf, fncs)
 
def carputils.forcepss.j2carp.CV_sec_to_carp (cv, idx, key)
 
def carputils.forcepss.j2carp.gen_physics (ExtraTags=None, IntraTags=None, EikonalTags=None, MechTags=None, FluidTags=None)
 
def carputils.forcepss.j2carp.domain_to_phys_region (ptype, name, domain, idx)
 
def carputils.forcepss.j2carp.elec_sec_to_carp (job, elecs, idx, act_lst, *model_name=None, model_format=None, ucc_file=None, stim_filename=None, dry=False)
 
def carputils.forcepss.j2carp.get_ground_stimulus (lfsetup, ground_vtx_file, stim_num, dry=False)
 
def carputils.forcepss.j2carp.stim_sec_to_carp (job, stimuli, lfsetup, rmode, output_dir, **kwargs)
 
def carputils.forcepss.j2carp.get_elec_point (pt, pt_idx, stm)
 
def carputils.forcepss.j2carp.mgquery_idx_call (job, spec_line, stim_name, model_name, model_format, ucc_file, dry=False)
 
def carputils.forcepss.j2carp.build_stim_geom (job, elec, idx, stm_name, *model_name=None, model_format=None, ucc_file=None, stim_filename=None, dry=False)
 
def carputils.forcepss.j2carp.ek_lat_detect (idx, threshold=-10, **kwargs)
 
def carputils.forcepss.j2carp.lat (idx, ID, threshold=-10, measurand=0, mode=0, detect_all=0, method=1)
 
def carputils.forcepss.j2carp.sentinel (idx, start, window)
 
def carputils.forcepss.j2carp.propagation_mode (mode)
 
def carputils.forcepss.j2carp.setup_mesh (meshname, use_split=True, split_file=None, tags_file=None)
 Set up mesh command including the use of a split file as well as an alternative element tag vector. More...
 
def carputils.forcepss.j2carp.intra_mesh_ext (rmode)
 
def carputils.forcepss.j2carp.setup_tissue (cnf, fncs, rmode, **kwargs)
 
def carputils.forcepss.j2carp.check_config (cnf, fncs)
 
def carputils.forcepss.j2carp.add_slv_settings (slv)
 
def carputils.forcepss.j2carp.setup_timings (plan)
 
def carputils.forcepss.j2carp.check_initial_state_vectors (funcs, verbose)
 
def carputils.forcepss.j2carp.update_exp_desc (up_flag, exp_file, exp, indent=2)
 
def carputils.forcepss.j2carp.generate_split_file (job, plan, mesh_name, force_recreation=False)
 
def carputils.forcepss.j2carp.plan2carp (job, plan_file, meshname, rmode)
 
def carputils.forcepss.j2carp.check_stim_protocol (config, check_type='stimulus')
 

Variables

bool carputils.forcepss.j2carp.SA_AVAILABLE = False
 
bool carputils.forcepss.j2carp.UQ_AVAILABLE = False
 
string carputils.forcepss.j2carp.CONFIGURATIONS = 'config'
 
string carputils.forcepss.j2carp.CONFIGURATION_FUNC = 'func'
 
string carputils.forcepss.j2carp.CONFIGURATION_TAGS = 'tags'
 
string carputils.forcepss.j2carp.FUNCTIONS = 'functions'
 
string carputils.forcepss.j2carp.FUNCTION_CV = 'CV'
 
string carputils.forcepss.j2carp.FUNCTION_CV_CVMEAS = 'CVmeas'
 
string carputils.forcepss.j2carp.FUNCTION_CV_CVREF = 'CVref'
 
string carputils.forcepss.j2carp.FUNCTION_CV_COND = 'G'
 
string carputils.forcepss.j2carp.FUNCTION_EP = 'EP'
 
string carputils.forcepss.j2carp.FUNCTION_EP_MODEL = 'model'
 
string carputils.forcepss.j2carp.FUNCTION_EP_MODELPAR = 'modelpar'
 
string carputils.forcepss.j2carp.FUNCTION_EP_BCL = 'bcl'
 
string carputils.forcepss.j2carp.FUNCTION_EP_INIT = 'init'
 
string carputils.forcepss.j2carp.FUNCTION_EP_CYCLES = 'cycles'
 
string carputils.forcepss.j2carp.FUNCTION_EP_PLUGINS = 'plugins'
 
string carputils.forcepss.j2carp.FUNCTION_EP_PLUGPARS = 'plugin-par'
 
string carputils.forcepss.j2carp.FUNCTION_EP_APDRESFILE = 'apdres'
 
string carputils.forcepss.j2carp.FUNCTION_EP_APDRESPRTCL = 'apdresptcl'
 
tuple carputils.forcepss.j2carp.FUNCTION_CV_COND_ACTIVE_NAMES = ('gil', 'git', 'gin', 'gel', 'get', 'gen')
 
string carputils.forcepss.j2carp.FUNCTION_CV_COND_PASSIVE_NAMES = 'gbath'
 
tuple carputils.forcepss.j2carp.FUNCTION_CV_VELOCITY_NAMES = ('vf', 'vs', 'vn')
 
string carputils.forcepss.j2carp.ELECTRODES = 'electrodes'
 
string carputils.forcepss.j2carp.ELECTRODE_TYPE = 'type'
 
string carputils.forcepss.j2carp.SIMULATION = 'simulation'
 
string carputils.forcepss.j2carp.STIMULATION_STIMULI = 'stimuli'
 
string carputils.forcepss.j2carp.STIMULATION_TYPE = 'type'
 
string carputils.forcepss.j2carp.STIMULATION_ELECTRODE = 'electrode'
 
string carputils.forcepss.j2carp.STIMULATION_PROTOCOL = 'protocol'
 
string carputils.forcepss.j2carp.STIMULATION_STRENGTH = 'strength'
 
dictionary carputils.forcepss.j2carp.STIMULATION_TYPE_MAP
 
string carputils.forcepss.j2carp.SPLIT = 'split'
 
string carputils.forcepss.j2carp.SPLIT_OPSTR = 'opstr'
 
string carputils.forcepss.j2carp.SPLIT_APPLY = 'apply'
 
string carputils.forcepss.j2carp.LFSETUP = 'lfsetup'
 
string carputils.forcepss.j2carp.SOLVER = 'solver'
 
string carputils.forcepss.j2carp.SOLVER_DT = 'dt'
 
string carputils.forcepss.j2carp.SOLVER_DX = 'dx'
 
string carputils.forcepss.j2carp.SOLVER_PARABSOLVE = 'ts'
 
string carputils.forcepss.j2carp.SOLVER_MASSLUMPING = 'lumping'
 
string carputils.forcepss.j2carp.SOLVER_OPSPLIT = 'opsplit'
 
string carputils.forcepss.j2carp.SOLVER_CGTOL = 'stol'
 
string carputils.forcepss.j2carp.SOLVER_BEQM = 'beqm'
 
string carputils.forcepss.j2carp.SOLVER_FIXGE = 'fixge'
 
string carputils.forcepss.j2carp.SOLVER_SRC_MODEL = 'sourceModel'
 
string carputils.forcepss.j2carp.PROTOCOLS = 'protocols'
 
string carputils.forcepss.j2carp.PROTOCOLS_BCL = 'bcl'
 
string carputils.forcepss.j2carp.PROTOCOLS_CYCLES = 'cycles'
 
string carputils.forcepss.j2carp.PROTOCOLS_ELECTRODES = 'electrodes'
 
string carputils.forcepss.j2carp.PROTOCOLS_PROPAGATION = 'propagation'
 
string carputils.forcepss.j2carp.PROTOCOLS_LATFILE = 'lat'
 
string carputils.forcepss.j2carp.PROTOCOLS_PREPACE = 'prepace'
 
string carputils.forcepss.j2carp.PROTOCOLS_RESTART = 'restart'
 
string carputils.forcepss.j2carp.PROTOCOLS_RELTIMINGS = 'rel-timings'
 
string carputils.forcepss.j2carp.PROTOCOLS_APD_RESTITUTION = 'APD-restitution'
 
string carputils.forcepss.j2carp.PROTOCOLS_APD_RESTITUTION_TYPE = 'type'
 
string carputils.forcepss.j2carp.PROTOCOLS_APD_RESTITUTION_BCL = 'bcl'
 
string carputils.forcepss.j2carp.PROTOCOLS_APD_RESTITUTION_CI0 = 'CI0'
 
string carputils.forcepss.j2carp.PROTOCOLS_APD_RESTITUTION_CI1 = 'CI1'
 
string carputils.forcepss.j2carp.PROTOCOLS_APD_RESTITUTION_PPBEATS = 'pp_beats'
 
string carputils.forcepss.j2carp.PROTOCOLS_APD_RESTITUTION_PMBEATS = 'pm_beats'
 
string carputils.forcepss.j2carp.PROTOCOLS_APD_RESTITUTION_PMDEC = 'pm_dec'
 
list carputils.forcepss.j2carp.SAMPLING_METHODS = ['file']