Par04/include/Par04InferenceInterface.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 #ifdef USE_INFERENCE
0027 #  ifndef PAR04INFERENCEINTERFACE_HH
0028 #    define PAR04INFERENCEINTERFACE_HH
0029
0030 #    include "globals.hh"
0031
0032 #    include <vector>
0033
0034 /**
0035  * @brief Inference interface
0036  *
0037  * Base class interface that allows to read in ML models and run the inference.
0038  *
0039  */
0040
0041 class Par04InferenceInterface
0042 {
0043   public:
0044     virtual ~Par04InferenceInterface() {};
0045
0046     /// Run inference
0047     /// @param[in] aGenVector Input latent space and conditions
0048     /// @param[out] aEnergies Model output = generated shower energies
0049     /// @param[in] aSize Size of the output
0050     virtual void RunInference(std::vector<float> aGenVector, std::vector<G4double>& aEnergies,
0051                               int aSize) = 0;
0052 };
0053
0054 #  endif /* PAR04INFERENCEINTERFACE_HH */
0055 #endif