store_correl: Store a 'raw_cf' correlator in an associative array together...

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

Store a 'raw_cf' correlator in an associative array together with a description The object cf will be stored as an element of cmap under key out_key in the member obj of cmap. The data frame passed via desc will be appended as a row to cmap[[out_key]]$map. If out_key does not exist as a key in cmap, a new element will be created. If it already exists, addStat.raw_cf is called to add statistics to the existing raw_cf. Requires the 'hash' package.

Description

Store a 'raw_cf' correlator in an associative array together with a description The object cf will be stored as an element of cmap under key out_key in the member obj of cmap. The data frame passed via desc will be appended as a row to cmap[[out_key]]$map. If out_key does not exist as a key in cmap, a new element will be created. If it already exists, addStat.raw_cf is called to add statistics to the existing raw_cf. Requires the 'hash' package.

Usage

store_correl(cmap, cf, out_key, desc)

Arguments

cmap	Object of class hash to act as storage for 'raw_cf' correlators.
cf	Object of class raw_cf to be stored in cmap.
out_key	String, key associated with cf object to be stored in cmap.
desc	Single row data frame containing some descriptive parameters for cf.

Value

Since objects of class hash are passed and modified by reference, there is no explicit return value. Instead, the passed cmap is modified.

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