Mech-Eye API
2.6.0
API reference documentation for Mech-Eye Industrial 3D Camera
Toggle main menu visibility
Loading...
Searching...
No Matches
area_scan_3d_camera
CameraProperties.h
1
/*******************************************************************************
2
* BSD 3-Clause License
3
*
4
* Copyright (c) 2016-2025, Mech-Mind Robotics Technologies Co., Ltd.
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
* Info: https://www.mech-mind.com/
33
*
34
******************************************************************************/
35
36
#pragma once
37
#include <string>
38
#include "CommonTypes.h"
39
#include "Version.h"
40
41
namespace
mmind {
42
43
namespace
eye {
44
48
struct
CameraInfo
49
{
50
std::string
model
;
51
std::string
deviceName
;
52
std::string
serialNumber
;
53
#pragma warning(suppress : 4996)
54
Platform
platform
;
55
Version
hardwareVersion
;
56
Version
firmwareVersion
;
57
std::string
ipAddress
;
58
std::string
subnetMask
{
"255.255.255.0"
};
59
IpAssignmentMethod
ipAssignmentMethod
{};
60
uint16_t
port
{};
61
bool
supported
{
true
};
62
Version
lastSupportedVersion
;
63
};
64
68
struct
DeviceTemperature
69
{
70
float
cpuTemperature
{};
71
float
projectorTemperature
{};
72
};
73
77
struct
CameraStatus
78
{
79
DeviceTemperature
temperature;
80
};
81
85
struct
CameraMatrix
86
{
87
double
fx
{};
88
double
fy
{};
89
double
cx
{};
90
double
cy
{};
91
};
92
96
struct
CameraDistortion
97
{
98
double
k1
{};
99
double
k2
{};
100
double
p1
{};
101
double
p2
{};
102
double
k3
{};
103
};
104
109
struct
Intrinsics2DCamera
110
{
111
CameraDistortion
cameraDistortion;
112
CameraMatrix
cameraMatrix;
113
};
114
120
struct
Transformation
121
{
122
double
rotation
[3][3] = {{1, 0, 0}, {0, 1, 0}, {0, 0, 1}};
123
double
translation
[3] = {0, 0, 0};
124
};
125
130
struct
CameraResolutions
131
{
132
Size
texture;
133
Size
depth;
134
};
135
141
struct
CameraIntrinsics
142
{
143
Intrinsics2DCamera
texture
;
145
Intrinsics2DCamera
146
depth
;
147
148
Transformation
depthToTexture
;
153
};
154
158
enum class
ColorTypeOf2DCamera { Monochrome, Color, Undefined };
159
160
}
// namespace eye
161
162
}
// namespace mmind
mmind::eye::Version
Describes the version information.
Definition
Version.h:19
mmind::eye::CameraDistortion
Describes the distortion parameters.
Definition
CameraProperties.h:97
mmind::eye::CameraDistortion::k1
double k1
Radial distortion coefficients.
Definition
CameraProperties.h:98
mmind::eye::CameraDistortion::k3
double k3
Radial distortion coefficients.
Definition
CameraProperties.h:102
mmind::eye::CameraDistortion::p2
double p2
Tangential distortion coefficients.
Definition
CameraProperties.h:101
mmind::eye::CameraDistortion::k2
double k2
Radial distortion coefficients.
Definition
CameraProperties.h:99
mmind::eye::CameraDistortion::p1
double p1
Tangential distortion coefficients.
Definition
CameraProperties.h:100
mmind::eye::CameraInfo
Defines the camera information.
Definition
CameraProperties.h:49
mmind::eye::CameraInfo::platform
Platform platform
The platform name of the device.
Definition
CameraProperties.h:54
mmind::eye::CameraInfo::ipAssignmentMethod
IpAssignmentMethod ipAssignmentMethod
The IP address assignment method of the device.
Definition
CameraProperties.h:59
mmind::eye::CameraInfo::serialNumber
std::string serialNumber
The serial number of the device.
Definition
CameraProperties.h:52
mmind::eye::CameraInfo::hardwareVersion
Version hardwareVersion
The version of the hardware (pre-determined in the factory).
Definition
CameraProperties.h:55
mmind::eye::CameraInfo::supported
bool supported
The support status of the device.
Definition
CameraProperties.h:61
mmind::eye::CameraInfo::deviceName
std::string deviceName
The device name (UTF-8 encoded).
Definition
CameraProperties.h:51
mmind::eye::CameraInfo::model
std::string model
The device model, such as Mech-Eye NANO.
Definition
CameraProperties.h:50
mmind::eye::CameraInfo::firmwareVersion
Version firmwareVersion
The version of the firmware (upgradable).
Definition
CameraProperties.h:56
mmind::eye::CameraInfo::subnetMask
std::string subnetMask
The subnet mask of the device.
Definition
CameraProperties.h:58
mmind::eye::CameraInfo::lastSupportedVersion
Version lastSupportedVersion
The last supported version of the device.
Definition
CameraProperties.h:62
mmind::eye::CameraInfo::ipAddress
std::string ipAddress
The IP address of the device.
Definition
CameraProperties.h:57
mmind::eye::CameraInfo::port
uint16_t port
The port used by the device.
Definition
CameraProperties.h:60
mmind::eye::CameraIntrinsics
Defines the 3D camera intrinsic parameters, including the intrinsic parameters of the texture 2D came...
Definition
CameraProperties.h:142
mmind::eye::CameraIntrinsics::texture
Intrinsics2DCamera texture
Definition
CameraProperties.h:143
mmind::eye::CameraIntrinsics::depth
Intrinsics2DCamera depth
The intrinsic parameters of the depth 2D camera(s) for capturing the depth map.
Definition
CameraProperties.h:146
mmind::eye::CameraIntrinsics::depthToTexture
Transformation depthToTexture
Definition
CameraProperties.h:148
mmind::eye::CameraMatrix
Describes the camera intrinsic parameter matrix.
Definition
CameraProperties.h:86
mmind::eye::CameraMatrix::cx
double cx
Principal point.
Definition
CameraProperties.h:89
mmind::eye::CameraMatrix::fy
double fy
Focal lengths.
Definition
CameraProperties.h:88
mmind::eye::CameraMatrix::cy
double cy
Principal point.
Definition
CameraProperties.h:90
mmind::eye::CameraMatrix::fx
double fx
Focal lengths.
Definition
CameraProperties.h:87
mmind::eye::CameraResolutions
Defines the camera image resolutions, including the resolutions of the 2D image (texture) and depth m...
Definition
CameraProperties.h:131
mmind::eye::CameraStatus
Describes the camera's statuses.
Definition
CameraProperties.h:78
mmind::eye::DeviceTemperature
Describes the device temperatures.
Definition
CameraProperties.h:69
mmind::eye::DeviceTemperature::projectorTemperature
float projectorTemperature
The temperature (in °C) of the camera projector.
Definition
CameraProperties.h:71
mmind::eye::DeviceTemperature::cpuTemperature
float cpuTemperature
The temperature (in °C) of the camera CPU.
Definition
CameraProperties.h:70
mmind::eye::Intrinsics2DCamera
Describes the intrinsic parameters of the 2D camera in the 3D camera based on the pinhole camera mode...
Definition
CameraProperties.h:110
mmind::eye::Size
Describes a two-dimensional size with a width and a height.
Definition
CommonTypes.h:40
mmind::eye::Transformation
Defines the rigid body transformations, including rotation matrix and translation vector.
Definition
CameraProperties.h:121
mmind::eye::Transformation::rotation
double rotation[3][3]
3*3 rotation matrix.
Definition
CameraProperties.h:122
mmind::eye::Transformation::translation
double translation[3]
3*1 translation vector in [x(mm), y(mm), z(mm)].
Definition
CameraProperties.h:123
Generated by
1.17.0