get_plotdata_raw_cf: extract data from 'raw_cf' in format convenient to plot

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

extract data from 'raw_cf' in format convenient to plot

Description

When dealing with with tensorial raw_cf objects pre-processing and reshaping is always required to prepare the data for plotting (or similar). This function conveniently prepares a named list of prepared data. The list elements are themselves lists which contain val and dval members with the central value and error of the element in question. These are in turn arrays of dimension c( cf$nts, cf$dim ) and thus lack the first index compared to cf$data.

Usage

get_plotdata_raw_cf(cf, reim, tauint, relerr)

Arguments

cf	raw_cf object with meta-data and data.
reim	String, one of 'real', 'imag' or 'both'. Specifies whether the real and/or imaginary parts should be extracted.
tauint	Boolean, specifies if the tensor of auto-correlation times and corresponding errors should be extracted.
relerr	Boolean, specifies if the return value should also include estimates of the relative error and its error.

Value

List of up to six named elements (depending on what was passed for reim, tauint, relerr) containing the central values and errors of the real and/or imaginary part of cf$data as well as the corresponding arrays of auto-correlation times and relative errors. The list elements come in the order real, imag, relerr_real, relerr_imag, tauint_real, tauint_imag if reim is both and tauint and relerr are TRUE. The val and dval members of these list elements are arrays of dimension c( cf$nts, cf$dim ) and thus lack the first index compared to cf$data.

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