Parameter set. More...

#include <parameters.hpp>

Collaboration diagram for trv::ParameterSet:

Public Member Functions
	ParameterSet ()=default
	Construct a parameter set.

	~ParameterSet ()=default
	Destroy the parameter set.

	ParameterSet (const ParameterSet &other)
	Construct a copied parameter set.

int	read_from_file (char *parameter_filepath)
	Read parameters from a file.

int	validate (bool init=false)
	Validate parameters.

int	print_to_file (char *out_parameter_filepath)
	Print out extracted parameters to a file in the output measurement directory.

int	print_to_file ()
	Print out extracted parameters to the default file path in the output measurement directory.

Public Attributes
std::string	catalogue_dir
	catalogue directory

std::string	measurement_dir
	measurement/output directory

std::string	data_catalogue_file
	data catalogue file

std::string	rand_catalogue_file
	random catalogue file

std::string	catalogue_columns

std::string	catalogue_dataset
	catalogue dataset name/path (HDF5 catalogue files only)

std::string	output_tag
	output tag

double	boxsize [3] = {0., 0., 0.}
	box size (in Mpc/h) in each dimension

int	ngrid [3] = {0, 0, 0}
	grid cell number in each dimension

double	expand = 1.
	box expansion factor (if `boxsize` is not given)

double	cutoff_nyq = 0.
	Nyquist cutoff wavenumber or separation (in Mpc/h or h/Mpc)

std::string	alignment = "centre"
	box alignment: {"centre" (default), "pad"}

std::string	padscale = "box"
	padding scale (if `alignment` is "pad"): {"box" (default), "grid"}

double	padfactor = 0.
	padding factor

std::string	assignment = "tsc"
	mesh assignment scheme: {"ngp", "cic", "tsc" (default), "pcs"}

std::string	interlace = "false"
	interlacing switch: {"true"/"on", "false"/"off" (default)}

double	volume = 0.
	box volume (in Mpc^3/h^3)

long long	nmesh
	number of mesh grid cells

int	assignment_order = 0
	order of the assignment scheme

std::string	catalogue_type
	catalogue type: {"survey", "random", "sim", "none"}

std::string	statistic_type

std::string	npoint
	N-point case: {"2pt", "3pt", "none"}

std::string	space
	coordinate space: {"fourier", "config"}

int	ell1 = 0
	spherical degree associated with the first wavevector

int	ell2 = 0
	spherical degree associated with the second wavevector

int	ELL = 0
	spherical degree associated with the line of sight

int	i_wa = 0
	first order of the wide-angle correction term

int	j_wa = 0
	second order of the wide-angle correction term

std::string	form = "diag"

std::string	norm_convention = "particle"

std::string	shape = "diag"

std::string	binning = "lin"

double	bin_min = 0.
	measurement range minimum (in Mpc/h or h/Mpc)

double	bin_max = 0.
	measurement range maximum (in Mpc/h or h/Mpc)

int	num_bins = 0
	number of measurement bins

int	idx_bin = 0
	fixed bin index in "off-fiag"/"row" `form` three-point measurements

std::string	fftw_scheme = "measure"
	FFTW scheme: {"estimate", "measure" (default), "patient"}.

unsigned	fftw_planner_flag = FFTW_MEASURE
	derived FFTW planner flag

std::string	use_fftw_wisdom = "false"
	use FFTW wisdom: {"false" (default), <path-to-dir>}

std::string	fftw_wisdom_file_f
	derived FFTW wisdom file paths

std::string	fftw_wisdom_file_b
	backward-transform wisdom file path

std::string	save_binned_vectors = "false"

int	verbose = 20

std::string	progbar = "false"
	display a progress bar: {"true", "false" (default), <int-%-point>}

Detailed Description

Parameter set.

This reads parameters from a file, stores and prints out the extracted parameters, and validates the parameters.

Definition at line 58 of file parameters.hpp.

Constructor & Destructor Documentation

◆ ParameterSet() [1/2]

trv::ParameterSet::ParameterSet ( )

default

Construct a parameter set.

Here is the caller graph for this function:

◆ ~ParameterSet()

trv::ParameterSet::~ParameterSet ( )

default

Destroy the parameter set.

Here is the call graph for this function:

◆ ParameterSet() [2/2]

trv::ParameterSet::ParameterSet ( const ParameterSet & other )

Construct a copied parameter set.

Parameters

other Parameter set to be copied.

Definition at line 35 of file parameters.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ read_from_file()

int trv::ParameterSet::read_from_file ( char * parameter_filepath )

Read parameters from a file.

Parameters

parameter_filepath Parameter file path.

Returns: Validation exit status.

Definition at line 94 of file parameters.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validate()

int trv::ParameterSet::validate ( bool init = false )

Validate parameters.

Parameters

init	Initialisation flag.

Returns: Exit status.

Exceptions

trv::sys::InvalidParameterError When a parameter is invalid.

Note: This method is called by trv::ParameterSet::read_from_file().

Definition at line 466 of file parameters.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print_to_file() [1/2]

int trv::ParameterSet::print_to_file ( char * out_parameter_filepath )

Print out extracted parameters to a file in the output measurement directory.

Parameters

out_parameter_filepath Printout parameter file path.

Returns: Exit status.

Definition at line 1272 of file parameters.cpp.

Here is the caller graph for this function:

◆ print_to_file() [2/2]

int trv::ParameterSet::print_to_file ( )

Print out extracted parameters to the default file path in the output measurement directory.

Returns: Exit status.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 1371 of file parameters.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ catalogue_dir

std::string trv::ParameterSet::catalogue_dir

catalogue directory

Definition at line 65 of file parameters.hpp.

◆ measurement_dir

std::string trv::ParameterSet::measurement_dir

measurement/output directory

Definition at line 67 of file parameters.hpp.

◆ data_catalogue_file

std::string trv::ParameterSet::data_catalogue_file

data catalogue file

Definition at line 69 of file parameters.hpp.

◆ rand_catalogue_file

std::string trv::ParameterSet::rand_catalogue_file

random catalogue file

Definition at line 71 of file parameters.hpp.

◆ catalogue_columns

std::string trv::ParameterSet::catalogue_columns

catalogue data column names (comma-separated list without space or attribute name string)

Definition at line 74 of file parameters.hpp.

◆ catalogue_dataset

std::string trv::ParameterSet::catalogue_dataset

catalogue dataset name/path (HDF5 catalogue files only)

Definition at line 76 of file parameters.hpp.

◆ output_tag

std::string trv::ParameterSet::output_tag

output tag

Definition at line 78 of file parameters.hpp.

◆ boxsize

double trv::ParameterSet::boxsize[3] = {0., 0., 0.}

box size (in Mpc/h) in each dimension

Definition at line 86 of file parameters.hpp.

◆ ngrid

int trv::ParameterSet::ngrid[3] = {0, 0, 0}

grid cell number in each dimension

Definition at line 88 of file parameters.hpp.

◆ expand

double trv::ParameterSet::expand = 1.

box expansion factor (if boxsize is not given)

Definition at line 90 of file parameters.hpp.

◆ cutoff_nyq

double trv::ParameterSet::cutoff_nyq = 0.

Nyquist cutoff wavenumber or separation (in Mpc/h or h/Mpc)

Nyquist cutoff (in Mpc/h or h/Mpc)

Definition at line 92 of file parameters.hpp.

◆ alignment

std::string trv::ParameterSet::alignment = "centre"

box alignment: {"centre" (default), "pad"}

Definition at line 96 of file parameters.hpp.

◆ padscale

std::string trv::ParameterSet::padscale = "box"

padding scale (if alignment is "pad"): {"box" (default), "grid"}

Definition at line 98 of file parameters.hpp.

◆ padfactor

double trv::ParameterSet::padfactor = 0.

padding factor

Definition at line 100 of file parameters.hpp.

◆ assignment

std::string trv::ParameterSet::assignment = "tsc"

mesh assignment scheme: {"ngp", "cic", "tsc" (default), "pcs"}

Definition at line 104 of file parameters.hpp.

◆ interlace

std::string trv::ParameterSet::interlace = "false"

interlacing switch: {"true"/"on", "false"/"off" (default)}

Definition at line 106 of file parameters.hpp.

◆ volume

double trv::ParameterSet::volume = 0.

box volume (in Mpc^3/h^3)

Definition at line 109 of file parameters.hpp.

◆ nmesh

long long trv::ParameterSet::nmesh

number of mesh grid cells

Definition at line 110 of file parameters.hpp.

◆ assignment_order

int trv::ParameterSet::assignment_order = 0

order of the assignment scheme

Definition at line 112 of file parameters.hpp.

◆ catalogue_type

std::string trv::ParameterSet::catalogue_type

catalogue type: {"survey", "random", "sim", "none"}

Definition at line 120 of file parameters.hpp.

◆ statistic_type

std::string trv::ParameterSet::statistic_type

statistic type: {"powspec", "2pcf", "2pcf-win", "bispec", "3pcf", "3pcf-win", "3pcf-win-wa", "modes", "pairs"}

Definition at line 123 of file parameters.hpp.

◆ npoint

std::string trv::ParameterSet::npoint

N-point case: {"2pt", "3pt", "none"}

Definition at line 126 of file parameters.hpp.

◆ space

std::string trv::ParameterSet::space

coordinate space: {"fourier", "config"}

Definition at line 127 of file parameters.hpp.

◆ ell1

int trv::ParameterSet::ell1 = 0

spherical degree associated with the first wavevector

Definition at line 131 of file parameters.hpp.

◆ ell2

int trv::ParameterSet::ell2 = 0

spherical degree associated with the second wavevector

Definition at line 133 of file parameters.hpp.

◆ ELL

int trv::ParameterSet::ELL = 0

spherical degree associated with the line of sight

Definition at line 135 of file parameters.hpp.

◆ i_wa

int trv::ParameterSet::i_wa = 0

first order of the wide-angle correction term

Definition at line 137 of file parameters.hpp.

◆ j_wa

int trv::ParameterSet::j_wa = 0

second order of the wide-angle correction term

Definition at line 138 of file parameters.hpp.

◆ form

std::string trv::ParameterSet::form = "diag"

form of the bispectrum measurement: {"full", "diag" (default), "off-diag", "row"}

Definition at line 144 of file parameters.hpp.

◆ norm_convention

std::string trv::ParameterSet::norm_convention = "particle"

normalisation convention: {"none", "particle" (default), "mesh", "mesh-mixed"}

Definition at line 148 of file parameters.hpp.

◆ shape

std::string trv::ParameterSet::shape = "diag"

shape of the 3PCF measurement: {"full", "diag" (default), "off-diag", "row", "triu"}

Definition at line 153 of file parameters.hpp.

◆ binning

std::string trv::ParameterSet::binning = "lin"

binning scheme: {"lin" (default), "log", "linpad", "logpad", "custom"}

Definition at line 158 of file parameters.hpp.

◆ bin_min

double trv::ParameterSet::bin_min = 0.

measurement range minimum (in Mpc/h or h/Mpc)

Definition at line 160 of file parameters.hpp.

◆ bin_max

double trv::ParameterSet::bin_max = 0.

measurement range maximum (in Mpc/h or h/Mpc)

Definition at line 161 of file parameters.hpp.

◆ num_bins

int trv::ParameterSet::num_bins = 0

number of measurement bins

Definition at line 164 of file parameters.hpp.

◆ idx_bin

int trv::ParameterSet::idx_bin = 0

fixed bin index in "off-fiag"/"row" form three-point measurements

Definition at line 166 of file parameters.hpp.

◆ fftw_scheme

std::string trv::ParameterSet::fftw_scheme = "measure"

FFTW scheme: {"estimate", "measure" (default), "patient"}.

Definition at line 173 of file parameters.hpp.

◆ fftw_planner_flag

unsigned trv::ParameterSet::fftw_planner_flag = FFTW_MEASURE

derived FFTW planner flag

Definition at line 176 of file parameters.hpp.

◆ use_fftw_wisdom

std::string trv::ParameterSet::use_fftw_wisdom = "false"

use FFTW wisdom: {"false" (default), <path-to-dir>}

Definition at line 179 of file parameters.hpp.

◆ fftw_wisdom_file_f

std::string trv::ParameterSet::fftw_wisdom_file_f

derived FFTW wisdom file paths

forward-transform wisdom file path

Definition at line 182 of file parameters.hpp.

◆ fftw_wisdom_file_b

std::string trv::ParameterSet::fftw_wisdom_file_b

backward-transform wisdom file path

Definition at line 183 of file parameters.hpp.

◆ save_binned_vectors

std::string trv::ParameterSet::save_binned_vectors = "false"

save flag/path for detailed binning of vectors: {"true", "false" (default), <relpath-to-file>}

Definition at line 188 of file parameters.hpp.

◆ verbose

int trv::ParameterSet::verbose = 20

logging verbosity level: {0 (NSET), 10 (DBUG), 20 (STAT) (default), 30 (INFO), 40 (WARN), 50 (ERRO)}

Definition at line 192 of file parameters.hpp.

◆ progbar

std::string trv::ParameterSet::progbar = "false"

display a progress bar: {"true", "false" (default), <int-%-point>}

Definition at line 195 of file parameters.hpp.

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

/home/docs/checkouts/readthedocs.org/user_builds/triumvirate/checkouts/latest/src/triumvirate/include/parameters.hpp
/home/docs/checkouts/readthedocs.org/user_builds/triumvirate/checkouts/latest/src/triumvirate/src/parameters.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ParameterSet() [1/2]

◆ ~ParameterSet()

◆ ParameterSet() [2/2]

Member Function Documentation

◆ read_from_file()

◆ validate()

◆ print_to_file() [1/2]

◆ print_to_file() [2/2]

Member Data Documentation

◆ catalogue_dir

◆ measurement_dir

◆ data_catalogue_file

◆ rand_catalogue_file

◆ catalogue_columns

◆ catalogue_dataset

◆ output_tag

◆ boxsize

◆ ngrid

◆ expand

◆ cutoff_nyq

◆ alignment

◆ padscale

◆ padfactor

◆ assignment

◆ interlace

◆ volume

◆ nmesh

◆ assignment_order

◆ catalogue_type

◆ statistic_type

◆ npoint

◆ space

◆ ell1

◆ ell2

◆ ELL

◆ i_wa

◆ j_wa

◆ form

◆ norm_convention

◆ shape

◆ binning

◆ bin_min

◆ bin_max

◆ num_bins

◆ idx_bin

◆ fftw_scheme

◆ fftw_planner_flag

◆ use_fftw_wisdom

◆ fftw_wisdom_file_f

◆ fftw_wisdom_file_b

◆ save_binned_vectors

◆ verbose

◆ progbar