diff --git a/csharp/fastdeploy/enum_varaibles.cs b/csharp/fastdeploy/enum_varaibles.cs index b0888b71c..65029e06f 100644 --- a/csharp/fastdeploy/enum_varaibles.cs +++ b/csharp/fastdeploy/enum_varaibles.cs @@ -24,20 +24,20 @@ public enum ModelFormat { } public enum rknpu2_CpuName { - RK356X = 0, /* run on RK356X. */ - RK3588 = 1, /* default,run on RK3588. */ + RK356X = 0, ///< run on RK356X. + RK3588 = 1, ///< default,run on RK3588. UNDEFINED, } public enum rknpu2_CoreMask { - RKNN_NPU_CORE_AUTO = 0, //< default, run on NPU core randomly. - RKNN_NPU_CORE_0 = 1, //< run on NPU core 0. - RKNN_NPU_CORE_1 = 2, //< run on NPU core 1. - RKNN_NPU_CORE_2 = 4, //< run on NPU core 2. + RKNN_NPU_CORE_AUTO = 0, ///< default, run on NPU core randomly. + RKNN_NPU_CORE_0 = 1, ///< run on NPU core 0. + RKNN_NPU_CORE_1 = 2, ///< run on NPU core 1. + RKNN_NPU_CORE_2 = 4, ///< run on NPU core 2. RKNN_NPU_CORE_0_1 = - RKNN_NPU_CORE_0 | RKNN_NPU_CORE_1, //< run on NPU core 1 and core 2. + RKNN_NPU_CORE_0 | RKNN_NPU_CORE_1, ///< run on NPU core 1 and core 2. RKNN_NPU_CORE_0_1_2 = - RKNN_NPU_CORE_0_1 | RKNN_NPU_CORE_2, //< run on NPU core 1 and core 2. + RKNN_NPU_CORE_0_1 | RKNN_NPU_CORE_2, ///< run on NPU core 1 and core 2. RKNN_NPU_CORE_UNDEFINED, } diff --git a/csharp/fastdeploy/runtime_option.cs b/csharp/fastdeploy/runtime_option.cs index 781365558..f25c9dbd7 100644 --- a/csharp/fastdeploy/runtime_option.cs +++ b/csharp/fastdeploy/runtime_option.cs @@ -18,6 +18,8 @@ using System.Runtime.InteropServices; namespace fastdeploy { +/*! @brief Option object used when create a new Runtime object + */ public class RuntimeOption { public RuntimeOption() { @@ -28,26 +30,41 @@ public class RuntimeOption { FD_C_DestroyRuntimeOptionWrapper(fd_runtime_option_wrapper); } + /** \brief Set path of model file and parameter file + * + * \param[in] model_path Path of model file, e.g ResNet50/model.pdmodel for Paddle format model / ResNet50/model.onnx for ONNX format model + * \param[in] params_path Path of parameter file, this only used when the model format is Paddle, e.g Resnet50/model.pdiparams + * \param[in] format Format of the loaded model + */ public void SetModelPath(string model_path, string params_path = "", ModelFormat format = ModelFormat.PADDLE) { FD_C_RuntimeOptionWrapperSetModelPath(fd_runtime_option_wrapper, model_path, params_path, format); } + /** \brief Specify the memory buffer of model and parameter. Used when model and params are loaded directly from memory + * + * \param[in] model_buffer The string of model memory buffer + * \param[in] params_buffer The string of parameters memory buffer + * \param[in] format Format of the loaded model + */ public void SetModelBuffer(string model_buffer, string params_buffer = "", ModelFormat format = ModelFormat.PADDLE) { FD_C_RuntimeOptionWrapperSetModelBuffer( fd_runtime_option_wrapper, model_buffer, params_buffer, format); } + /// Use cpu to inference, the runtime will inference on CPU by default public void UseCpu() { FD_C_RuntimeOptionWrapperUseCpu(fd_runtime_option_wrapper); } + /// Use Nvidia GPU to inference public void UseGpu(int gpu_id = 0) { FD_C_RuntimeOptionWrapperUseGpu(fd_runtime_option_wrapper, gpu_id); } + /// Use RKNPU2 e.g RK3588/RK356X to inference public void UseRKNPU2(rknpu2_CpuName rknpu2_name = rknpu2_CpuName.RK3588, rknpu2_CoreMask rknpu2_core = rknpu2_CoreMask.RKNN_NPU_CORE_0) { @@ -55,14 +72,38 @@ public class RuntimeOption { rknpu2_core); } + /// Use TimVX e.g RV1126/A311D to inference public void UseTimVX() { FD_C_RuntimeOptionWrapperUseTimVX(fd_runtime_option_wrapper); } + /// Use Huawei Ascend to inference public void UseAscend() { FD_C_RuntimeOptionWrapperUseAscend(fd_runtime_option_wrapper); } + /// \brief Turn on KunlunXin XPU. + /// + /// \param kunlunxin_id the KunlunXin XPU card to use (default is 0). + /// \param l3_workspace_size The size of the video memory allocated by the l3 + /// cache, the maximum is 16M. + /// \param locked Whether the allocated L3 cache can be locked. If false, + /// it means that the L3 cache is not locked, and the allocated L3 + /// cache can be shared by multiple models, and multiple models + /// sharing the L3 cache will be executed sequentially on the card. + /// \param autotune Whether to autotune the conv operator in the model. If + /// true, when the conv operator of a certain dimension is executed + /// for the first time, it will automatically search for a better + /// algorithm to improve the performance of subsequent conv operators + /// of the same dimension. + /// \param autotune_file Specify the path of the autotune file. If + /// autotune_file is specified, the algorithm specified in the + /// file will be used and autotune will not be performed again. + /// \param precision Calculation accuracy of multi_encoder + /// \param adaptive_seqlen Is the input of multi_encoder variable length + /// \param enable_multi_stream Whether to enable the multi stream of + /// KunlunXin XPU. + /// public void UseKunlunXin(int kunlunxin_id = 0, int l3_workspace_size = 0xfffc00, bool locked = false, bool autotune = true, @@ -74,6 +115,7 @@ public class RuntimeOption { enable_multi_stream); } + /// Use Sophgo to inference public void UseSophgo() { FD_C_RuntimeOptionWrapperUseSophgo(fd_runtime_option_wrapper); } @@ -83,6 +125,9 @@ public class RuntimeOption { external_stream); } + /* + * @brief Set number of cpu threads while inference on CPU, by default it will decided by the different backends + */ public void SetCpuThreadNum(int thread_num) { FD_C_RuntimeOptionWrapperSetCpuThreadNum(fd_runtime_option_wrapper, thread_num); @@ -97,38 +142,47 @@ public class RuntimeOption { FD_C_RuntimeOptionWrapperUsePaddleBackend(fd_runtime_option_wrapper); } + /// Set Paddle Inference as inference backend, support CPU/GPU public void UsePaddleInferBackend() { FD_C_RuntimeOptionWrapperUsePaddleInferBackend(fd_runtime_option_wrapper); } + /// Set ONNX Runtime as inference backend, support CPU/GPU public void UseOrtBackend() { FD_C_RuntimeOptionWrapperUseOrtBackend(fd_runtime_option_wrapper); } + /// Set SOPHGO Runtime as inference backend, support SOPHGO public void UseSophgoBackend() { FD_C_RuntimeOptionWrapperUseSophgoBackend(fd_runtime_option_wrapper); } + /// Set TensorRT as inference backend, only support GPU public void UseTrtBackend() { FD_C_RuntimeOptionWrapperUseTrtBackend(fd_runtime_option_wrapper); } + /// Set Poros backend as inference backend, support CPU/GPU public void UsePorosBackend() { FD_C_RuntimeOptionWrapperUsePorosBackend(fd_runtime_option_wrapper); } + /// Set OpenVINO as inference backend, only support CPU public void UseOpenVINOBackend() { FD_C_RuntimeOptionWrapperUseOpenVINOBackend(fd_runtime_option_wrapper); } + /// Set Paddle Lite as inference backend, only support arm cpu public void UseLiteBackend() { FD_C_RuntimeOptionWrapperUseLiteBackend(fd_runtime_option_wrapper); } + /// Set Paddle Lite as inference backend, only support arm cpu public void UsePaddleLiteBackend() { FD_C_RuntimeOptionWrapperUsePaddleLiteBackend(fd_runtime_option_wrapper); } + public void SetPaddleMKLDNN(bool pd_mkldnn = true) { FD_C_RuntimeOptionWrapperSetPaddleMKLDNN(fd_runtime_option_wrapper, pd_mkldnn); diff --git a/csharp/fastdeploy/vision/classification/ppcls/model.cs b/csharp/fastdeploy/vision/classification/ppcls/model.cs index fa2ad13aa..1e3082704 100644 --- a/csharp/fastdeploy/vision/classification/ppcls/model.cs +++ b/csharp/fastdeploy/vision/classification/ppcls/model.cs @@ -23,8 +23,18 @@ namespace fastdeploy { namespace vision { namespace classification { +/*! @brief PaddleClas serials model object used when to load a PaddleClas model exported by PaddleClas repository + */ public class PaddleClasModel { + /** \brief Set path of model file and configuration file, and the configuration of runtime + * + * \param[in] model_file Path of model file, e.g resnet/model.pdmodel + * \param[in] params_file Path of parameter file, e.g resnet/model.pdiparams, if the model format is ONNX, this parameter will be ignored + * \param[in] config_file Path of configuration file for deployment, e.g resnet/infer_cfg.yml + * \param[in] custom_option RuntimeOption for inference, the default will use cpu, and choose the backend defined in `valid_cpu_backends` + * \param[in] model_format Model format of the loaded model, default is Paddle format + */ public PaddleClasModel(string model_file, string params_file, string config_file, RuntimeOption custom_option = null, ModelFormat model_format = ModelFormat.PADDLE) { @@ -40,11 +50,17 @@ public class PaddleClasModel { FD_C_DestroyPaddleClasModelWrapper(fd_paddleclas_model_wrapper); } - + /// Get model's name public string ModelName() { return "PaddleClas/Model"; } + /** \brief DEPRECATED Predict the classification result for an input image, remove at 1.0 version + * + * \param[in] im The input image data, comes from cv::imread() + * + * \return ClassifyResult + */ public ClassifyResult Predict(Mat img) { FD_ClassifyResult fd_classify_result = new FD_ClassifyResult(); if(! FD_C_PaddleClasModelWrapperPredict( @@ -59,6 +75,12 @@ public class PaddleClasModel { return classify_result; } + /** \brief Predict the classification results for a batch of input images + * + * \param[in] imgs, The input image list, each element comes from cv::imread() + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -86,6 +108,7 @@ public class PaddleClasModel { return results_out; } + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_PaddleClasModelWrapperInitialized(fd_paddleclas_model_wrapper); } diff --git a/csharp/fastdeploy/vision/detection/contrib/model.cs b/csharp/fastdeploy/vision/detection/contrib/model.cs index d207615d8..c236f3184 100644 --- a/csharp/fastdeploy/vision/detection/contrib/model.cs +++ b/csharp/fastdeploy/vision/detection/contrib/model.cs @@ -24,6 +24,9 @@ namespace vision { namespace detection { // YOLOv5 + +/*! @brief YOLOv5 model + */ public class YOLOv5 { public YOLOv5( string model_file, string params_file, @@ -39,6 +42,12 @@ public class YOLOv5 { ~YOLOv5() { FD_C_DestroyYOLOv5Wrapper(fd_yolov5_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_YOLOv5WrapperPredict(fd_yolov5_wrapper, img.CvPtr, @@ -53,6 +62,12 @@ public class YOLOv5 { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -80,6 +95,8 @@ public class YOLOv5 { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_YOLOv5WrapperInitialized(fd_yolov5_wrapper); } @@ -123,6 +140,9 @@ public class YOLOv5 { // YOLOv7 + +/*! @brief YOLOv7 model + */ public class YOLOv7 { public YOLOv7( string model_file, string params_file, @@ -138,6 +158,12 @@ public class YOLOv7 { ~YOLOv7() { FD_C_DestroyYOLOv7Wrapper(fd_yolov7_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_YOLOv7WrapperPredict(fd_yolov7_wrapper, img.CvPtr, @@ -152,6 +178,12 @@ public class YOLOv7 { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -179,6 +211,8 @@ public class YOLOv7 { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_YOLOv7WrapperInitialized(fd_yolov7_wrapper); } @@ -221,6 +255,9 @@ public class YOLOv7 { // YOLOv8 + +/*! @brief YOLOv8 model + */ public class YOLOv8 { public YOLOv8( string model_file, string params_file, @@ -236,6 +273,12 @@ public class YOLOv8 { ~YOLOv8() { FD_C_DestroyYOLOv8Wrapper(fd_yolov8_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_YOLOv8WrapperPredict(fd_yolov8_wrapper, img.CvPtr, @@ -250,6 +293,12 @@ public class YOLOv8 { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -277,6 +326,8 @@ public class YOLOv8 { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_YOLOv8WrapperInitialized(fd_yolov8_wrapper); } @@ -321,6 +372,9 @@ public class YOLOv8 { // YOLOv6 + +/*! @brief YOLOv6 model + */ public class YOLOv6 { public YOLOv6( string model_file, string params_file, @@ -352,6 +406,8 @@ public class YOLOv6 { return detection_result; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_YOLOv6WrapperInitialized(fd_yolov6_wrapper); } @@ -390,6 +446,9 @@ public class YOLOv6 { // YOLOR + +/*! @brief YOLOR model + */ public class YOLOR { public YOLOR( string model_file, string params_file, @@ -421,6 +480,8 @@ public class YOLOR { return detection_result; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_YOLORWrapperInitialized(fd_yolor_wrapper); } @@ -460,6 +521,9 @@ public class YOLOR { // YOLOX + +/*! @brief YOLOX model + */ public class YOLOX { public YOLOX( string model_file, string params_file, @@ -491,6 +555,8 @@ public class YOLOX { return detection_result; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_YOLOXWrapperInitialized(fd_yolox_wrapper); } diff --git a/csharp/fastdeploy/vision/detection/ppdet/model.cs b/csharp/fastdeploy/vision/detection/ppdet/model.cs index db26e5621..11aaa64d6 100644 --- a/csharp/fastdeploy/vision/detection/ppdet/model.cs +++ b/csharp/fastdeploy/vision/detection/ppdet/model.cs @@ -23,9 +23,17 @@ namespace fastdeploy { namespace vision { namespace detection { -// PPYOLOE +/*! @brief PPYOLOE model + */ public class PPYOLOE { - + /** \brief Set path of model file and configuration file, and the configuration of runtime + * + * \param[in] model_file Path of model file, e.g ppyoloe/model.pdmodel + * \param[in] params_file Path of parameter file, e.g picodet/model.pdiparams, if the model format is ONNX, this parameter will be ignored + * \param[in] config_file Path of configuration file for deployment, e.g picodet/infer_cfg.yml + * \param[in] custom_option RuntimeOption for inference, the default will use cpu, and choose the backend defined in `valid_cpu_backends` + * \param[in] model_format Model format of the loaded model, default is Paddle format + */ public PPYOLOE(string model_file, string params_file, string config_file, RuntimeOption custom_option = null, ModelFormat model_format = ModelFormat.PADDLE) { @@ -39,6 +47,11 @@ public class PPYOLOE { ~PPYOLOE() { FD_C_DestroyPPYOLOEWrapper(fd_ppyoloe_wrapper); } + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_PPYOLOEWrapperPredict(fd_ppyoloe_wrapper, img.CvPtr, @@ -53,6 +66,11 @@ public class PPYOLOE { return detection_result; } + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -80,6 +98,7 @@ public class PPYOLOE { return results_out; } + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_PPYOLOEWrapperInitialized(fd_ppyoloe_wrapper); } @@ -129,6 +148,9 @@ public class PPYOLOE { } // PicoDet + +/*! @brief PicoDet model + */ public class PicoDet { public PicoDet(string model_file, string params_file, string config_file, @@ -144,6 +166,12 @@ public class PicoDet { ~PicoDet() { FD_C_DestroyPicoDetWrapper(fd_picodet_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_PicoDetWrapperPredict(fd_picodet_wrapper, img.CvPtr, @@ -158,6 +186,12 @@ public class PicoDet { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -185,6 +219,8 @@ public class PicoDet { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_PicoDetWrapperInitialized(fd_picodet_wrapper); } @@ -236,6 +272,9 @@ public class PicoDet { // PPYOLO + +/*! @brief PPYOLO model + */ public class PPYOLO { public PPYOLO(string model_file, string params_file, string config_file, @@ -251,6 +290,12 @@ public class PPYOLO { ~PPYOLO() { FD_C_DestroyPPYOLOWrapper(fd_ppyolo_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_PPYOLOWrapperPredict(fd_ppyolo_wrapper, img.CvPtr, @@ -265,6 +310,12 @@ public class PPYOLO { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -292,6 +343,8 @@ public class PPYOLO { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_PPYOLOWrapperInitialized(fd_ppyolo_wrapper); } @@ -342,6 +395,9 @@ public class PPYOLO { // YOLOv3 + +/*! @brief YOLOv3 model + */ public class YOLOv3 { public YOLOv3(string model_file, string params_file, string config_file, @@ -357,6 +413,12 @@ public class YOLOv3 { ~YOLOv3() { FD_C_DestroyYOLOv3Wrapper(fd_yolov3_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_YOLOv3WrapperPredict(fd_yolov3_wrapper, img.CvPtr, @@ -371,6 +433,12 @@ public class YOLOv3 { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -398,6 +466,8 @@ public class YOLOv3 { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_YOLOv3WrapperInitialized(fd_yolov3_wrapper); } @@ -448,6 +518,9 @@ public class YOLOv3 { // PaddleYOLOX + +/*! @brief PaddleYOLOX model + */ public class PaddleYOLOX { public PaddleYOLOX(string model_file, string params_file, string config_file, @@ -463,6 +536,12 @@ public class PaddleYOLOX { ~PaddleYOLOX() { FD_C_DestroyPaddleYOLOXWrapper(fd_paddleyolox_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_PaddleYOLOXWrapperPredict(fd_paddleyolox_wrapper, img.CvPtr, @@ -477,6 +556,12 @@ public class PaddleYOLOX { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -504,6 +589,8 @@ public class PaddleYOLOX { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_PaddleYOLOXWrapperInitialized(fd_paddleyolox_wrapper); } @@ -554,6 +641,9 @@ public class PaddleYOLOX { // FasterRCNN + +/*! @brief FasterRCNN model + */ public class FasterRCNN { public FasterRCNN(string model_file, string params_file, string config_file, @@ -569,6 +659,12 @@ public class FasterRCNN { ~FasterRCNN() { FD_C_DestroyFasterRCNNWrapper(fd_fasterrcnn_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_FasterRCNNWrapperPredict(fd_fasterrcnn_wrapper, img.CvPtr, @@ -583,6 +679,12 @@ public class FasterRCNN { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -610,6 +712,8 @@ public class FasterRCNN { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_FasterRCNNWrapperInitialized(fd_fasterrcnn_wrapper); } @@ -660,6 +764,9 @@ public class FasterRCNN { // MaskRCNN + +/*! @brief MaskRCNN model + */ public class MaskRCNN { public MaskRCNN(string model_file, string params_file, string config_file, @@ -675,6 +782,12 @@ public class MaskRCNN { ~MaskRCNN() { FD_C_DestroyMaskRCNNWrapper(fd_maskrcnn_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_MaskRCNNWrapperPredict(fd_maskrcnn_wrapper, img.CvPtr, @@ -689,6 +802,12 @@ public class MaskRCNN { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -716,6 +835,8 @@ public class MaskRCNN { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_MaskRCNNWrapperInitialized(fd_maskrcnn_wrapper); } @@ -766,6 +887,9 @@ public class MaskRCNN { // SSD + +/*! @brief SSD model + */ public class SSD { public SSD(string model_file, string params_file, string config_file, @@ -781,6 +905,12 @@ public class SSD { ~SSD() { FD_C_DestroySSDWrapper(fd_ssd_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_SSDWrapperPredict(fd_ssd_wrapper, img.CvPtr, @@ -795,6 +925,12 @@ public class SSD { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -822,6 +958,8 @@ public class SSD { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_SSDWrapperInitialized(fd_ssd_wrapper); } @@ -872,6 +1010,9 @@ public class SSD { // PaddleYOLOv5 + +/*! @brief PaddleYOLOv5 model + */ public class PaddleYOLOv5 { public PaddleYOLOv5(string model_file, string params_file, string config_file, @@ -887,6 +1028,12 @@ public class PaddleYOLOv5 { ~PaddleYOLOv5() { FD_C_DestroyPaddleYOLOv5Wrapper(fd_paddleyolov5_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_PaddleYOLOv5WrapperPredict(fd_paddleyolov5_wrapper, img.CvPtr, @@ -901,6 +1048,12 @@ public class PaddleYOLOv5 { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -928,6 +1081,8 @@ public class PaddleYOLOv5 { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_PaddleYOLOv5WrapperInitialized(fd_paddleyolov5_wrapper); } @@ -978,6 +1133,9 @@ public class PaddleYOLOv5 { // PaddleYOLOv6 + +/*! @brief PaddleYOLOv6 model + */ public class PaddleYOLOv6 { public PaddleYOLOv6(string model_file, string params_file, string config_file, @@ -993,6 +1151,12 @@ public class PaddleYOLOv6 { ~PaddleYOLOv6() { FD_C_DestroyPaddleYOLOv6Wrapper(fd_paddleyolov6_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_PaddleYOLOv6WrapperPredict(fd_paddleyolov6_wrapper, img.CvPtr, @@ -1007,6 +1171,12 @@ public class PaddleYOLOv6 { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -1034,6 +1204,8 @@ public class PaddleYOLOv6 { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_PaddleYOLOv6WrapperInitialized(fd_paddleyolov6_wrapper); } @@ -1084,6 +1256,9 @@ public class PaddleYOLOv6 { // PaddleYOLOv7 + +/*! @brief PaddleYOLOv7 model + */ public class PaddleYOLOv7 { public PaddleYOLOv7(string model_file, string params_file, string config_file, @@ -1099,6 +1274,12 @@ public class PaddleYOLOv7 { ~PaddleYOLOv7() { FD_C_DestroyPaddleYOLOv7Wrapper(fd_paddleyolov7_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_PaddleYOLOv7WrapperPredict(fd_paddleyolov7_wrapper, img.CvPtr, @@ -1113,6 +1294,12 @@ public class PaddleYOLOv7 { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -1140,6 +1327,8 @@ public class PaddleYOLOv7 { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_PaddleYOLOv7WrapperInitialized(fd_paddleyolov7_wrapper); } @@ -1190,6 +1379,9 @@ public class PaddleYOLOv7 { // PaddleYOLOv8 + +/*! @brief PaddleYOLOv8 model + */ public class PaddleYOLOv8 { public PaddleYOLOv8(string model_file, string params_file, string config_file, @@ -1205,6 +1397,12 @@ public class PaddleYOLOv8 { ~PaddleYOLOv8() { FD_C_DestroyPaddleYOLOv8Wrapper(fd_paddleyolov8_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_PaddleYOLOv8WrapperPredict(fd_paddleyolov8_wrapper, img.CvPtr, @@ -1219,6 +1417,12 @@ public class PaddleYOLOv8 { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -1246,6 +1450,8 @@ public class PaddleYOLOv8 { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_PaddleYOLOv8WrapperInitialized(fd_paddleyolov8_wrapper); } @@ -1296,6 +1502,9 @@ public class PaddleYOLOv8 { // RTMDet + +/*! @brief RTMDet model + */ public class RTMDet { public RTMDet(string model_file, string params_file, string config_file, @@ -1311,6 +1520,12 @@ public class RTMDet { ~RTMDet() { FD_C_DestroyRTMDetWrapper(fd_rtmdet_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_RTMDetWrapperPredict(fd_rtmdet_wrapper, img.CvPtr, @@ -1325,6 +1540,12 @@ public class RTMDet { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -1352,6 +1573,8 @@ public class RTMDet { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_RTMDetWrapperInitialized(fd_rtmdet_wrapper); } @@ -1402,6 +1625,9 @@ public class RTMDet { // CascadeRCNN + +/*! @brief CascadeRCNN model + */ public class CascadeRCNN { public CascadeRCNN(string model_file, string params_file, string config_file, @@ -1417,6 +1643,12 @@ public class CascadeRCNN { ~CascadeRCNN() { FD_C_DestroyCascadeRCNNWrapper(fd_cascadercnn_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_CascadeRCNNWrapperPredict(fd_cascadercnn_wrapper, img.CvPtr, @@ -1431,6 +1663,12 @@ public class CascadeRCNN { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -1458,6 +1696,8 @@ public class CascadeRCNN { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_CascadeRCNNWrapperInitialized(fd_cascadercnn_wrapper); } @@ -1508,6 +1748,9 @@ public class CascadeRCNN { // PSSDet + +/*! @brief PSSDet model + */ public class PSSDet { public PSSDet(string model_file, string params_file, string config_file, @@ -1523,6 +1766,12 @@ public class PSSDet { ~PSSDet() { FD_C_DestroyPSSDetWrapper(fd_pssdet_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_PSSDetWrapperPredict(fd_pssdet_wrapper, img.CvPtr, @@ -1537,6 +1786,12 @@ public class PSSDet { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -1564,6 +1819,8 @@ public class PSSDet { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_PSSDetWrapperInitialized(fd_pssdet_wrapper); } @@ -1614,6 +1871,9 @@ public class PSSDet { // RetinaNet + +/*! @brief RetinaNet model + */ public class RetinaNet { public RetinaNet(string model_file, string params_file, string config_file, @@ -1629,6 +1889,12 @@ public class RetinaNet { ~RetinaNet() { FD_C_DestroyRetinaNetWrapper(fd_retinanet_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_RetinaNetWrapperPredict(fd_retinanet_wrapper, img.CvPtr, @@ -1643,6 +1909,12 @@ public class RetinaNet { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -1670,6 +1942,8 @@ public class RetinaNet { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_RetinaNetWrapperInitialized(fd_retinanet_wrapper); } @@ -1720,6 +1994,9 @@ public class RetinaNet { // FCOS + +/*! @brief FCOS model + */ public class FCOS { public FCOS(string model_file, string params_file, string config_file, @@ -1735,6 +2012,12 @@ public class FCOS { ~FCOS() { FD_C_DestroyFCOSWrapper(fd_fcos_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_FCOSWrapperPredict(fd_fcos_wrapper, img.CvPtr, @@ -1749,6 +2032,12 @@ public class FCOS { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -1776,6 +2065,8 @@ public class FCOS { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_FCOSWrapperInitialized(fd_fcos_wrapper); } @@ -1826,6 +2117,9 @@ public class FCOS { // TTFNet + +/*! @brief TTFNet model + */ public class TTFNet { public TTFNet(string model_file, string params_file, string config_file, @@ -1841,6 +2135,12 @@ public class TTFNet { ~TTFNet() { FD_C_DestroyTTFNetWrapper(fd_ttfnet_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_TTFNetWrapperPredict(fd_ttfnet_wrapper, img.CvPtr, @@ -1855,6 +2155,12 @@ public class TTFNet { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -1882,6 +2188,8 @@ public class TTFNet { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_TTFNetWrapperInitialized(fd_ttfnet_wrapper); } @@ -1932,6 +2240,9 @@ public class TTFNet { // TOOD + +/*! @brief TOOD model + */ public class TOOD { public TOOD(string model_file, string params_file, string config_file, @@ -1947,6 +2258,12 @@ public class TOOD { ~TOOD() { FD_C_DestroyTOODWrapper(fd_tood_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_TOODWrapperPredict(fd_tood_wrapper, img.CvPtr, @@ -1961,6 +2278,12 @@ public class TOOD { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -1988,6 +2311,8 @@ public class TOOD { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_TOODWrapperInitialized(fd_tood_wrapper); } @@ -2038,6 +2363,9 @@ public class TOOD { // GFL + +/*! @brief GFL model + */ public class GFL { public GFL(string model_file, string params_file, string config_file, @@ -2053,6 +2381,12 @@ public class GFL { ~GFL() { FD_C_DestroyGFLWrapper(fd_gfl_wrapper); } + + /** \brief Predict the detection result for an input image + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return DetectionResult + */ public DetectionResult Predict(Mat img) { FD_DetectionResult fd_detection_result = new FD_DetectionResult(); if(! FD_C_GFLWrapperPredict(fd_gfl_wrapper, img.CvPtr, @@ -2067,6 +2401,12 @@ public class GFL { return detection_result; } + + /** \brief Predict the detection result for an input image list + * \param[in] im The input image list, all the elements come from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -2094,6 +2434,8 @@ public class GFL { return results_out; } + + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_GFLWrapperInitialized(fd_gfl_wrapper); } diff --git a/csharp/fastdeploy/vision/ocr/model.cs b/csharp/fastdeploy/vision/ocr/model.cs index e8a6804d0..139f42a75 100644 --- a/csharp/fastdeploy/vision/ocr/model.cs +++ b/csharp/fastdeploy/vision/ocr/model.cs @@ -27,8 +27,18 @@ namespace ocr { // Recognizer +/*! @brief Recognizer object is used to load the recognition model provided by PaddleOCR. + */ public class Recognizer { + /** \brief Set path of model file, and the configuration of runtime + * + * \param[in] model_file Path of model file, e.g ./ch_PP-OCRv3_rec_infer/model.pdmodel. + * \param[in] params_file Path of parameter file, e.g ./ch_PP-OCRv3_rec_infer/model.pdiparams, if the model format is ONNX, this parameter will be ignored. + * \param[in] label_path Path of label file used by OCR recognition model. e.g ./ppocr_keys_v1.txt + * \param[in] custom_option RuntimeOption for inference, the default will use cpu, and choose the backend defined in `valid_cpu_backends`. + * \param[in] model_format Model format of the loaded model, default is Paddle format. + */ public Recognizer(string model_file, string params_file, string label_path, RuntimeOption custom_option = null, @@ -45,11 +55,17 @@ public class Recognizer { FD_C_DestroyRecognizerWrapper(fd_recognizer_model_wrapper); } - + /// Get model's name public string ModelName() { return "ppocr/ocr_rec"; } + /** \brief Predict the input image and get OCR recognition model result. + * + * \param[in] img The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. + * + * \return The output of OCR recognition model result + */ public OCRRecognizerResult Predict(Mat img) { OCRRecognizerResult ocr_recognizer_result = new OCRRecognizerResult(); FD_Cstr text = new FD_Cstr(); @@ -64,6 +80,12 @@ public class Recognizer { return ocr_recognizer_result; } + /** \brief BatchPredict the input image and get OCR recognition model result. + * + * \param[in] images The list of input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. + * + * \return The output of OCR recognition model result. + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -152,6 +174,7 @@ public class Recognizer { return results_out; } + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_RecognizerWrapperInitialized(fd_recognizer_model_wrapper); } @@ -219,8 +242,17 @@ public class Recognizer { // Classifier +/*! @brief Classifier object is used to load the classification model provided by PaddleOCR. + */ public class Classifier { + /** \brief Set path of model file, and the configuration of runtime + * + * \param[in] model_file Path of model file, e.g ./ch_ppocr_mobile_v2.0_cls_infer/model.pdmodel. + * \param[in] params_file Path of parameter file, e.g ./ch_ppocr_mobile_v2.0_cls_infer/model.pdiparams, if the model format is ONNX, this parameter will be ignored. + * \param[in] custom_option RuntimeOption for inference, the default will use cpu, and choose the backend defined in `valid_cpu_backends`. + * \param[in] model_format Model format of the loaded model, default is Paddle format. + */ public Classifier(string model_file, string params_file, RuntimeOption custom_option = null, ModelFormat model_format = ModelFormat.PADDLE) { @@ -236,11 +268,17 @@ public class Classifier { FD_C_DestroyClassifierWrapper(fd_classifier_model_wrapper); } - + /// Get model's name public string ModelName() { return "ppocr/ocr_cls"; } + /** \brief Predict the input image and get OCR classification model cls_result. + * + * \param[in] img The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. + * + * \return OCRClassifierResult + */ public OCRClassifierResult Predict(Mat img) { OCRClassifierResult ocr_classify_result = new OCRClassifierResult(); if(! FD_C_ClassifierWrapperPredict( @@ -252,6 +290,12 @@ public class Classifier { return ocr_classify_result; } + /** \brief BatchPredict the input image and get OCR classification model result. + * + * \param[in] img The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -334,6 +378,7 @@ public class Classifier { return results_out; } + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_ClassifierWrapperInitialized(fd_classifier_model_wrapper); } @@ -395,8 +440,17 @@ public class Classifier { // DBDetector +/*! @brief DBDetector object is used to load the detection model provided by PaddleOCR. + */ public class DBDetector { + /** \brief Set path of model file, and the configuration of runtime + * + * \param[in] model_file Path of model file, e.g ./ch_PP-OCRv3_det_infer/model.pdmodel. + * \param[in] params_file Path of parameter file, e.g ./ch_PP-OCRv3_det_infer/model.pdiparams, if the model format is ONNX, this parameter will be ignored. + * \param[in] custom_option RuntimeOption for inference, the default will use cpu, and choose the backend defined in `valid_cpu_backends`. + * \param[in] model_format Model format of the loaded model, default is Paddle format. + */ public DBDetector(string model_file, string params_file, RuntimeOption custom_option = null, ModelFormat model_format = ModelFormat.PADDLE) { @@ -412,11 +466,17 @@ public class DBDetector { FD_C_DestroyDBDetectorWrapper(fd_dbdetector_model_wrapper); } - + /// Get model's name public string ModelName() { return "ppocr/ocr_det"; } + /** \brief Predict the input image and get OCR detection model result. + * + * \param[in] img The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. + * + * \return OCRDBDetectorResult + */ public OCRDBDetectorResult Predict(Mat img) { OCRDBDetectorResult ocr_detector_result = new OCRDBDetectorResult(); FD_TwoDimArrayInt32 fd_box_result = new FD_TwoDimArrayInt32(); @@ -441,6 +501,12 @@ public class DBDetector { return ocr_detector_result; } + /** \brief BatchPredict the input image and get OCR detection model result. + * + * \param[in] images The list input of image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -484,6 +550,7 @@ public class DBDetector { return results_out; } + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_DBDetectorWrapperInitialized(fd_dbdetector_model_wrapper); } @@ -541,8 +608,16 @@ namespace pipeline { // PPOCRv2 +/*! @brief PPOCRv2 is used to load PP-OCRv2 series models provided by PaddleOCR. + */ public class PPOCRv2 { + /** \brief Set up the detection model path, classification model path and recognition model path respectively. + * + * \param[in] det_model Path of detection model, e.g ./ch_PP-OCRv2_det_infer + * \param[in] cls_model Path of classification model, e.g ./ch_ppocr_mobile_v2.0_cls_infer + * \param[in] rec_model Path of recognition model, e.g ./ch_PP-OCRv2_rec_infer + */ public PPOCRv2(DBDetector ppocrv2, Classifier classifier, Recognizer recognizer) { fd_ppocrv2_wrapper = FD_C_CreatePPOCRv2Wrapper( @@ -560,6 +635,12 @@ public class PPOCRv2 { return "PPOCRv2"; } + /** \brief Predict the input image and get OCR result. + * + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. + * + * \return OCRResult + */ public OCRResult Predict(Mat img) { FD_OCRResult fd_ocr_result = new FD_OCRResult(); if(! FD_C_PPOCRv2WrapperPredict( @@ -573,6 +654,12 @@ public class PPOCRv2 { return ocr_detector_result; } + /** \brief BatchPredict the input image and get OCR result. + * + * \param[in] images The list of input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -601,6 +688,7 @@ public class PPOCRv2 { return results_out; } + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_PPOCRv2WrapperInitialized(fd_ppocrv2_wrapper); } @@ -643,8 +731,16 @@ public class PPOCRv2 { // PPOCRv3 +/*! @brief PPOCRv3 is used to load PP-OCRv3 series models provided by PaddleOCR. + */ public class PPOCRv3 { + /** \brief Set up the detection model path, classification model path and recognition model path respectively. + * + * \param[in] det_model Path of detection model, e.g ./ch_PP-OCRv3_det_infer + * \param[in] cls_model Path of classification model, e.g ./ch_ppocr_mobile_v2.0_cls_infer + * \param[in] rec_model Path of recognition model, e.g ./ch_PP-OCRv3_rec_infer + */ public PPOCRv3(DBDetector ppocrv3, Classifier classifier, Recognizer recognizer) { fd_ppocrv3_wrapper = FD_C_CreatePPOCRv3Wrapper( @@ -662,6 +758,12 @@ public class PPOCRv3 { return "PPOCRv3"; } + /** \brief Predict the input image and get OCR result. + * + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. + * + * \return OCRResult + */ public OCRResult Predict(Mat img) { FD_OCRResult fd_ocr_result = new FD_OCRResult(); if(! FD_C_PPOCRv3WrapperPredict( @@ -675,6 +777,12 @@ public class PPOCRv3 { return ocr_detector_result; } + /** \brief BatchPredict the input image and get OCR result. + * + * \param[in] images The list of input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format. + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -703,6 +811,7 @@ public class PPOCRv3 { return results_out; } + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_PPOCRv3WrapperInitialized(fd_ppocrv3_wrapper); } diff --git a/csharp/fastdeploy/vision/result.cs b/csharp/fastdeploy/vision/result.cs index 8184ecb77..3e400af81 100644 --- a/csharp/fastdeploy/vision/result.cs +++ b/csharp/fastdeploy/vision/result.cs @@ -37,9 +37,11 @@ public enum ResultType { HEADPOSE } +/*! Mask structure, used in DetectionResult for instance segmentation models + */ public class Mask { - public List data; - public List shape; + public List data; /// Mask data buffer + public List shape; /// Shape of mask public ResultType type; public Mask() { this.data = new List(); @@ -47,6 +49,7 @@ public class Mask { this.type = ResultType.MASK; } + /// convert the result to string to print public override string ToString() { string information = "Mask(" ; int ndim = this.shape.Count; @@ -63,16 +66,19 @@ public class Mask { } +/*! @brief Classify result structure for all the image classify models + */ public class ClassifyResult { - public List label_ids; - public List scores; - public ResultType type; + public List label_ids; /// Classify result for an image + public List scores; /// The confidence for each classify result + public ResultType type; public ClassifyResult() { this.label_ids = new List(); this.scores = new List(); this.type = ResultType.CLASSIFY; } + /// convert the result to string to print public string ToString() { string information; information = "ClassifyResult(\nlabel_ids: "; @@ -89,12 +95,14 @@ public class ClassifyResult { } } +/*! @brief Detection result structure for all the object detection models and instance segmentation models + */ public class DetectionResult { - public List boxes; - public List scores; - public List label_ids; - public List masks; - public bool contain_masks; + public List boxes; /// Member variable which indicates the coordinates of all detected target boxes in a single image, each box is represented by 4 float values in order of xmin, ymin, xmax, ymax, i.e. the coordinates of the top left and bottom right corner. + public List scores; /// Member variable which indicates the confidence level of all targets detected in a single image + public List label_ids; /// Member variable which indicates all target categories detected in a single image + public List masks; /// Member variable which indicates all detected instance masks of a single image + public bool contain_masks; /// Member variable which indicates whether the detected result contains instance masks public ResultType type; public DetectionResult() { this.boxes = new List(); @@ -105,7 +113,7 @@ public class DetectionResult { this.type = ResultType.DETECTION; } - + /// convert the result to string to print public string ToString() { string information; if (!contain_masks) { @@ -130,12 +138,14 @@ public class DetectionResult { } +/*! @brief OCR result structure for all the OCR models. + */ public class OCRResult { - public List boxes; - public List text; - public List rec_scores; - public List cls_scores; - public List cls_labels; + public List boxes; /// Member variable which indicates the coordinates of all detected target boxes in a single image. Each box is represented by 8 int values to indicate the 4 coordinates of the box, in the order of lower left, lower right, upper right, upper left. + public List text; /// Member variable which indicates the content of the recognized text in multiple text boxes + public List rec_scores; /// Member variable which indicates the confidence level of the recognized text. + public List cls_scores; /// Member variable which indicates the confidence level of the classification result of the text box + public List cls_labels; /// Member variable which indicates the directional category of the textbox public ResultType type; public OCRResult() { @@ -146,6 +156,8 @@ public class OCRResult { this.cls_labels = new List(); this.type = ResultType.OCR; } + + /// convert the result to string to print public string ToString() { string no_result = ""; if (boxes.Count > 0) { @@ -225,11 +237,13 @@ public class OCRRecognizerResult{ public float rec_score; } +/*! @brief Segmentation result structure for all the segmentation models + */ public class SegmentationResult{ - public List label_map; - public List score_map; - public List shape; - public bool contain_score_map; + public List label_map; /// `label_map` stores the pixel-level category labels for input image. + public List score_map; /// `score_map` stores the probability of the predicted label for each pixel of input image. + public List shape; /// The output shape, means [H, W] + public bool contain_score_map; /// SegmentationResult whether containing score_map public ResultType type; public SegmentationResult() { this.label_map = new List(); @@ -239,6 +253,7 @@ public class SegmentationResult{ this.type = ResultType.SEGMENTATION; } + /// convert the result to string to print public string ToString() { string information; information = "SegmentationResult Image masks 10 rows x 10 cols: \n"; diff --git a/csharp/fastdeploy/vision/segmentation/model.cs b/csharp/fastdeploy/vision/segmentation/model.cs index e607bd1a6..87b916c53 100644 --- a/csharp/fastdeploy/vision/segmentation/model.cs +++ b/csharp/fastdeploy/vision/segmentation/model.cs @@ -23,8 +23,18 @@ namespace fastdeploy { namespace vision { namespace segmentation { +/*! @brief PaddleSeg serials model object used when to load a PaddleSeg model exported by PaddleSeg repository + */ public class PaddleSegModel { + /** \brief Set path of model file and configuration file, and the configuration of runtime + * + * \param[in] model_file Path of model file, e.g unet/model.pdmodel + * \param[in] params_file Path of parameter file, e.g unet/model.pdiparams, if the model format is ONNX, this parameter will be ignored + * \param[in] config_file Path of configuration file for deployment, e.g unet/deploy.yml + * \param[in] custom_option RuntimeOption for inference, the default will use cpu, and choose the backend defined in `valid_cpu_backends` + * \param[in] model_format Model format of the loaded model, default is Paddle format + */ public PaddleSegModel(string model_file, string params_file, string config_file, RuntimeOption custom_option = null, ModelFormat model_format = ModelFormat.PADDLE) { @@ -40,11 +50,17 @@ public class PaddleSegModel { FD_C_DestroyPaddleSegModelWrapper(fd_paddleseg_model_wrapper); } - + /// Get model's name public string ModelName() { return "PaddleSeg"; } + /** \brief DEPRECATED Predict the segmentation result for an input image + * + * \param[in] im The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * + * \return SegmentationResult + */ public SegmentationResult Predict(Mat img) { FD_SegmentationResult fd_segmentation_result = new FD_SegmentationResult(); if(! FD_C_PaddleSegModelWrapperPredict( @@ -59,6 +75,12 @@ public class PaddleSegModel { return segmentation_result; } + /** \brief Predict the segmentation results for a batch of input images + * + * \param[in] imgs, The input image list, each element comes from cv::imread() + * + * \return List + */ public List BatchPredict(List imgs){ FD_OneDimMat imgs_in = new FD_OneDimMat(); imgs_in.size = (nuint)imgs.Count; @@ -86,6 +108,7 @@ public class PaddleSegModel { return results_out; } + /// Check whether model is initialized successfully public bool Initialized() { return FD_C_PaddleSegModelWrapperInitialized(fd_paddleseg_model_wrapper); } diff --git a/csharp/fastdeploy/vision/visualize.cs b/csharp/fastdeploy/vision/visualize.cs index 9bd56e660..0062ad1f7 100644 --- a/csharp/fastdeploy/vision/visualize.cs +++ b/csharp/fastdeploy/vision/visualize.cs @@ -24,6 +24,15 @@ namespace vision { public class Visualize { + /** \brief Show the visualized results for detection models + * + * \param[in] im the input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * \param[in] result the result produced by model + * \param[in] score_threshold threshold for result scores, the bounding box will not be shown if the score is less than score_threshold + * \param[in] line_size line size for bounding boxes + * \param[in] font_size font size for text + * \return Mat type stores the visualized results + */ public static Mat VisDetection(Mat im, DetectionResult detection_result, float score_threshold = 0.0f, int line_size = 1, float font_size = 0.5f) { @@ -35,7 +44,16 @@ public class Visualize { return new Mat(result_ptr); } - + /** \brief Show the visualized results with custom labels for detection models + * + * \param[in] im the input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * \param[in] result the result produced by model + * \param[in] labels the visualized result will show the bounding box contain class label + * \param[in] score_threshold threshold for result scores, the bounding box will not be shown if the score is less than score_threshold + * \param[in] line_size line size for bounding boxes + * \param[in] font_size font size for text + * \return Mat type stores the visualized results + */ public static Mat VisDetection(Mat im, DetectionResult detection_result, string[] labels, float score_threshold = 0.0f, @@ -50,6 +68,12 @@ public class Visualize { return new Mat(result_ptr); } + /** \brief Show the visualized results for Ocr models + * + * \param[in] im the input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * \param[in] result the result produced by model + * \return Mat type stores the visualized results + */ public static Mat VisOcr(Mat im, OCRResult ocr_result){ FD_OCRResult fd_ocr_result = ConvertResult.ConvertOCRResultToCResult(ocr_result); @@ -58,6 +82,13 @@ public class Visualize { return new Mat(result_ptr); } + /** \brief Show the visualized results for segmentation models + * + * \param[in] im the input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format + * \param[in] result the result produced by model + * \param[in] weight transparent weight of visualized result image + * \return Mat type stores the visualized results + */ public static Mat VisSegmentation(Mat im, SegmentationResult segmentation_result, float weight = 0.5f){ diff --git a/docs/api_docs/csharp/Doxyfile b/docs/api_docs/csharp/Doxyfile new file mode 100644 index 000000000..628f43c62 --- /dev/null +++ b/docs/api_docs/csharp/Doxyfile @@ -0,0 +1,2495 @@ +# Doxyfile 1.8.13 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "FastDeploy" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = "latest" + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Fast & Easy to Deploy!" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = "./docs" + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = YES + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = YES + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = ../../../csharp/ +INPUT += ./main_page.md + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = ./main_page.md + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse-libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /