Mech-Eye API 2.5.1
API reference documentation for Mech-Eye Industrial 3D Camera
Loading...
Searching...
No Matches
CameraProperties.h
Go to the documentation of this file.
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
41namespace mmind {
42
43namespace eye {
44
49{
50 std::string model;
51 std::string deviceName;
52 std::string serialNumber;
56 std::string ipAddress;
57 std::string subnetMask{"255.255.255.0"};
59 uint16_t port{};
60};
61
66{
69};
70
75{
77};
78
83{
84 double fx{};
85 double fy{};
86 double cx{};
87 double cy{};
88};
89
94{
95 double k1{};
96 double k2{};
97 double p1{};
98 double p2{};
99 double k3{};
100};
101
107{
110};
111
118{
119 double rotation[3][3] = {{1, 0, 0}, {0, 1, 0}, {0, 0, 1}};
120 double translation[3] = {0, 0, 0};
121};
122
128{
131};
132
139{
144
150};
151
156
157} // namespace eye
158
159} // namespace mmind
Describes the version information.
Definition Version.h:19
ColorTypeOf2DCamera
Defines the color type of the 2D camera in the 3D camera.
Definition CameraProperties.h:155
IpAssignmentMethod
Describes the assignment method of the device IP address.
Definition CommonTypes.h:238
Platform
Describes the platform of the camera.
Definition CommonTypes.h:243
Definition Camera.h:45
Describes the distortion parameters.
Definition CameraProperties.h:94
double k3
Radial distortion coefficients.
Definition CameraProperties.h:99
double k2
Radial distortion coefficients.
Definition CameraProperties.h:96
double k1
Radial distortion coefficients.
Definition CameraProperties.h:95
double p2
Tangential distortion coefficients.
Definition CameraProperties.h:98
double p1
Tangential distortion coefficients.
Definition CameraProperties.h:97
Defines the camera information.
Definition CameraProperties.h:49
Platform platform
The platform name of the device.
Definition CameraProperties.h:53
IpAssignmentMethod ipAssignmentMethod
The IP address assignment method of the device.
Definition CameraProperties.h:58
std::string serialNumber
The serial number of the device.
Definition CameraProperties.h:52
std::string model
The device model, such as Mech-Eye NANO.
Definition CameraProperties.h:50
Version firmwareVersion
The version of the firmware (upgradable).
Definition CameraProperties.h:55
std::string subnetMask
The subnet mask of the device.
Definition CameraProperties.h:57
Version hardwareVersion
The version of the hardware (pre-determined in the factory).
Definition CameraProperties.h:54
uint16_t port
The port used by the device.
Definition CameraProperties.h:59
std::string deviceName
The device name (UTF-8 encoded).
Definition CameraProperties.h:51
std::string ipAddress
The IP address of the device.
Definition CameraProperties.h:56
Defines the 3D camera intrinsic parameters, including the intrinsic parameters of the texture 2D came...
Definition CameraProperties.h:139
Transformation depthToTexture
Definition CameraProperties.h:145
Intrinsics2DCamera depth
The intrinsic parameters of the depth 2D camera(s) for capturing the depth map.
Definition CameraProperties.h:143
Intrinsics2DCamera texture
Definition CameraProperties.h:140
Describes the camera intrinsic parameter matrix.
Definition CameraProperties.h:83
double fy
Focal lengths.
Definition CameraProperties.h:85
double cy
Principal point.
Definition CameraProperties.h:87
double fx
Focal lengths.
Definition CameraProperties.h:84
double cx
Principal point.
Definition CameraProperties.h:86
Defines the camera image resolutions, including the resolutions of the 2D image (texture) and depth m...
Definition CameraProperties.h:128
Size depth
Definition CameraProperties.h:130
Size texture
Definition CameraProperties.h:129
Describes the camera's statuses.
Definition CameraProperties.h:75
DeviceTemperature temperature
Definition CameraProperties.h:76
Describes the device temperatures.
Definition CameraProperties.h:66
float projectorTemperature
The temperature (in °C) of the camera projector.
Definition CameraProperties.h:68
float cpuTemperature
The temperature (in °C) of the camera CPU.
Definition CameraProperties.h:67
Describes the intrinsic parameters of the 2D camera in the 3D camera based on the pinhole camera mode...
Definition CameraProperties.h:107
CameraDistortion cameraDistortion
Definition CameraProperties.h:108
CameraMatrix cameraMatrix
Definition CameraProperties.h:109
Describes a two-dimensional size with a width and a height.
Definition CommonTypes.h:40
Defines the rigid body transformations, including rotation matrix and translation vector.
Definition CameraProperties.h:118
double translation[3]
3*1 translation vector in [x(mm), y(mm), z(mm)].
Definition CameraProperties.h:120
double rotation[3][3]
3*3 rotation matrix.
Definition CameraProperties.h:119