ap_analyzer.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// openCARP is an open cardiac electrophysiology simulator.
//
// Copyright (C) 2020 openCARP project
//
// This program is licensed under the openCARP Academic Public License (APL)
// v1.0: You can use and redistribute it and/or modify it in non-commercial
// academic environments under the terms of APL as published by the openCARP
// project v1.0, or (at your option) any later version. Commercial use requires
// a commercial license (info@opencarp.org).
//
// This program is distributed without any warranty; see the openCARP APL for
// more details.
//
// You should have received a copy of the openCARP APL along with this program
// and can find it online: http://www.opencarp.org/license
// ----------------------------------------------------------------------------

#ifndef AP_ANALYZER_H
#define AP_ANALYZER_H

#include <stdio.h>

#include "timer_utils.h"

namespace limpet {

// define which beat to use for calibration
#define CALIBRATION_BEAT     3

// assuming a resting potential of -76 mV and an AP amplitude of 100 mV
#define def_APD90_thresh   -66.
#define def_APD30_thresh   -2.

typedef enum _event_meth { X_THRESHOLD, MX_RATE, MX_VAL } event_meth;

struct event_x_threshold {
  event_meth        m;
  char             *name;
  float             threshold;
  bool              p_slope;
};

struct event_mx_rate {
  event_meth         m;
  char              *name;
  float              threshold;
  bool               p_slope;
};

struct event_mx_val {
  event_meth         m;         
  char              *name;      
  bool               p_slope;   
};

typedef union _event_class  {
  event_meth         m;
  event_x_threshold  x_thresh;
  event_mx_rate      mx_rate;
  event_mx_val       mx_val;
} event_class;

struct ap_event {
  double             s;         
  double             t;         
  double            *trace;     
  event_class        c;
  bool               trg;
};

struct ap_events {
  int                num_events;
  ap_event          *events;
};

struct steady_state_ap {
  int                num_APs;    
  int                num_params; 
  int                cnt;        
  float             *c;          
  float             *p;          
};

typedef enum _ap_states {AP_STATE,DI_STATE} ap_states;

#define VM_HIST_LEN 4
struct action_potential {
  int                beat;     
  int                calBeat;  
  bool               pmat;     
  ap_events          acts;     
  ap_events          repols;   
  ap_events          ampls;    
  float              APD;      
  float              DI;       
  float              triang;   
  float              DIp;      
  ap_states          state;    
  double             vm_trc [VM_HIST_LEN];
  double             dvm_trc[VM_HIST_LEN];
  steady_state_ap    ss;       
  FILE              *stats;    
  FILE              *rstats;   
};


// AP analyzer
int  initialize_AP_analysis(action_potential *AP);
bool check_events(double vm, action_potential *AP, opencarp::timer_manager *tm);
void calibrate_thresholds(action_potential *AP);
bool check_steady_state(steady_state_ap *ss);
void cleanup_AP_analysis(action_potential *AP);
void print_AP_stats_header(action_potential *AP, FILE *outbuf);

}  // namespace limpet

#endif