overview_plot_raw_cf: create convenient overview plots for a 'raw_cf' object

In hadron: Analysis Framework for Monte Carlo Simulation Data in Physics

create convenient overview plots for a raw_cf object

Description

create convenient overview plots for a raw_cf object

Usage

overview_plot_raw_cf(cf, grid, reim = "real", reim_same = FALSE,
  relerr = FALSE, tauint = FALSE, value_logplot = TRUE,
  value_factor = c(1), title = "")

Arguments

cf	'raw_cf' container with data and meta-data
grid	Optional, integer vector which satisfies prod(grid) == prod(cf$dim). This is passed to par via par(mfrow=grid) to produce a grid of plots as defined by the components of grid.
reim	Vector of strings, one of 'real', 'imag' or 'both'. Specified whether the real or imaginary parts (or both) should be plotted.
reim_same	Boolean, whether real and imaginary parts should be plotted on the same plot. If TRUE, then reim must be 'both'. If this is given, the imaginary part as well as its relative error and per-time-slice integrated autocorreation times
relerr	Boolean, whether a plot of the relative error per time slice should be added.
tauint	Boolean, whether a plot of the integrated auto-correlation time on each time slice should be added.
value_logplot	Boolean, whether the plot of the correlator should be on a logarithmic vertical axis. (does not affect tauint and relerr).
value_factor	Numeric, either of length '1' or as long as the number of correlation functions in cf. The data will be scaled by this factor before plotting.
title	Character vector, will be passed as the main argument to plotwitherror which in turn passes it to plot. Can be either of length '1' or prod(cf$dim)

Value

No return value, only plots are generated.

hadron documentation built on Sept. 9, 2022, 5:06 p.m.