marley::OutputFile Class Reference

Abstract base class for objects that deliver output to a file opened by the marley command-line executable. More...

#include <OutputFile.hh>

Inheritance diagram for marley::OutputFile:

Public Types
enum class	Format { ASCII , ROOT }

Public Member Functions
virtual int_fast64_t	bytes_written ()=0
	The number of bytes that have been written during the current MARLEY session to this file.
bool	mode_is_resume () const
const std::string &	name () const
virtual bool	resume (std::unique_ptr< marley::Generator > &gen, long &num_previous_events)=0
	Load a marley::Generator object whose configuration and state were saved to the metadata in the output file.
virtual void	write_event (HepMC3::GenEvent *event)=0
	Write a new HepMC3::GenEvent to this output file.

Static Public Member Functions
static std::shared_ptr< OutputFile >	make_OutputFile (const JSON &output_config)

Protected Types
enum class	Mode { OVERWRITE , RESUME }

Protected Member Functions
	OutputFile (const JSON &output_config)
bool	check_if_file_exists (const std::string &filename)
	Checks that a given file exists (and is readable)
void	prompt_before_overwrite ()
	If mode_ is OVERWRITE and the output file already exists and force_ is false, prompt the user before overwriting. If the user declines, throw a marley::Error with a diagnostic message suggesting the "force" and "mode" configuration keys.
std::unique_ptr< marley::Generator >	restore_generator (const marley::JSON &config)
	Helper function for resume() that instantiates a marley::Generator object given the previous JSON configuration object.

Static Protected Member Functions
static void	merge_reweight_provenance_weights (HepMC3::GenRunInfo &run_info, marley::Generator &gen)
	When resuming from a file that has been through one or more reweight passes, merge the reweight provenance weight calculator configurations with the original generate-time weights. Builds a combined Weighter and gives the Generator ownership. If no reweight provenance is found, this function is a no-op.

Protected Attributes
bool	force_
Format	format_
	Format to use when writing events to the file.
Mode	mode_
std::string	name_
	Name of the file to receive output.

Detailed Description

Abstract base class for objects that deliver output to a file opened by the marley command-line executable.

Definition at line 35 of file OutputFile.hh.

Member Enumeration Documentation

Format

enum class marley::OutputFile::Format

strong

Definition at line 80 of file OutputFile.hh.

{ ASCII, ROOT };

Mode

enum class marley::OutputFile::Mode

strongprotected

Definition at line 115 of file OutputFile.hh.

{ OVERWRITE, RESUME };

Constructor & Destructor Documentation

OutputFile()

marley::OutputFile::OutputFile ( const JSON & output_config )

protected

Definition at line 36 of file OutputFile.cc.

                                                       {
 
  if ( !config.has_key("file") ) throw marley::Error( "Missing file"
    " name for an output file specification in the configuration file." );
 
  name_ = config.at("file").to_string();
 
  force_ = false; // default behavior is to prompt before overwriting
  if ( config.has_key("force") ) force_ = config.at( "force" ).to_bool();
 
  std::string mode_str( "overwrite" ); // default mode is "overwrite"
  if ( config.has_key("mode") ) mode_str = config.at( "mode" ).to_string();
 
  if ( mode_str == "overwrite" ) mode_ = Mode::OVERWRITE;
  else if ( mode_str == "resume" ) mode_ = Mode::RESUME;
  else throw marley::Error( "Invalid output mode \"" + mode_str
    + "\" given in an output file specification" );
}

Member Function Documentation

bytes_written()

virtual int_fast64_t marley::OutputFile::bytes_written ( )

pure virtual

The number of bytes that have been written during the current MARLEY session to this file.

Implemented in marley::OutputFileAscii, and marley::OutputFileRoot.

check_if_file_exists()

bool marley::OutputFile::check_if_file_exists ( const std::string & filename )

inlineprotected

Checks that a given file exists (and is readable)

Definition at line 85 of file OutputFile.hh.

                                                                    {
        std::ifstream test_stream( filename );
        return test_stream.good();
      }

Referenced by marley::OutputFileAscii::open(), marley::OutputFileRoot::open(), and prompt_before_overwrite().

make_OutputFile()

std::shared_ptr< marley::OutputFile > marley::OutputFile::make_OutputFile ( const JSON & output_config )

static

Definition at line 120 of file OutputFile.cc.

{
  if ( !output_config.has_key("format") ) throw marley::Error( "Missing format"
    " for an output file specification in the configuration file." );
 
  std::string format = output_config.at( "format" ).to_string();
 
  if ( format == "ascii" ) {
    auto out = std::make_shared< marley::OutputFileAscii >( output_config );
    MARLEY_LOG( INFO, "io" ) << "Opened output file \"" << out->name()
      << "\" (format: ascii)";
    return out;
  }
  #ifdef USE_ROOT
  else if ( format == "root" ) {
    auto out = std::make_shared< marley::OutputFileRoot >( output_config );
    MARLEY_LOG( INFO, "io" ) << "Opened output file \"" << out->name()
      << "\" (format: root)";
    return out;
  }
  #endif
  else throw marley::Error( "Invalid output file format \"" + format
    + "\" given in an output file specification" );
}

merge_reweight_provenance_weights()

void marley::OutputFile::merge_reweight_provenance_weights ( HepMC3::GenRunInfo & run_info, marley::Generator & gen )

staticprotected

When resuming from a file that has been through one or more reweight passes, merge the reweight provenance weight calculator configurations with the original generate-time weights. Builds a combined Weighter and gives the Generator ownership. If no reweight provenance is found, this function is a no-op.

Definition at line 80 of file OutputFile.cc.

{
  auto count_attr = run_info.attribute< HepMC3::IntAttribute >(
    "MARLEY.ReweightConfig.count" );
  if ( !count_attr ) return;
  int rw_count = count_attr->value();
  if ( rw_count == 0 ) return;
 
  auto config_attr = run_info.attribute< HepMC3::StringAttribute >(
    "MARLEY.JSONconfig" );
  if ( !config_attr ) return;
 
  marley::JSON gen_json = marley::JSON::load( config_attr->value() );
 
  marley::JSON combined_weights = marley::JSON::array();
  if ( gen_json.has_key("weights") && gen_json.at("weights").is_array() ) {
    for ( const auto& w : gen_json.at("weights").array_range() )
      combined_weights.append( w );
  }
 
  for ( int i = 0; i < rw_count; ++i ) {
    auto rw_attr = run_info.attribute< HepMC3::StringAttribute >(
      "MARLEY.ReweightConfig." + std::to_string( i ) );
    if ( !rw_attr ) continue;
 
    marley::JSON rw_json = marley::JSON::load( rw_attr->value() );
    if ( rw_json.has_key("weights") && rw_json.at("weights").is_array() ) {
      for ( const auto& w : rw_json.at("weights").array_range() )
        combined_weights.append( w );
    }
  }
 
  auto combined_weighter = std::make_shared< marley::Weighter >(
    combined_weights, gen );
  gen.set_weighter( combined_weighter );
}

References HepMC3::GenRunInfo::attribute(), marley::Generator::set_weighter(), and HepMC3::IntAttribute::value().

Referenced by marley::OutputFileAscii::resume(), and marley::OutputFileRoot::resume().

mode_is_resume()

bool marley::OutputFile::mode_is_resume ( ) const

inline

Definition at line 74 of file OutputFile.hh.

{ return mode_ == Mode::RESUME; }

name()

const std::string & marley::OutputFile::name ( ) const

inline

Definition at line 52 of file OutputFile.hh.

{ return name_; }

prompt_before_overwrite()

void marley::OutputFile::prompt_before_overwrite ( )

protected

If mode_ is OVERWRITE and the output file already exists and force_ is false, prompt the user before overwriting. If the user declines, throw a marley::Error with a diagnostic message suggesting the "force" and "mode" configuration keys.

Definition at line 63 of file OutputFile.cc.

                                               {
  if ( mode_ == Mode::OVERWRITE && check_if_file_exists( name_ )
    && !force_ )
  {
    bool overwrite = marley_utils::prompt_yes_no(
      "Overwrite file " + name_ );
    if ( !overwrite ) {
      throw marley::Error( "The output file \"" + name_
        + "\" already exists. To overwrite it automatically,"
        " add \"force\": true to this output file's"
        " configuration entry. To append new events to the"
        " existing file, use \"mode\": \"resume\" instead"
        " of \"mode\": \"overwrite\"." );
    }
  }
}

References check_if_file_exists(), and name_.

Referenced by marley::OutputFileAscii::open(), and marley::OutputFileRoot::open().

restore_generator()

std::unique_ptr< marley::Generator > marley::OutputFile::restore_generator ( const marley::JSON & config )

protected

Helper function for resume() that instantiates a marley::Generator object given the previous JSON configuration object.

Definition at line 55 of file OutputFile.cc.

{
  marley::JSONConfig jc( config );
  auto gen = std::make_unique< marley::Generator >( jc.create_generator() );
  return gen;
}

Referenced by marley::OutputFileAscii::resume(), and marley::OutputFileRoot::resume().

resume()

virtual bool marley::OutputFile::resume ( std::unique_ptr< marley::Generator > & gen, long & num_previous_events )

pure virtual

Load a marley::Generator object whose configuration and state were saved to the metadata in the output file.

Parameters

[out]	gen	A std::unique_ptr that will be filled with a restored Generator object constructed using the saved metadata
[out]	num_previous_events	The number of events previously saved to the output file

Returns

true if the Generator is successfully restored using the file's saved metadata, or false otherwise.

Implemented in marley::OutputFileAscii, and marley::OutputFileRoot.

write_event()

virtual void marley::OutputFile::write_event ( HepMC3::GenEvent * event )

pure virtual

Write a new HepMC3::GenEvent to this output file.

If a nullptr is passed to this function, then a marley::Error will be thrown

Implemented in marley::OutputFileAscii, and marley::OutputFileRoot.

Member Data Documentation

force_

bool marley::OutputFile::force_

protected

Definition at line 123 of file OutputFile.hh.

format_

Format marley::OutputFile::format_

protected

Format to use when writing events to the file.

Definition at line 118 of file OutputFile.hh.

mode_

Mode marley::OutputFile::mode_

protected

Definition at line 119 of file OutputFile.hh.

name_

std::string marley::OutputFile::name_

protected

Name of the file to receive output.

Definition at line 117 of file OutputFile.hh.

Referenced by marley::OutputFileAscii::open(), marley::OutputFileRoot::open(), prompt_before_overwrite(), marley::OutputFileAscii::resume(), marley::OutputFileRoot::resume(), and marley::OutputFileAscii::write_event().

---

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

• /home/sjg/Desktop/marley/include/marley/OutputFile.hh
• /home/sjg/Desktop/marley/src/OutputFile.cc