Mech-DLK SDK C# API 2.1.0
C# API reference documentation for secondary development with Mech-DLK
All Classes Namespaces Files Functions Variables Enumerations Enumerator Pages
Classes | Enumerations
MMind.DL Namespace Reference

Classes

struct  Bbox
 This struct defines the information on the bounding box. More...
 
struct  CClassificationResult
 This struct defines the classification result.
 
struct  CContour
 This struct defines the information of the mask contour.
 
struct  CDefectAndEdgeResult
 This struct defines the defect segmentation and edge detection result.
 
struct  CFastPositioningResult
 This struct defines the fast positioning result.
 
class  ClassificationResult
 This class defines the classification result. More...
 
struct  CMMindImage
 This struct defines Image.
 
struct  CObjectAndInsResult
 This struct defines the object detection and instance segmentation result.
 
class  Common
 
struct  CPoint
 This struct defines the information on point. More...
 
struct  CTextDetectionResult
 This struct defines the text detection result.
 
struct  CTextRecognitionResult
 This struct defines the text recognition result.
 
struct  CUnsupSegResult
 This struct defines the unsupervised segmentation result.
 
class  DefectAndEdgeResult
 This class defines the defect segmentation and edge detection result. More...
 
struct  Engine
 This struct defines Engine.
 
class  FastPositioningResult
 This class defines the fast positioning result. More...
 
class  InferEngine
 This class defines the inference engine. More...
 
class  MMindImage
 This class defines Image. More...
 
class  NativeMethods
 Nativate C methods.
 
class  ObjectAndInsResult
 This class defines the object detection and instance segmentation result. More...
 
struct  Position
 This struct defines that the position of the result is relative to the upper-left corner of the original image. More...
 
class  Result
 This class defines the storage of inference results. More...
 
struct  ResultRestoreInfo
 This struct defines the information required to recover the result to the original image. More...
 
class  TextDetectionResult
 This class defines the text detection result. More...
 
class  TextRecognitionResult
 This class defines the text recognition result. More...
 
class  UnsupSegResult
 This class defines the unsupervised segmentation result. More...
 

Enumerations

enum  StatusCode {
  SUCCESS = 0 , E_UNKNOWN , E_INIT_FAILED , E_INVALID_MODEL_PATH ,
  E_INVALID_MODEL_PACK , E_INVALID_MODEL_VERSION , I_CONVERTING , E_CONVERT_FAILED ,
  E_CONVERT_WITHOUT_INIT , E_UNSUPPORTED_BACKEND , I_LOADING , E_LOAD_FAILED ,
  E_LOAD_WITHOUT_CONVERT , E_LOAD_WITHOUT_INIT , E_INFER_WITHOUT_LOAD , E_OUT_OF_HOST_MEMORY ,
  E_OUT_OF_DEVICE_MEMORY , E_INFER_FAILED , E_INVALID_IMAGE_PATH , E_UNZIP_ERROR ,
  E_INVALID_IMAGE_NULLPTR , E_MODEL_REGISTEXCEEDLIMIT , E_MODULE_INDEX_ERROR , E_MODULE_TYPE_ERROR ,
  E_SET_GPUID_ERROR , E_INVALID_ENGINE , E_INVALID_BACKEND_TYPE , E_INVALID_ALGO_TYPE ,
  E_PARAM_ERROR , E_AUTHOR_TYPE_ERROR
}
 This enumeration defines the codes of status. More...
 
enum  UnsupSegLabel { OK = 0 , NG , Unknown }
 This enumeration defines the label of unsupervised segmentation. More...
 
enum  BackendType { GpuDefault = 0 , GpuOptimization , CPU }
 This enumeration defines the backend types. More...
 
enum  DLAlgoType {
  Unknown = 0 , Classification , ObjectDetection , InstanceSegmentation ,
  DefectSegmentation , FastLocating , EdgeDetection , TextRecognition ,
  TextDetection , UnsupSegmentation
}
 This enumeration defines the deep learning algorithm types. More...
 
enum  FloatPrecisionType { FP16 , FP32 }
 This enumeration defines the floating-point formats. More...
 

Enumeration Type Documentation

◆ BackendType

This enumeration defines the backend types.

Enumerator
GpuDefault 

GPU Default mode.

GpuOptimization 

GPU optimization mode. This mode takes 2 to 10 minutes to optimize the model.

CPU 

CPU mode. This mode can be used without a GPU.

◆ DLAlgoType

This enumeration defines the deep learning algorithm types.

Enumerator
Unknown 

Unknown.

Classification 

Classification.

ObjectDetection 

ObjectDetection.

InstanceSegmentation 

InstanceSegmentation.

DefectSegmentation 

DefectSegmentation.

FastLocating 

FastLocating.

EdgeDetection 

EdgeDetection.

TextRecognition 

TextRecognition.

TextDetection 

TextDetection.

UnsupSegmentation 

UnsupSegmentation.

◆ FloatPrecisionType

This enumeration defines the floating-point formats.

Enumerator
FP16 

Half-precision floating-point format.

FP32 

Single-precision floating-point format.

◆ StatusCode

This enumeration defines the codes of status.

Enumerator
SUCCESS 

Success status.

E_UNKNOWN 

Unknown status.

E_INIT_FAILED 

Error: engine initialization failed.

E_INVALID_MODEL_PATH 

Error: invalid model package path.

E_INVALID_MODEL_PACK 

Error: invalid model package.

E_INVALID_MODEL_VERSION 

Error: invalid model package version.

I_CONVERTING 

Status: model is being converted.

E_CONVERT_FAILED 

Error: model conversion failed.

E_CONVERT_WITHOUT_INIT 

Error: model uninitialized before conversion.

E_UNSUPPORTED_BACKEND 

Error: unsupported inference backend.

I_LOADING 

Status: model is being loaded.

E_LOAD_FAILED 

Error: model loading failed.

E_LOAD_WITHOUT_CONVERT 

Error: model unconverted before loading.

E_LOAD_WITHOUT_INIT 

Error: uninitialized before loading.

E_INFER_WITHOUT_LOAD 

Error: model unloaded before inference.

E_OUT_OF_HOST_MEMORY 

Error: out of memory.

E_OUT_OF_DEVICE_MEMORY 

Error: out of video memory.

E_INFER_FAILED 

Error: inference failed.

E_INVALID_IMAGE_PATH 

Error: invalid image path.

E_UNZIP_ERROR 

Error: unable to unzip the model package.

E_INVALID_IMAGE_NULLPTR 

Error: invalid image pointer.

E_MODEL_REGISTEXCEEDLIMIT 

Error: model loading failed as the number of models loaded has reached the upper limit.

E_MODULE_INDEX_ERROR 

Error: module index out of range.

E_MODULE_TYPE_ERROR 

Error: the function of an incorrect model type was called.

E_SET_GPUID_ERROR 

Error: incorrect GPU ID settings.

E_INVALID_ENGINE 

Error: engine creation failed.

E_INVALID_BACKEND_TYPE 

Error: invalid backend type.

E_INVALID_ALGO_TYPE 

Error: invalid deep learning algorithm type.

E_PARAM_ERROR 

Error: incorrect parameter settings.

E_AUTHOR_TYPE_ERROR 

Error: authorization type error.

◆ UnsupSegLabel

This enumeration defines the label of unsupervised segmentation.

Enumerator
OK 

There are no defects in the current image.

NG 

There are some defects in the current image.

Unknown 

Not sure if there is a defect in the image.