readnissatextcf: reader for Nissa text format correlation functions

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

reader for Nissa text format correlation functions

Description

reader for Nissa text format correlation functions

Usage

readnissatextcf(file_basenames_to_read, smear_combs_to_read, Time,
  combs_to_read, nts = Time, sym.vec = c(1), symmetrise = FALSE)

Arguments

file_basenames_to_read	Character vector of file names without the smearing combination suffixes (such as 'll', 'ls', 'sl', 'ss') which will be added in the reading routine accordign to what was passed via smear_combs_to_read. An example would be '0001/mes_contr_2pts', not the lack of the smearing suffix.
smear_combs_to_read	Character vector containing the smearing cominations that are to be read. These will be attached to the file_basenames_to_read in the reading routine.
Time	Integer, time extent of the lattice.
combs_to_read	Data frame containing the indices of the masses and r-paramter combinations to be read as well as the name of the spin combination. For a two-point function using the second and third mass (0-indexed), the (+^dag,+) r-combination and the pseudoscalar-pseudoscalar spin combination would look as follows: m1_idx m2_idx r1_idx r2_idx spin_comb 1 2 0 0 "P5P5"
nts	Integer, number of time slices to be read from the correlator files.
sym.vec	Integer or numeric vector. Specifies whether the correlator at the given position is symmetric (+1.0) or anti-symmetric (-1.0 ) under time reflection. This is passed to symmetrise.cf. This should be of sufficient length to cover all correlators that are going to be read (one number per row of combs_to_read and per entry of smear_combs_to_read)
symmetrise	Boolean, specifies whether averaging over backward and forward correlators should be done after the correlator has been read in.

Value

Returns an object of class cf.

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