Mech-Eye API 2.3.1
API reference documentation for Mech-Eye Industrial 3D Camera
All Classes Functions Variables Enumerations Enumerator Pages
Projector.h
1/*******************************************************************************
2 * BSD 3-Clause License
3 *
4 * Copyright (c) 2016-2024, 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 * Info: https://www.mech-mind.com/
33 *
34 ******************************************************************************/
35#pragma once
36#include "Parameter.h"
37
38namespace mmind {
39
40namespace eye {
41
42namespace projector_setting {
43
45{
46public:
47 static constexpr const char* name = "ProjectorPowerLevel";
48
49 static constexpr const char* description = "Set the brightness level of the projector.";
50
51 static constexpr Parameter::Type type = Parameter::Type::_Enum;
52
53 enum struct Value {
54 High,
55 Normal,
56 Low,
57 };
58};
59
61{
62public:
63 static constexpr const char* name = "ProjectorFringeCodingMode";
64
65 static constexpr const char* description =
66 "Select the pattern of the structured light to be projected.\n\nNote:\n* When "
67 "\"Translucent\" is selected, the following tool and parameters are unavailable:\n** "
68 "\"AntiFlickerMode\" in the \"mmind::eye::projector_setting\" namespace\n** "
69 "\"EdgePreservation\", \"EnableDistortionCorrection\", and \"DistortionCorrection\" in the "
70 "\"mmind::eye::pointcloud_processing_setting\" namespace\n* When \"Translucent\" is "
71 "selected, you can fill in the missing points in the point cloud by adjusting "
72 "\"GapFilling\" in the \"mmind::eye::projector_setting\" namespace.";
73
74 static constexpr Parameter::Type type = Parameter::Type::_Enum;
75
76 enum struct Value {
77 Fast,
79 Accurate,
85 };
86};
87
89{
90public:
91 static constexpr const char* name = "AntiFlickerMode";
92
93 static constexpr const char* description =
94 "Flicker refers to the rapid and periodical change in the intensity of artificial light. "
95 "This phenomenon can cause fluctuations in the depth data. Such fluctuation can be reduced "
96 "by adjusting the projection frequency of the structured light.\n\nNote: "
97 "\"AntiFlickerMode\" is unavailable when \"FringeCodingMode\" is set to \"Translucent\" or "
98 "\"Reflective\".";
99
100 static constexpr Parameter::Type type = Parameter::Type::_Enum;
101
102 enum struct Value {
103 Off,
104 AC50Hz,
105 AC60Hz,
106 };
107};
108
109} // namespace projector_setting
110
111} // namespace eye
112
113} // namespace mmind
Type
Describes the device parameter data types.
Definition Parameter.h:30
@ _Enum
Enumeration type.
Definition Parameter.h:34
@ AC50Hz
The AC frequency is 50Hz in most countries.
@ AC60Hz
The AC frequency in the U.S. and some Asian countries is 60Hz.
@ Low
Low level is used for scanning reflective objects.
@ High
High level is ofen used for scanning dark objects.