LArSoft  v07_13_02
Liquid Argon Software toolkit - http://larsoft.org/
evgen::MarleyTimeGen::Config Struct Reference

Collection of configuration parameters for the module. More...

Public Attributes

fhicl::Table< evgen::ActiveVolumeVertexSampler::Configvertex_
 
fhicl::Table< evgen::MARLEYHelper::Configmarley_parameters_
 
fhicl::Atom< std::string > module_type_
 
fhicl::Atom< std::string > sampling_mode_
 
fhicl::Atom< unsigned int > nu_per_event_
 
fhicl::Atom< std::string > spectrum_file_format_
 
fhicl::Atom< std::string > spectrum_file_
 
fhicl::OptionalAtom< std::string > pinching_parameter_type_
 
fhicl::OptionalAtom< std::string > namecycle_
 
fhicl::OptionalAtom< double > fit_Emin_
 
fhicl::OptionalAtom< double > fit_Emax_
 

Detailed Description

Collection of configuration parameters for the module.

Definition at line 123 of file MARLEYTimeGen_module.cc.

Member Data Documentation

fhicl::OptionalAtom<double> evgen::MarleyTimeGen::Config::fit_Emax_
Initial value:
{
Name("fit_Emax"),
Comment("Maximum allowed neutrino energy (MeV) for a \"fit\" format"
" spectrum file"),
[this]() -> bool {
auto spectrum_file_format
= marley_utils::to_lowercase(spectrum_file_format_());
return (spectrum_file_format == "fit");
}
}

Definition at line 213 of file MARLEYTimeGen_module.cc.

fhicl::OptionalAtom<double> evgen::MarleyTimeGen::Config::fit_Emin_
Initial value:
{
Name("fit_Emin"),
Comment("Minimum allowed neutrino energy (MeV) for a \"fit\" format"
" spectrum file"),
[this]() -> bool {
auto spectrum_file_format
= marley_utils::to_lowercase(spectrum_file_format_());
return (spectrum_file_format == "fit");
}
}

Definition at line 202 of file MARLEYTimeGen_module.cc.

fhicl::Table<evgen::MARLEYHelper::Config> evgen::MarleyTimeGen::Config::marley_parameters_
Initial value:
{
Name("marley_parameters"),
Comment("Configuration for the MARLEY generator. Note that for"
" MARLEYTimeGen, the source configuration given here is ignored.")
}

Definition at line 130 of file MARLEYTimeGen_module.cc.

fhicl::Atom<std::string> evgen::MarleyTimeGen::Config::module_type_
Initial value:
{
Name("module_type"),
Comment(""),
"MARLEYTimeGen"
}

Definition at line 136 of file MARLEYTimeGen_module.cc.

fhicl::OptionalAtom<std::string> evgen::MarleyTimeGen::Config::namecycle_
Initial value:
{
Name("namecycle"),
Comment("Name of the TH2D object to use to represent the"
" incident neutrino spectrum. This value should match the"
" name of the TH2D as given in the ROOT file specified"
" in the \"spectrum_file\" parameter. The TH2D should use "
" time bins on the X axis (seconds) and energy bins on the "
" Y axis (MeV)."),
[this]() -> bool {
auto spectrum_file_format
= marley_utils::to_lowercase(spectrum_file_format_());
return (spectrum_file_format == "th2d");
}
}

Definition at line 187 of file MARLEYTimeGen_module.cc.

fhicl::Atom<unsigned int> evgen::MarleyTimeGen::Config::nu_per_event_
Initial value:
{
Name("nu_per_event"),
Comment("The number of neutrino vertices to generate in"
" each art::Event"),
1u
}

Definition at line 150 of file MARLEYTimeGen_module.cc.

fhicl::OptionalAtom<std::string> evgen::MarleyTimeGen::Config::pinching_parameter_type_
Initial value:
{
Name("pinching_parameter_type"),
Comment("Type of pinching parameter to assume when parsing"
" the time-dependent fit parameters for the incident neutrino"
" spectrum. Valid options are \"alpha\" and \"beta\". This"
" parameter is not case-sensitive."),
[this]() -> bool {
auto spectrum_file_format
= marley_utils::to_lowercase(spectrum_file_format_());
return (spectrum_file_format == "fit");
}
}

Definition at line 174 of file MARLEYTimeGen_module.cc.

fhicl::Atom<std::string> evgen::MarleyTimeGen::Config::sampling_mode_
Initial value:
{
Name("sampling_mode"),
Comment("Technique to use when sampling times and energies. Valid"
" options are \"histogram\", \"uniform time\","
" and \"uniform energy\""),
std::string("histogram")
}

Definition at line 142 of file MARLEYTimeGen_module.cc.

fhicl::Atom<std::string> evgen::MarleyTimeGen::Config::spectrum_file_
Initial value:
{
Name("spectrum_file"),
Comment("Name of a file that contains a representation"
" of the incident (not cross section weighted) neutrino spectrum"
" as a function of time and energy.")
}

Definition at line 167 of file MARLEYTimeGen_module.cc.

fhicl::Atom<std::string> evgen::MarleyTimeGen::Config::spectrum_file_format_
Initial value:
{
Name("spectrum_file_format"),
Comment("Format to assume for the neutrino spectrum file."
" Valid options are \"th2d\" (a ROOT file containing a "
" TH2D object) and \"fit\" (an ASCII text file containing"
" fit parameters for each time bin). This parameter is not"
" case-sensitive."),
"th2d"
}

Definition at line 157 of file MARLEYTimeGen_module.cc.

fhicl::Table<evgen::ActiveVolumeVertexSampler::Config> evgen::MarleyTimeGen::Config::vertex_
Initial value:
{
Name("vertex"),
Comment("Configuration for selecting the vertex location(s)")
}

Definition at line 125 of file MARLEYTimeGen_module.cc.


The documentation for this struct was generated from the following file: