Zivid C++ API 2.13.1+18e79e79-1
SNR.h
Go to the documentation of this file.
1/*******************************************************************************
2 * This file is part of the Zivid API
3 *
4 * Copyright 2015-2024 (C) Zivid AS
5 * All rights reserved.
6 *
7 * Zivid Software License, v1.0
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * 2. Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
18 *
19 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
20 * to endorse or promote products derived from this software without specific
21 * prior written permission.
22 *
23 * 4. This software, with or without modification, must not be used with any
24 * other 3D camera than from Zivid AS.
25 *
26 * 5. Any software provided in binary form under this license must not be
27 * reverse engineered, decompiled, modified and/or disassembled.
28 *
29 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
30 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
31 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
32 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
33 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
35 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
36 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
41 * Info: http://www.zivid.com
42 ******************************************************************************/
43
44#pragma once
45
48
49#include <iosfwd>
50#include <string>
51#include <type_traits>
52
53namespace Zivid
54{
58 struct SNR
59 {
61 using ValueType = float;
62
65
67 ZIVID_CORE_EXPORT std::string toString() const;
68
70 ZIVID_CORE_EXPORT bool operator==(const SNR &rhs) const;
71
73 ZIVID_CORE_EXPORT bool operator!=(const SNR &rhs) const;
74 };
75
77 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const Zivid::SNR &snr);
78
80} // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition CoreExport.h:56
#define ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE(Type, size)
Definition DataFormatUtils.h:48
The main Zivid namespace. All Zivid code is found here.
Definition Application.h:56
std::ostream & operator<<(std::ostream &stream, const Array2D< T > &array)
Serialize array information to a stream.
Definition Array2D.h:285
Signal-to-Noise ratio (SNR)
Definition SNR.h:59
ZIVID_CORE_EXPORT std::string toString() const
Get the value as string.
ValueType value
SNR value.
Definition SNR.h:64
float ValueType
The type of the SNR value.
Definition SNR.h:61
ZIVID_CORE_EXPORT bool operator!=(const SNR &rhs) const
Check for inequality.
ZIVID_CORE_EXPORT bool operator==(const SNR &rhs) const
Check for equality.