VisionPlus_V3.0/Include/halcon/halconcpp/HDlModel.h

/***********************************************************
 * File generated by the HALCON-Compiler hcomp version 22.05
 * Usage: Interface to C++
 *
 * Software by: MVTec Software GmbH, www.mvtec.com
 ***********************************************************/


#ifndef HCPP_HDLMODEL
#define HCPP_HDLMODEL

namespace HalconCpp
{

// Represents an instance of a Deep Neural Network.
class LIntExport HDlModel : public HHandle
{

public:

  // Create an uninitialized instance
  HDlModel():HHandle() {}

  // Copy constructor
  HDlModel(const HDlModel& source) : HHandle(source) {}

  // Copy constructor
  HDlModel(const HHandle& handle);

  // Create HDlModel from handle, taking ownership
  explicit HDlModel(Hlong handle);

  bool operator==(const HHandle& obj) const
  {
    return HHandleBase::operator==(obj);
  }

  bool operator!=(const HHandle& obj) const
  {
    return HHandleBase::operator!=(obj);
  }

protected:

  // Verify matching semantic type ('dl_model')!
  virtual void AssertType(Hphandle handle) const;

public:

  // Deep copy of all data represented by this object instance
  HDlModel Clone() const;



/*****************************************************************************
 * Operator-based class constructors
 *****************************************************************************/

  // create_dl_model_detection: Create a deep learning network for object detection or instance segmentation.
  explicit HDlModel(const HString& Backbone, Hlong NumClasses, const HDict& DLModelDetectionParam);

  // create_dl_model_detection: Create a deep learning network for object detection or instance segmentation.
  explicit HDlModel(const char* Backbone, Hlong NumClasses, const HDict& DLModelDetectionParam);

#ifdef _WIN32
  // create_dl_model_detection: Create a deep learning network for object detection or instance segmentation.
  explicit HDlModel(const wchar_t* Backbone, Hlong NumClasses, const HDict& DLModelDetectionParam);
#endif

  // read_dl_model: Read a deep learning model from a file.
  explicit HDlModel(const HString& FileName);

  // read_dl_model: Read a deep learning model from a file.
  explicit HDlModel(const char* FileName);

#ifdef _WIN32
  // read_dl_model: Read a deep learning model from a file.
  explicit HDlModel(const wchar_t* FileName);
#endif

  // create_dl_model: Create a deep learning model.
  explicit HDlModel(const HDlLayerArray& OutputLayers);

  // create_dl_model: Create a deep learning model.
  explicit HDlModel(const HDlLayer& OutputLayers);




  /***************************************************************************
   * Operators                                                               *
   ***************************************************************************/

  // Apply a deep-learning-based network on a set of images for inference.
  HDictArray ApplyDlModel(const HDictArray& DLSampleBatch, const HTuple& Outputs) const;

  // Clear a deep learning model.
  static void ClearDlModel(const HDlModelArray& DLModelHandle);

  // Clear a deep learning model.
  void ClearDlModel() const;

  // Create a deep learning network for object detection or instance segmentation.
  void CreateDlModelDetection(const HString& Backbone, Hlong NumClasses, const HDict& DLModelDetectionParam);

  // Create a deep learning network for object detection or instance segmentation.
  void CreateDlModelDetection(const char* Backbone, Hlong NumClasses, const HDict& DLModelDetectionParam);

#ifdef _WIN32
  // Create a deep learning network for object detection or instance segmentation.
  void CreateDlModelDetection(const wchar_t* Backbone, Hlong NumClasses, const HDict& DLModelDetectionParam);
#endif

  // Deserialize a deep learning model.
  void DeserializeDlModel(const HSerializedItem& SerializedItemHandle);

  // Return the parameters of a deep learning model.
  HTuple GetDlModelParam(const HString& GenParamName) const;

  // Return the parameters of a deep learning model.
  HTuple GetDlModelParam(const char* GenParamName) const;

#ifdef _WIN32
  // Return the parameters of a deep learning model.
  HTuple GetDlModelParam(const wchar_t* GenParamName) const;
#endif

  // Read a deep learning model from a file.
  void ReadDlModel(const HString& FileName);

  // Read a deep learning model from a file.
  void ReadDlModel(const char* FileName);

#ifdef _WIN32
  // Read a deep learning model from a file.
  void ReadDlModel(const wchar_t* FileName);
#endif

  // Serialize a deep learning model.
  HSerializedItem SerializeDlModel() const;

  // Set the parameters of a deep learning model.
  void SetDlModelParam(const HString& GenParamName, const HTuple& GenParamValue) const;

  // Set the parameters of a deep learning model.
  void SetDlModelParam(const HString& GenParamName, Hlong GenParamValue) const;

  // Set the parameters of a deep learning model.
  void SetDlModelParam(const char* GenParamName, Hlong GenParamValue) const;

#ifdef _WIN32
  // Set the parameters of a deep learning model.
  void SetDlModelParam(const wchar_t* GenParamName, Hlong GenParamValue) const;
#endif

  // Train a deep learning model.
  HDict TrainDlModelBatch(const HDictArray& DLSampleBatch) const;

  // Write a deep learning model in a file.
  void WriteDlModel(const HString& FileName) const;

  // Write a deep learning model in a file.
  void WriteDlModel(const char* FileName) const;

#ifdef _WIN32
  // Write a deep learning model in a file.
  void WriteDlModel(const wchar_t* FileName) const;
#endif

  // Infer the sample and generate a heatmap.
  HDictArray GenDlModelHeatmap(const HDictArray& DLSample, const HString& HeatmapMethod, const HTuple& TargetClasses, const HDict& GenParam) const;

  // Infer the sample and generate a heatmap.
  HDictArray GenDlModelHeatmap(const HDictArray& DLSample, const char* HeatmapMethod, const HTuple& TargetClasses, const HDict& GenParam) const;

#ifdef _WIN32
  // Infer the sample and generate a heatmap.
  HDictArray GenDlModelHeatmap(const HDictArray& DLSample, const wchar_t* HeatmapMethod, const HTuple& TargetClasses, const HDict& GenParam) const;
#endif

  // Train a deep learning model for anomaly detection.
  HDict TrainDlModelAnomalyDataset(const HDictArray& DLSamples, const HDict& DLTrainParam) const;

  // Calculate scores to prune a deep learning model.
  void AddDlPruningBatch(const HDlPrune& DLPruningHandle, const HDictArray& DLSampleBatch) const;

  // Create a pruning data handle.
  HDlPrune CreateDlPruning(const HString& Mode, const HDict& GenParam) const;

  // Create a pruning data handle.
  HDlPrune CreateDlPruning(const char* Mode, const HDict& GenParam) const;

#ifdef _WIN32
  // Create a pruning data handle.
  HDlPrune CreateDlPruning(const wchar_t* Mode, const HDict& GenParam) const;
#endif

  // Prune a deep learning model.
  HDlModel GenDlPrunedModel(const HDlPrune& DLPruningHandle) const;

  // Optimize a model for inference on a device via the -interface.
  HDlModel OptimizeDlModelForInference(const HDlDeviceArray& DLDeviceHandle, const HString& Precision, const HDictArray& DLSamples, const HDict& GenParam, HDict* ConversionReport) const;

  // Optimize a model for inference on a device via the -interface.
  HDlModel OptimizeDlModelForInference(const HDlDevice& DLDeviceHandle, const HString& Precision, const HDictArray& DLSamples, const HDict& GenParam, HDict* ConversionReport) const;

  // Optimize a model for inference on a device via the -interface.
  HDlModel OptimizeDlModelForInference(const HDlDevice& DLDeviceHandle, const char* Precision, const HDictArray& DLSamples, const HDict& GenParam, HDict* ConversionReport) const;

#ifdef _WIN32
  // Optimize a model for inference on a device via the -interface.
  HDlModel OptimizeDlModelForInference(const HDlDevice& DLDeviceHandle, const wchar_t* Precision, const HDictArray& DLSamples, const HDict& GenParam, HDict* ConversionReport) const;
#endif

  // Create a deep learning model.
  void CreateDlModel(const HDlLayerArray& OutputLayers);

  // Create a deep learning model.
  void CreateDlModel(const HDlLayer& OutputLayers);

  // Create a deep copy of the layers and all of their graph ancestors in a given deep learning model.
  HDlLayerArray GetDlModelLayer(const HTuple& LayerNames) const;

  // Create a deep copy of the layers and all of their graph ancestors in a given deep learning model.
  HDlLayer GetDlModelLayer(const HString& LayerNames) const;

  // Create a deep copy of the layers and all of their graph ancestors in a given deep learning model.
  HDlLayer GetDlModelLayer(const char* LayerNames) const;

#ifdef _WIN32
  // Create a deep copy of the layers and all of their graph ancestors in a given deep learning model.
  HDlLayer GetDlModelLayer(const wchar_t* LayerNames) const;
#endif

  // Get the activations of a Deep Learning model layer.
  HImage GetDlModelLayerActivations(const HString& LayerName) const;

  // Get the activations of a Deep Learning model layer.
  HImage GetDlModelLayerActivations(const char* LayerName) const;

#ifdef _WIN32
  // Get the activations of a Deep Learning model layer.
  HImage GetDlModelLayerActivations(const wchar_t* LayerName) const;
#endif

  // Get the gradients of a Deep Learning model layer.
  HImage GetDlModelLayerGradients(const HString& LayerName) const;

  // Get the gradients of a Deep Learning model layer.
  HImage GetDlModelLayerGradients(const char* LayerName) const;

#ifdef _WIN32
  // Get the gradients of a Deep Learning model layer.
  HImage GetDlModelLayerGradients(const wchar_t* LayerName) const;
#endif

  // Get the weights (or values) of a Deep Learning model layer.
  HImage GetDlModelLayerWeights(const HString& LayerName, const HString& WeightsType) const;

  // Get the weights (or values) of a Deep Learning model layer.
  HImage GetDlModelLayerWeights(const char* LayerName, const char* WeightsType) const;

#ifdef _WIN32
  // Get the weights (or values) of a Deep Learning model layer.
  HImage GetDlModelLayerWeights(const wchar_t* LayerName, const wchar_t* WeightsType) const;
#endif

  // Load the weights of a source model into a target model.
  HTuple LoadDlModelWeights(const HDlModel& DLModelHandleTarget) const;

  // Set the weights (or values) of a Deep Learning model layer.
  void SetDlModelLayerWeights(const HImage& Weights, const HString& LayerName, const HString& WeightsType) const;

  // Set the weights (or values) of a Deep Learning model layer.
  void SetDlModelLayerWeights(const HImage& Weights, const char* LayerName, const char* WeightsType) const;

#ifdef _WIN32
  // Set the weights (or values) of a Deep Learning model layer.
  void SetDlModelLayerWeights(const HImage& Weights, const wchar_t* LayerName, const wchar_t* WeightsType) const;
#endif

};

// forward declarations and types for internal array implementation

template<class T> class HSmartPtr;
template<class T> class HHandleBaseArrayRef;

typedef HHandleBaseArrayRef<HDlModel> HDlModelArrayRef;
typedef HSmartPtr< HDlModelArrayRef > HDlModelArrayPtr;


// Represents multiple tool instances
class LIntExport HDlModelArray : public HHandleBaseArray
{

public:

  // Create empty array
  HDlModelArray();

  // Create array from native array of tool instances
  HDlModelArray(const HDlModel* classes, Hlong length);

  // Copy constructor
  HDlModelArray(const HDlModelArray &tool_array);

  // Destructor
  virtual ~HDlModelArray();

  // Assignment operator
  HDlModelArray &operator=(const HDlModelArray &tool_array);

  // Clears array and all tool instances
  virtual void Clear();

  // Get array of native tool instances
  const HDlModel* Tools() const;

  // Get number of tools
  virtual Hlong Length() const;

  // Create tool array from tuple of handles
  virtual void SetFromTuple(const HTuple& handles);

  // Get tuple of handles for tool array
  virtual HTuple ConvertToTuple() const;

protected:

// Smart pointer to internal data container
   HDlModelArrayPtr *mArrayPtr;
};

}

#endif