Description of Advanced API Header Files

MxBase.h

MxBase/

MxBase header file.

AscendStream.h

MxBase/Asynchron

Defines the AscendStream class for asynchronous process control.

HiddenAttr.h

MxBase/Common

Declares macros related to __attribute__ to mark API properties. Currently, these macros are primarily utilized to mark deprecated APIs, which allows for alarm prompts indicating deprecated APIs to be displayed at compile time.

Version.h

MxBase/Common

Declares the API that returns the Vision SDK version information, including the current Vision SDK version number, major version number, minor version number, and micro version number.

ConfigUtil.h

MxBase/ConfigUtil

Defines the ConfigData and ConfigUtil classes for the postprocessing and log modules. Specifically, the ConfigUtil class is used to read the configuration file into a ConfigData object. This object defines APIs for adding JSON file key-value pairs, loading label files into std::vector objects, and returning label names based on index, which are used by postprocessing and log modules.

DataType.h

MxBase/CV/Core

Defines data structures related to object detection, including the DetectBox structure, RoiBox structure, IOUMethod enumeration class, and TrackFlag enumeration class.

Huangarian.h

MxBase/CV/MultipleObjectTracking

Defines the data structures and APIs related to the Hungarian algorithm, which are used for bipartite graph matching.

KalmanTracker.h

MxBase/CV/MultipleObjectTracking

Defines the data structures and APIs related to Kalman filter, which are used for object detection and tracking.

Nms.h

MxBase/CV/ObjectDetection/Nms

Defines the APIs related to the non-maximum suppression algorithm, which are used for removing redundant bounding boxes.

SimilarityTransform.h

MxBase/CV/WarpAffine

Defines the SimilarityTransform class for calculating similarity transformation.

WarpAffine.h

MxBase/CV/WarpAffine

Defines the WarpAffine class for calculating affine transformation.

DeviceManager.h

MxBase/DeviceManager

Defines the DeviceManager class, which includes APIs for initializing devices, returning device quantities and current devices, and setting running devices.

DvppWrapper.h

MxBase/DvppWrapper

Defines the DvppWrapper class, which calls different APIs for instantiation based on different processors. This class encapsulates operations related to image transformation.

DvppWrapperDataType.h

MxBase/DvppWrapper

Defines data structures related to image processing and constants used for image parameter verification.

This header file will be deprecated in December, 2025.

Color.h

MxBase/E2eInfer/Color

Defines the Color structure.

Dim.h

MxBase/E2eInfer/Dim

Defines the Dim structure.

GlobalInit.h

MxBase/E2eInfer/GlobalInit

Declares the initialization and deinitialization APIs.

Image.h

MxBase/E2eInfer/Image

Defines the Image class, which serves as the data structure for images and includes APIs for obtaining image properties and converting images into tensors.

ImageProcessor.h

MxBase/E2eInfer/ImageProcessor

Defines the ImageProcessor class, which provides common APIs for encoding, decoding, slicing, resizing, cropping, and pasting images. The bottom layer of the ImageProcessor class calls APIs in the DvppWrapper class.

Model.h

MxBase/E2eInfer/Model

Defines the Model class, which provides APIs for implementing high-performance inference and returning input and output tensor formats.

Point.h

MxBase/E2eInfer/Point

Defines the Point structure to represent points.

Rect.h

MxBase/E2eInfer/Rect

Defines the Rect structure to represent rectangles.

Size.h

MxBase/E2eInfer/Size

Defines the Size structure to represent sizes.

Tensor.h

MxBase/E2eInfer/Tensor

Defines the Tensor class, which provides APIs for returning the tensor data type, byte size, and current device ID of the tensor.

TensorFeatures.h

MxBase/E2eInfer/Tensor

Defines the tensor feature extraction algorithm.

TensorFusion.h

MxBase/E2eInfer/TensorOperation

Defines the tensor fusion method and provides functions such as background replacement, pasting with dynamic transparency, and pasting with subtitle transparency.

TensorWarping.h

MxBase/E2eInfer/TensorOperation

Defines the processing method for tensor image deformation and provides functions such as rotation and affine transformation.

PerElementOperations.h

MxBase/E2eInfer/TensorOperation/MatricesOperation

Defines the method of processing tensors by element and provides functions for tensor addition, subtraction, multiplication, division, and more.

MatrixReductions.h

MxBase/E2eInfer/TensorOperation/MatricesOperation

Defines the tensor reduction method and provides functions such as tensor reduction and summation.

CoreOperationsOnTensors.h

MxBase/E2eInfer/TensorOperation/MatricesOperation

Defines the core processing method for tensors and provides functions such as tensor cropping, expansion, horizontal stacking, and vertical stacking.

VideoDecoder.h

MxBase/E2eInfer/VideoDecoder

Defines the VideoDecoder class, which provides callback and non-blocking video decoding APIs. The bottom layer of the VideoDecoder class calls APIs in the DvppWrapper class.

VideoEncoder.h

MxBase/E2eInfer/VideoEncoder

Defines the VideoEncoder class, which provides callback and non-blocking video encoding APIs. The bottom layer of the VideoEncoder class calls APIs in the DvppWrapper class.

DataType.h

MxBase/E2eInfer

Defines the enumeration class related to image processing.

ErrorCode.h

MxBase/ErrorCode

Defines the string array related to error codes.

ErrorCodes.h

MxBase/ErrorCode

Defines the enumeration class related to error codes.

ErrorCodeThirdParty.h

MxBase/ErrorCode

Defines the enumeration class related to third-party error codes.

Log.h

MxBase/Log

Defines the Log class, which provides APIs such as Debug, Info, Warn, and Error to record logs of different levels.

FastMath.h

MxBase/Maths

Defines the FastMath class, which provides APIs for calculating the Sigmoid and Softmax functions.

MathFunction.h

MxBase/Maths

Defines the LineRegressionFit class, which provides APIs for calculating linear regression functions.

NpySort.h

MxBase/Maths

Defines NpySort, which provides algorithm APIs for quick sorting.

MemoryHelper.h

MxBase/MemoryHelper

Defines the MemoryData and MemoryHelper classes, which provide APIs for memory allocation, releasing, and copying.

ModelDataType.h

MxBase/ModelInfer

Defines model-related data structures.

ModelInferenceProcessor.h

MxBase/ModelInfer

Defines the ModelInferenceProcessor class, which provides model inference APIs. The function of this class is similar to that of MxBase, E2eInfer, Model, and Model.h.

ModelPostProcessorBase.h

MxBase/ModelPostProcessors/ModelPostProcessorBase

Defines the ModelPostProcessorBase class, which is the base class in the MxBase/ModelPostProcessors directory.

ObjectPostDataType.h

MxBase/ModelPostProcessors/ModelPostProcessorBase

Defines the data structures related to object postprocessing.

ObjectPostProcessorBase.h

MxBase/ModelPostProcessors/ModelPostProcessorBase

Defines the ObjectPostProcessorBase class, which inherits the ModelPostProcessorBase class and has been marked as deprecated.

Resnet50PostProcess.h

MxBase/postprocess/include/ClassPostProcessors

Defines the Resnet50PostProcess class, which inherits the ClassPostProcessBase class.

HigherHRnetPostProcess.h

MxBase/postprocess/include/KeypointPostProcessors

Defines the HigherHRnetPostProcess class, which inherits the KeypointPostProcessBase class.

OpenPosePostProcess.h

MxBase/postprocess/include/KeypointPostProcessors

Defines the OpenPosePostProcess class, which inherits the KeypointPostProcessBase class.

FasterRcnnPostProcess.h

MxBase/postprocess/include/ObjectPostProcessors

Defines the FasterRcnnPostProcess class, which inherits the ObjectPostProcessBase class.

MaskRcnnMindsporePost.h

MxBase/postprocess/include/ObjectPostProcessors

Defines the MaskRcnnMindsporePost class, which inherits the ObjectPostProcessBase class.

RetinaNetPostProcess.h

MxBase/postprocess/include/ObjectPostProcessors

Defines the RetinaNetPostProcess class, which inherits the ObjectPostProcessBase class.

SsdMobilenetFpnMindsporePost.h

MxBase/postprocess/include/ObjectPostProcessors

Defines the SsdMobilenetFpnMindsporePost class, which inherits the ObjectPostProcessBase class.

SsdMobilenetv1FpnPostProcess.h

MxBase/postprocess/include/ObjectPostProcessors

Defines the SsdMobilenetv1FpnPostProcess class, which inherits the ObjectPostProcessBase class.

Ssdvgg16PostProcess.h

MxBase/postprocess/include/ObjectPostProcessors

Defines the Ssdvgg16PostProcess class, which inherits the ObjectPostProcessBase class.

Yolov3PostProcess.h

MxBase/postprocess/include/ObjectPostProcessors

Defines the Yolov3PostProcess class, which inherits the ObjectPostProcessBase class.

Deeplabv3Post.h

MxBase/postprocess/include/SegmentPostProcessors

Defines the Deeplabv3Post class, which inherits the SemanticSegPostProcessBase class.

UNetMindSporePostProcess.h

MxBase/postprocess/include/SegmentPostProcessors

Defines the UNetMindSporePostProcess class, which inherits the SemanticSegPostProcessBase class.

CrnnPostProcess.h

MxBase/postprocess/include/TextGenerationPostProcessors

Defines the CrnnPostProcess class, which inherits the TextGenerationPostProcessBase class.

TransformerPostProcess.h

MxBase/postprocess/include/TextGenerationPostProcessors

Defines the TransformerPostProcess class, which inherits the TextGenerationPostProcessBase class.

CtpnPostProcess.h

MxBase/postprocess/include/TextObjectPostProcessors

Defines the CtpnPostProcess class, which inherits the TextObjectPostProcessBase class.

PSENetPostProcess.h

MxBase/postprocess/include/TextObjectPostProcessors

Defines the PSENetPostProcess class, which inherits the TextObjectPostProcessBase class.

ClassPostProcessBase.h

MxBase/PostProcessBases

Defines the ClassPostProcessBase class, which inherits the PostProcessBase class and mainly provides Process APIs.

ImagePostProcessBase.h

MxBase/PostProcessBases

Defines the ImagePostProcessBase class, which inherits the PostProcessBase class and mainly provides APIs for cropping region of interests (ROIs).

KeypointPostProcessBase.h

MxBase/PostProcessBases

Defines the KeypointPostProcessBase class, which inherits the PostProcessBase class and mainly provides postprocessing APIs for key point detection tasks.

ObjectPostProcessBase.h

MxBase/PostProcessBases

Defines the ObjectPostProcessBase class, which inherits the PostProcessBase class and mainly provides postprocessing APIs for object detection tasks.

PostProcessBase.h

MxBase/PostProcessBases

Defines the PostProcessBase class, which is the base class of other postprocessing classes.

PostProcessDataType.h

MxBase/PostProcessBases

Defines data structures related to tasks such as object detection, image resizing, and image cropping.

SemanticSegPostProcessBase.h

MxBase/PostProcessBases

Defines the SemanticSegPostProcessBase class, which inherits the PostProcessBase class and mainly provides postprocessing APIs for semantic segmentation tasks.

TextGenerationPostProcessBase.h

MxBase/PostProcessBases

Defines the TextGenerationPostProcessBase class, which inherits the PostProcessBase class and mainly provides postprocessing APIs for text generation tasks.

TextObjectPostProcessBase.h

MxBase/PostProcessBases

Defines the TextObjectPostProcessBase class, which inherits the PostProcessBase class and mainly provides postprocessing APIs for text object tasks.

TensorBase.h

MxBase/Tensor/TensorBase

Defines the TensorBase class.

TensorDataType.h

MxBase/Tensor/TensorBase

Defines the TensorDataType enumeration class. Objects of this class are member variables of the TensorBase class.