Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
Presets.h
Go to the documentation of this file.
1
2
3/*******************************************************************************
4
5 * This file is part of the Zivid 3D Camera API
6
7 *
8
9 * Copyright 2015-2023 (C) Zivid AS
10
11 * All rights reserved.
12
13 *
14
15 * Zivid Software License, v1.0
16
17 *
18
19 * Redistribution and use in source and binary forms, with or without
20
21 * modification, are permitted provided that the following conditions are met:
22
23 *
24
25 * 1. Redistributions of source code must retain the above copyright notice,
26
27 * this list of conditions and the following disclaimer.
28
29 *
30
31 * 2. Redistributions in binary form must reproduce the above copyright notice,
32
33 * this list of conditions and the following disclaimer in the documentation
34
35 * and/or other materials provided with the distribution.
36
37 *
38
39 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
40
41 * to endorse or promote products derived from this software without specific
42
43 * prior written permission.
44
45 *
46
47 * 4. This software, with or without modification, must not be used with any
48
49 * other 3D camera than from Zivid AS.
50
51 *
52
53 * 5. Any software provided in binary form under this license must not be
54
55 * reverse engineered, decompiled, modified and/or disassembled.
56
57 *
58
59 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
60
61 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
62
63 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
64
65 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
66
67 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
68
69 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
70
71 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
72
73 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
74
75 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
76
77 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
78
79 *
80
81 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
82
83 * Info: http://www.zivid.com
84
85 ******************************************************************************/
86
87
88
89#pragma once
90
91#include <Zivid/CameraInfo.h>
92#include <Zivid/Settings.h>
93
94#include <string>
95#include <vector>
96
97#ifdef _MSC_VER
98# pragma warning(push)
99# pragma warning(disable : 4251) // "X needs to have dll-interface to be used by clients of class Y."
100#endif
101
102namespace Zivid
103{
104 namespace Presets
105 {
115 template<typename SettingsType>
117 {
118 public:
120 PresetBase(std::string name, SettingsType settings) noexcept;
121
123 const std::string &name() const noexcept;
124
131 const SettingsType &settings() const noexcept;
132
134 std::string toString() const;
135
136 private:
137 std::string m_name;
138 SettingsType m_settings;
139 };
140
145 template<typename PresetType>
147 {
148 public:
150 CategoryBase(std::string name, std::vector<PresetType> presets) noexcept;
151
153 const std::string &name() const noexcept;
154
161 const std::vector<PresetType> &presets() const noexcept;
162
164 std::string toString() const;
165
166 private:
167 std::string m_name;
168 std::vector<PresetType> m_presets;
169 };
170
175
187 ZIVID_CORE_EXPORT std::vector<Category> categories(const CameraInfo::Model &model);
188
190 template<typename Settings>
191 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const PresetBase<Settings> &preset);
192
194 template<typename Preset>
195 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const CategoryBase<Preset> &category);
196 } // namespace Presets
197} // namespace Zivid
198
199#ifdef _MSC_VER
200# pragma warning(pop)
201#endif
#define ZIVID_CORE_EXPORT
Definition: CoreExport.h:101
Information about camera model, serial number etc.
Definition: CameraInfo.h:123
Preset category. A preset category contains a collection of presets optimized for one scenario or use...
Definition: Presets.h:147
CategoryBase(std::string name, std::vector< PresetType > presets) noexcept
Constructor
const std::string & name() const noexcept
Get the name of the category
Presets are pre-defined settings that are tuned for different camera models to perform optimally unde...
Definition: Presets.h:117
PresetBase(std::string name, SettingsType settings) noexcept
Constructor
const std::string & name() const noexcept
Get the name of the preset
Settings used when capturing with a Zivid camera
Definition: Settings.h:124
ZIVID_CORE_EXPORT std::vector< Category > categories(const CameraInfo::Model &model)
Returns a list of preset categories, where each category contains a list of recommended presets.
The main Zivid namespace. All Zivid code is found here
Definition: Application.h:99
ZIVID_CORE_EXPORT std::string toString(const std::exception &exception)
Get string representation of the exception