IParticleWriterConfig.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
#ifndef IPARTICLE_WRITER_CONFIG_H
#define IPARTICLE_WRITER_CONFIG_H
 
#include "Primitive.h"
 
#include <string>
#include <vector>
 
struct AssociatedPrimitive
{
  // name of ElementLink to primative, empty means the primative is on
  // our IParticle
  std::string link_name;
  Primitive input;
};
 
struct IParticleWriterConfig
{
  // name of the dataset to write
  std::string name;
 
  // array format: store awkward arrays, zero padded 2d arrays, or
  // just a flat array of particles.
  enum class ArrayFormat {AWKWARD, FLAT, PADDED};
  ArrayFormat format = ArrayFormat::FLAT;
 
  // maximum size of 2d array to write, in other words the maximum
  // particles per event
  //
  // NOTE: a special value of zero saves an awkward array
  // representation (one dataset of raw jets, another specifying the
  // offsets)
  unsigned long long maximum_size = 0;
 
  std::vector<AssociatedPrimitive> inputs;
};
 
#endif