Mech-DLK SDK C++ API 2.0.2
C++ API reference documentation for secondary development with Mech-DLK
All Classes Namespaces Files Functions Variables Enumerations Enumerator Macros Pages
Public Member Functions | Public Attributes | List of all members
mmind::dl::MMindImage Struct Reference

#include <MMindImage.h>

Public Member Functions

StatusCode createFromPath (const std::string &imagePath)
 Creates an image from its path.
 
StatusCode show (const std::string &winName)
 Visualizes an image.
 
StatusCode save (const std::string &savePath)
 Saves the image to a specified directory.
 
 ~MMindImage ()
 Releases the memory of the image.
 

Public Attributes

int width = 0
 The width of the image.
 
int height = 0
 The height of the image.
 
int channel = 0
 The number of channels in the image.
 
int depth = 0
 The depth of the image.
 
std::shared_ptr< unsigned char > data = nullptr
 The pointer of the image data.
 

Constructor & Destructor Documentation

◆ ~MMindImage()

mmind::dl::MMindImage::~MMindImage ( )

Releases the memory of the image.

Member Function Documentation

◆ createFromPath()

StatusCode mmind::dl::MMindImage::createFromPath ( const std::string &  imagePath)

Creates an image from its path.

Parameters
[in]imagePathImage storage path.
Returns
See StatusCode for details.

◆ save()

StatusCode mmind::dl::MMindImage::save ( const std::string &  savePath)

Saves the image to a specified directory.

Parameters
[in]savePathThe path to save the image.
Returns
See StatusCode for details.

◆ show()

StatusCode mmind::dl::MMindImage::show ( const std::string &  winName)

Visualizes an image.

Parameters
[in]winNameThe window name for visualizing an image.
Returns
See StatusCode for details.
Note
The size of the image display window equals to that of the image.

Member Data Documentation

◆ channel

int mmind::dl::MMindImage::channel = 0

The number of channels in the image.

◆ data

std::shared_ptr<unsigned char> mmind::dl::MMindImage::data = nullptr

The pointer of the image data.

◆ depth

int mmind::dl::MMindImage::depth = 0

The depth of the image.

◆ height

int mmind::dl::MMindImage::height = 0

The height of the image.

◆ width

int mmind::dl::MMindImage::width = 0

The width of the image.


The documentation for this struct was generated from the following file: