Zivid C++ API 2.13.1+18e79e79-1
PixelMapping.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
47
48#include <iosfwd>
49#include <string>
50
51namespace Zivid
52{
53 namespace Experimental
54 {
60 {
61 public:
63 : m_rowStride{ 1 }
64 , m_colStride{ 1 }
65 , m_rowOffset{ 0.0 }
66 , m_colOffset{ 0.0 }
67 {}
68
69 PixelMapping(const int rowStride, const int colStride, const float rowOffset, const float colOffset)
70 : m_rowStride{ rowStride }
71 , m_colStride{ colStride }
72 , m_rowOffset{ rowOffset }
73 , m_colOffset{ colOffset }
74 {}
75
78 int rowStride() const
79 {
80 return m_rowStride;
81 }
82
85 int colStride() const
86 {
87 return m_colStride;
88 }
89
92 float rowOffset() const
93 {
94 return m_rowOffset;
95 }
96
99 float colOffset() const
100 {
101 return m_colOffset;
102 }
103
105 ZIVID_CORE_EXPORT std::string toString() const;
106
109
112
113 private:
114 int m_rowStride;
115 int m_colStride;
116 float m_rowOffset;
117 float m_colOffset;
118 };
119
121 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const PixelMapping &pixelMapping);
122 } // namespace Experimental
123} // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition CoreExport.h:56
Pixel mapping from subsampled to full resolution.
Definition PixelMapping.h:60
ZIVID_CORE_EXPORT std::string toString() const
Get string representation.
int colStride() const
Col stride.
Definition PixelMapping.h:85
ZIVID_CORE_EXPORT bool operator!=(const PixelMapping &rhs) const
Check for inequality.
float colOffset() const
Offset in x, or column.
Definition PixelMapping.h:99
ZIVID_CORE_EXPORT bool operator==(const PixelMapping &rhs) const
Check for equality.
float rowOffset() const
Offset in y, or row.
Definition PixelMapping.h:92
PixelMapping(const int rowStride, const int colStride, const float rowOffset, const float colOffset)
Definition PixelMapping.h:69
int rowStride() const
Row stride.
Definition PixelMapping.h:78
PixelMapping()
Definition PixelMapping.h:62
ZIVID_CORE_EXPORT std::ostream & operator<<(std::ostream &stream, const PixelMapping &pixelMapping)
Serialize the value to a stream.
The main Zivid namespace. All Zivid code is found here.
Definition Application.h:56