Zivid C++ API 2.13.1+18e79e79-1
Image.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
46#include "Zivid/Array2D.h"
47#include "Zivid/Color.h"
49
50#include <string>
51#include <type_traits>
52
53namespace Zivid
54{
55#ifndef NO_DOC
57 namespace Detail
58 {
59 template<typename T>
60 class LoadImageTag
61 {};
62
63 ZIVID_CORE_EXPORT void saveImageImpl(const Zivid::Array2D<ColorRGBA> &img, const std::string &fileName);
64 ZIVID_CORE_EXPORT void saveImageImpl(const Zivid::Array2D<ColorBGRA> &img, const std::string &fileName);
65 ZIVID_CORE_EXPORT void saveImageImpl(const Zivid::Array2D<ColorSRGB> &img, const std::string &fileName);
67 const std::string &fileName,
68 LoadImageTag<ColorBGRA> /* tag */);
70 const std::string &fileName,
71 LoadImageTag<ColorRGBA> /* tag */);
73 const std::string &fileName,
74 LoadImageTag<ColorSRGB> /* tag */);
75 } // namespace Detail
76#endif
83 template<class PixelFormat>
84 class Image : public Array2D<PixelFormat>
85 {
86 public:
87 static_assert(
88 std::is_same<PixelFormat, Zivid::ColorRGBA>::value || std::is_same<PixelFormat, Zivid::ColorBGRA>::value
89 || std::is_same<PixelFormat, Zivid::ColorSRGB>::value,
90 "PixelFormat must be Zivid::ColorRGBA, Zivid::ColorBGRA or Zivid::ColorSRGB");
91
93 Image() = default;
94
96 template<typename Iterator>
97 Image(const Resolution &resolution, Iterator beginIt, Iterator endIt)
98 : Array2D<PixelFormat>(resolution, beginIt, endIt)
99 {}
100
114 Image(const Resolution &resolution, const unsigned char *begin, const unsigned char *end)
115 : Array2D<PixelFormat>{ resolution, begin, end }
116
117 {}
118
124 explicit Image(const std::string &fileName)
125 : Image{ Detail::loadImageImpl(fileName, Detail::LoadImageTag<PixelFormat>{}) }
126
127 {}
128
131 {
133 }
134
137 void save(const std::string &fileName) const
138 {
139 return Detail::saveImageImpl(*this, fileName);
140 }
141
142#ifndef NO_DOC
143 explicit Image(Array2D<PixelFormat> &&a)
144 : Array2D<PixelFormat>(std::move(a))
145 {}
146#endif
147 };
148} // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition CoreExport.h:56
Two-dimensional container of data.
Definition Array2D.h:83
size_t height() const
Get the height of the array (number of rows)
Definition Array2D.h:106
ConstIterator end() const
Definition Array2D.h:174
size_t width() const
Get the width of the array (number of columns)
Definition Array2D.h:100
ConstIterator begin() const
Definition Array2D.h:168
A 2-dimensional image.
Definition Image.h:85
void save(const std::string &fileName) const
Save the image to a file. The supported file types are PNG (.png), JPEG (.jpg, .jpeg) and BMP (....
Definition Image.h:137
Image(const Resolution &resolution, const unsigned char *begin, const unsigned char *end)
Create an image from an unsigned char byte buffer.
Definition Image.h:114
Image()=default
Create an empty image.
Image(const std::string &fileName)
Load an image from a file.
Definition Image.h:124
Image(const Resolution &resolution, Iterator beginIt, Iterator endIt)
Create an image from a buffer of elements by copy.
Definition Image.h:97
Resolution resolution() const
Get the resolution of the image.
Definition Image.h:130
Class describing a resolution with a width and a height.
Definition Resolution.h:56
The main Zivid namespace. All Zivid code is found here.
Definition Application.h:56