VNetworkBase.h

Go to the documentation of this file.

#ifndef VNETWORKBASE_H
#define VNETWORKBASE_H
 
// For conversion to ostream
#include <iostream>
#include <map>
 
// For reading and writing
#include "TFile.h"
#include "TTree.h"
 
// For messaging
#include "ISF_FastCaloSimEvent/MLogging.h"

class VNetworkBase : public ISF_FCS::MLogging {
public:
  VNetworkBase();
 
  // explicit = Don't let this do implicit type conversion
  explicit VNetworkBase(const std::string &inputFile);

  VNetworkBase(const VNetworkBase &copy_from);
 
  // virtual destructor, to ensure that it is always called, even
  // when a base class is deleted via a pointer to a derived class
  virtual ~VNetworkBase();
 
  // same as for lwtnn
  typedef std::map<std::string, std::map<std::string, double>> NetworkInputs;
  typedef std::map<std::string, double> NetworkOutputs;

  static std::string representNetworkInputs(NetworkInputs const &inputs,
                                            int maxValues = 3);

  static std::string representNetworkOutputs(NetworkOutputs const &outputs,
                                             int maxValues = 3);
 
  // pure virtual, derived classes must impement this
  virtual NetworkOutputs compute(NetworkInputs const &inputs) const = 0;
 
  // Conversion to ostream
  // It's not possible to have a virtual friend function
  // so instead, have a friend function that calls a virtual protected method
  friend std::ostream &operator<<(std::ostream &strm,
                                  const VNetworkBase &vNetworkBase) {
    vNetworkBase.print(strm);
    return strm;
  }

  virtual void writeNetToTTree(TTree &tree) = 0;

  inline static const std::string m_defaultTreeName = "onnxruntime_session";

  void writeNetToTTree(TFile &root_file,
                       std::string const &tree_name = m_defaultTreeName);

  void writeNetToTTree(std::string const &root_name,
                       std::string const &tree_name = m_defaultTreeName);

  virtual std::vector<std::string> getOutputLayers() const = 0;

  static bool isFile(std::string const &inputFile);

  bool isFile() const;

  virtual void deleteAllButNet() = 0;
 
protected:
  std::string m_inputFile;

  virtual void setupPersistedVariables() = 0;

  virtual void setupNet() = 0;

  virtual void print(std::ostream &strm) const;

  bool isRootFile(std::string const &filename = "") const;

  void removePrefixes(NetworkOutputs &outputs) const;

  void removePrefixes(std::vector<std::string> &output_names) const;
 
private:
  // Suppling a ClassDef for writing to file.
  ClassDef(VNetworkBase, 1);
};
 
#endif