carputils
Doxygen code documentation for the python framework controlling openCARP
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
carputils.plot.PVPlots Class Reference

Generate plots from csv data. More...

Public Member Functions

def __init__ (self, filenames, time_interval=None, loading=True, Zv=0.0, legend=True, legend_fontsize=10.0, legend_loc='auto', legend_alpha=0.5, title=None, title_fontsize=16.0, quantile_view=False)
 
def use_kpa (self)
 Configure to plot in kPa - convert from mmHg to kPa. More...
 
def use_ms (self)
 Configure to plot in ms. More...
 
def plot_data (self, axes, ix, iy, ls='-', **kwargs)
 Plot all data sets on specified axes. More...
 
def check_column_exists (self, col_name)
 Check if column exists in any loaded dataset. More...
 
def get_available_columns (self)
 Get all available columns from all datasets. More...
 
def plot_column (self, col_name)
 Plot any column from CSV against time. More...
 
def volume_trace (self)
 Generate volume trace. More...
 
def pressure_trace (self)
 Generate pressure trace. More...
 
def pressuredot_trace (self)
 Generate pressure derivative trace. More...
 
def flux_trace (self)
 Generate flux trace. More...
 
def fluxdot_trace (self)
 Generate flux derivative trace. More...
 
def q_in_trace (self)
 Generate Q_in trace. More...
 
def q_out_trace (self)
 Generate Q_out trace. More...
 
def p_in_trace (self)
 Generate P_in trace. More...
 
def p_out_trace (self)
 Generate P_out trace. More...
 
def p_drop_trace (self)
 Generate pressure drop trace. More...
 
def velocity_trace (self)
 Generate velocity trace. More...
 
def pvloop (self)
 Generate PV loop. More...
 
def pqloop (self)
 Generate PQ loop (pressure-flux). More...
 
def pv_trace (self, combined=True)
 Generate combined PV traces. More...
 
def combined (self)
 Generate combined figure with PV loop and traces. More...
 
def report (self, filename)
 Generate multi-page PDF report. More...
 

Static Public Member Functions

def axes_relim_y (axes, qmin=0.05, qmax=0.95, padding=0.1)
 Re-limit y axis using quantiles. More...
 
def axes_relim_x (axes, qmin=0.05, qmax=0.95, padding=0.1)
 Re-limit x axis using quantiles. More...
 

Public Attributes

 data
 
 keys
 
 volunit
 
 pscale
 
 punit
 
 pdotunit
 
 tscale
 
 tunit
 
 qunit
 
 qdotunit
 
 vunit
 
 zv
 
 legend
 
 legend_fontsize
 
 legend_loc
 
 legend_alpha
 
 title
 
 title_fontsize
 
 qview
 
 time_interval
 

Static Public Attributes

dictionary LINESTYLE_MAP = {'dotted': ':', 'dashdot': '-.', 'dashed': '--', 'solid': '-'}
 
float LINEWIDTH = 1.5
 

Detailed Description

Generate plots from csv data.

Constructor & Destructor Documentation

◆ __init__()

def carputils.plot.PVPlots.__init__ (   self,
  filenames,
  time_interval = None,
  loading = True,
  Zv = 0.0,
  legend = True,
  legend_fontsize = 10.0,
  legend_loc = 'auto',
  legend_alpha = 0.5,
  title = None,
  title_fontsize = 16.0,
  quantile_view = False 
)

Member Function Documentation

◆ axes_relim_x()

def carputils.plot.PVPlots.axes_relim_x (   axes,
  qmin = 0.05,
  qmax = 0.95,
  padding = 0.1 
)
static

Re-limit x axis using quantiles.

◆ axes_relim_y()

def carputils.plot.PVPlots.axes_relim_y (   axes,
  qmin = 0.05,
  qmax = 0.95,
  padding = 0.1 
)
static

Re-limit y axis using quantiles.

◆ check_column_exists()

def carputils.plot.PVPlots.check_column_exists (   self,
  col_name 
)

Check if column exists in any loaded dataset.

◆ combined()

def carputils.plot.PVPlots.combined (   self)

Generate combined figure with PV loop and traces.

◆ flux_trace()

def carputils.plot.PVPlots.flux_trace (   self)

Generate flux trace.

◆ fluxdot_trace()

def carputils.plot.PVPlots.fluxdot_trace (   self)

Generate flux derivative trace.

◆ get_available_columns()

def carputils.plot.PVPlots.get_available_columns (   self)

Get all available columns from all datasets.

◆ p_drop_trace()

def carputils.plot.PVPlots.p_drop_trace (   self)

Generate pressure drop trace.

◆ p_in_trace()

def carputils.plot.PVPlots.p_in_trace (   self)

Generate P_in trace.

◆ p_out_trace()

def carputils.plot.PVPlots.p_out_trace (   self)

Generate P_out trace.

◆ plot_column()

def carputils.plot.PVPlots.plot_column (   self,
  col_name 
)

Plot any column from CSV against time.

◆ plot_data()

def carputils.plot.PVPlots.plot_data (   self,
  axes,
  ix,
  iy,
  ls = '-',
**  kwargs 
)

Plot all data sets on specified axes.

◆ pqloop()

def carputils.plot.PVPlots.pqloop (   self)

Generate PQ loop (pressure-flux).

◆ pressure_trace()

def carputils.plot.PVPlots.pressure_trace (   self)

Generate pressure trace.

◆ pressuredot_trace()

def carputils.plot.PVPlots.pressuredot_trace (   self)

Generate pressure derivative trace.

◆ pv_trace()

def carputils.plot.PVPlots.pv_trace (   self,
  combined = True 
)

Generate combined PV traces.

◆ pvloop()

def carputils.plot.PVPlots.pvloop (   self)

Generate PV loop.

◆ q_in_trace()

def carputils.plot.PVPlots.q_in_trace (   self)

Generate Q_in trace.

◆ q_out_trace()

def carputils.plot.PVPlots.q_out_trace (   self)

Generate Q_out trace.

◆ report()

def carputils.plot.PVPlots.report (   self,
  filename 
)

Generate multi-page PDF report.

◆ use_kpa()

def carputils.plot.PVPlots.use_kpa (   self)

Configure to plot in kPa - convert from mmHg to kPa.

◆ use_ms()

def carputils.plot.PVPlots.use_ms (   self)

Configure to plot in ms.

◆ velocity_trace()

def carputils.plot.PVPlots.velocity_trace (   self)

Generate velocity trace.

◆ volume_trace()

def carputils.plot.PVPlots.volume_trace (   self)

Generate volume trace.

Member Data Documentation

◆ data

carputils.plot.PVPlots.data

◆ keys

carputils.plot.PVPlots.keys

◆ legend

carputils.plot.PVPlots.legend

◆ legend_alpha

carputils.plot.PVPlots.legend_alpha

◆ legend_fontsize

carputils.plot.PVPlots.legend_fontsize

◆ legend_loc

carputils.plot.PVPlots.legend_loc

◆ LINESTYLE_MAP

dictionary carputils.plot.PVPlots.LINESTYLE_MAP = {'dotted': ':', 'dashdot': '-.', 'dashed': '--', 'solid': '-'}
static

◆ LINEWIDTH

float carputils.plot.PVPlots.LINEWIDTH = 1.5
static

◆ pdotunit

carputils.plot.PVPlots.pdotunit

◆ pscale

carputils.plot.PVPlots.pscale

◆ punit

carputils.plot.PVPlots.punit

◆ qdotunit

carputils.plot.PVPlots.qdotunit

◆ qunit

carputils.plot.PVPlots.qunit

◆ qview

carputils.plot.PVPlots.qview

◆ time_interval

carputils.plot.PVPlots.time_interval

◆ title

carputils.plot.PVPlots.title

◆ title_fontsize

carputils.plot.PVPlots.title_fontsize

◆ tscale

carputils.plot.PVPlots.tscale

◆ tunit

carputils.plot.PVPlots.tunit

◆ volunit

carputils.plot.PVPlots.volunit

◆ vunit

carputils.plot.PVPlots.vunit

◆ zv

carputils.plot.PVPlots.zv

The documentation for this class was generated from the following file: