Mech-DLK SDK (C++) 3.0.0
Mech-DLK SDK (C++) Reference Documentation
 
Loading...
Searching...
No Matches
MMindImage.h
Go to the documentation of this file.
1/*******************************************************************************
2 *BSD 3-Clause License
3 *
4 *Copyright (c) 2016-2026, Mech-Mind Robotics
5 *All rights reserved.
6 *
7 *Redistribution and use in source and binary forms, with or without
8 *modification, are permitted provided that the following conditions are met:
9 *
10 *1. Redistributions of source code must retain the above copyright notice, this
11 * list of conditions and the following disclaimer.
12 *
13 *2. Redistributions in binary form must reproduce the above copyright notice,
14 * this list of conditions and the following disclaimer in the documentation
15 * and/or other materials provided with the distribution.
16 *
17 *3. Neither the name of the copyright holder nor the names of its
18 * contributors may be used to endorse or promote products derived from
19 * this software without specific prior written permission.
20 *
21 *THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 *AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 *IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 *DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25 *FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 *DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 *SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 *CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 *OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 *OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 ******************************************************************************/
32
33#pragma once
34#include <memory>
35#include <string>
36#include "common/status.h"
37
38namespace mmind {
39namespace dl {
50{
58 StatusCode createFromPath(const std::string& imagePath);
59
67 StatusCode show(const std::string& winName) const;
68
76 StatusCode save(const std::string& savePath) const;
77
78 uint32_t width{0};
79 uint32_t height{0};
80 size_t bytesPerRow{0};
81 std::shared_ptr<const void> data;
82};
83} // namespace dl
84} // namespace mmind
#define MMIND_DL_SDK_CC_API
Definition macro.h:21
Definition MBbox.h:7
mmind::base::StatusCode StatusCode
Definition status.h:140
Represents an image structure for inference and visualization.
Definition MMindImage.h:50
StatusCode show(const std::string &winName) const
Displays the image in a window.
std::shared_ptr< const void > data
Pointer to image pixel data (BGR format, row-major)
Definition MMindImage.h:81
uint32_t height
Image height in pixels.
Definition MMindImage.h:79
StatusCode createFromPath(const std::string &imagePath)
Creates an image by loading from a file path.
StatusCode save(const std::string &savePath) const
Saves the image to the specified file path.
uint32_t width
Image width in pixels.
Definition MMindImage.h:78
size_t bytesPerRow
Number of bytes per row (stride/pitch)
Definition MMindImage.h:80