Par04/include/Par04InferenceMessenger.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 /// \file Par04InferenceMessenger.hh
0027 /// \brief Definition of the Par04InferenceMessenger class
0028
0029 #ifdef USE_INFERENCE
0030 #  ifndef PAR04INFERENCEMESSENGER_H
0031 #    define PAR04INFERENCEMESSENGER_H
0032
0033 #    include "G4UImessenger.hh"  // for G4UImessenger
0034
0035 #    include <G4String.hh>  // for G4String
0036 class G4UIcmdWithADoubleAndUnit;
0037 class G4UIcmdWithAString;
0038 class G4UIcmdWithAnInteger;
0039 class G4UIcommand;
0040 class G4UIdirectory;
0041 class Par04InferenceSetup;
0042
0043 /**
0044  * @brief Inference messenger.
0045  *
0046  * Provides UI commands to setup the inference: name of the inference library,
0047  * path to the ML model, size of the latent space, the size of the condition
0048  * vector and flags for optimization and profiling. It allows to specify the
0049  * mesh size (in cylindrical coordinates) that was used in training dataset
0050  * (full simulation).
0051  *
0052  */
0053
0054 class Par04InferenceMessenger : public G4UImessenger
0055 {
0056   public:
0057     Par04InferenceMessenger(Par04InferenceSetup*);
0058     ~Par04InferenceMessenger();
0059     /// Invokes appropriate methods based on the typed command
0060     virtual void SetNewValue(G4UIcommand*, G4String) final;
0061     /// Retrieves the current settings
0062     virtual G4String GetCurrentValue(G4UIcommand*) final;
0063
0064   private:
0065     /// Inference to setup
0066     Par04InferenceSetup* fInference = nullptr;
0067     /// Command to set the directory common to all inference messengers in this
0068     /// example /Par04
0069     G4UIdirectory* fExampleDir = nullptr;
0070     /// Command to set the directory for inference settings /Par04/inference
0071     G4UIdirectory* fInferenceDir = nullptr;
0072     /// Command to set the inference library
0073     G4UIcmdWithAString* fInferenceLibraryCmd = nullptr;
0074     /// Command to set fModelPathNameCmd
0075     G4UIcmdWithAString* fModelPathNameCmd = nullptr;
0076   /// Command to set fModelTypeCmd
0077   G4UIcmdWithAString *fModelTypeCmd = nullptr;
0078     /// Command to set the fSizeLatentVectorCmd
0079     G4UIcmdWithAnInteger* fSizeLatentVectorCmd = nullptr;
0080     /// Command to set the fSizeConditionVectorCmd
0081     G4UIcmdWithAnInteger* fSizeConditionVectorCmd = nullptr;
0082     /// Command to set the fProfileFlagCmd
0083     G4UIcmdWithAnInteger* fProfileFlagCmd = nullptr;
0084     /// Command to set the fOptimizationFlagCmd
0085     G4UIcmdWithAnInteger* fOptimizationFlagCmd = nullptr;
0086     /// Command to set the number of cells in the cylindrical readout mesh (along
0087     /// rho axis)
0088     G4UIcmdWithAnInteger* fMeshNbRhoCellsCmd = nullptr;
0089     /// Command to set the number of cells in the cylindrical readout mesh (along
0090     /// phi axis)
0091     G4UIcmdWithAnInteger* fMeshNbPhiCellsCmd = nullptr;
0092     /// Command to set the number of cells in the cylindrical readout mesh (along
0093     /// z axis)
0094     G4UIcmdWithAnInteger* fMeshNbZCellsCmd = nullptr;
0095     /// Command to the size of cells in the cylindrical readout mesh (along rho
0096     /// axis)
0097     G4UIcmdWithADoubleAndUnit* fMeshSizeRhoCellsCmd = nullptr;
0098     /// Command to the size of cells in the cylindrical readout mesh (along z
0099     /// axis)
0100     G4UIcmdWithADoubleAndUnit* fMeshSizeZCellsCmd = nullptr;
0101     /// Commands to set execution provider flags
0102     /// GPU
0103     G4UIcmdWithAnInteger* fCudaFlagCmd = nullptr;
0104     /// Cuda Commands
0105     G4UIdirectory* fCudaOptionsDir = nullptr;
0106     G4UIcmdWithAString* fCudaDeviceIdCmd = nullptr;
0107     G4UIcmdWithAString* fCudaGpuMemLimitCmd = nullptr;
0108     G4UIcmdWithAString* fCudaArenaExtendedStrategyCmd = nullptr;
0109     G4UIcmdWithAString* fCudaCudnnConvAlgoSearchCmd = nullptr;
0110     G4UIcmdWithAString* fCudaDoCopyInDefaultStreamCmd = nullptr;
0111     G4UIcmdWithAString* fCudaCudnnConvUseMaxWorkspaceCmd = nullptr;
0112 };
0113
0114 #  endif
0115 #endif