Multimedia API Reference

November 16, 2016 | 24.2.1 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
BayerSharpnessMap.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016, NVIDIA CORPORATION. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * * Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * * Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * * Neither the name of NVIDIA CORPORATION nor the names of its
13  * contributors may be used to endorse or promote products derived
14  * from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
20  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
23  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
24  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
37 #ifndef _ARGUS_EXT_BAYER_SHARPNESS_MAP_H
38 #define _ARGUS_EXT_BAYER_SHARPNESS_MAP_H
39 
50 namespace Argus
51 {
52 
60 DEFINE_UUID(ExtensionName, EXT_BAYER_SHARPNESS_MAP, 7d5e0470,4ea6,11e6,bdf4,08,00,20,0c,9a,66);
61 
62 namespace Ext
63 {
64 
70 DEFINE_UUID(InterfaceID, IID_BAYER_SHARPNESS_MAP_SETTINGS, 7d5e0471,4ea6,11e6,bdf4,08,00,20,0c,9a,66);
72 {
73 public:
74  static const InterfaceID& id() { return IID_BAYER_SHARPNESS_MAP_SETTINGS; }
75 
81  virtual void setBayerSharpnessMapEnable(bool enable) = 0;
82 
86  virtual bool getBayerSharpnessMapEnable() const = 0;
87 
88 protected:
90 };
91 
142 DEFINE_UUID(InterfaceID, IID_BAYER_SHARPNESS_MAP, 7d5e0472,4ea6,11e6,bdf4,08,00,20,0c,9a,66);
144 {
145 public:
146  static const InterfaceID& id() { return IID_BAYER_SHARPNESS_MAP; }
147 
152  virtual Location getBinStart() const = 0;
153 
157  virtual Size getBinSize() const = 0;
158 
162  virtual Size getBinCount() const = 0;
163 
168  virtual Size getBinInterval() const = 0;
169 
180  virtual float getBinData(BayerChannel channel,
181  const Location& binLocation,
182  Status* status = NULL) const = 0;
183 protected:
185 };
186 
187 } // namespace Ext
188 
189 } // namespace Argus
191 #endif // _ARGUS_EXT_BAYER_SHARPNESS_MAP_H
Extension name UUID.
Definition: Types.h:101
virtual void setBayerSharpnessMapEnable(bool enable)=0
Enables or disables Bayer sharpness map generation.
DEFINE_UUID(InterfaceID, IID_BAYER_SHARPNESS_MAP_SETTINGS, 7d5e0471, 4ea6, 11e6, bdf4, 08, 00, 20, 0c, 9a, 66)
virtual Location getBinStart() const =0
Returns the starting location of the first bin, in pixels.
Status
Status values returned by API function calls.
Definition: Types.h:220
The top-level interface class.
Definition: Types.h:312
Request settings used to configure Bayer sharpness map generation.
virtual Size getBinInterval() const =0
Returns the bin intervals for both the x and y axis.
virtual bool getBayerSharpnessMapEnable() const =0
Aggregates 2D co-ordinates of a location in a single structure.
Definition: Types.h:524
The Bayer sharpness map exposes image sharpness metrics that can be used in order to help determine t...
static const InterfaceID & id()
virtual Size getBinCount() const =0
Returns the number of bins in both the horizontal (width) and vertical (height) directions.
DEFINE_UUID(ExtensionName, EXT_BAYER_SHARPNESS_MAP, 7d5e0470, 4ea6, 11e6, bdf4, 08, 00, 20, 0c, 9a, 66)
The Ext::BayerSharpnessMap extension adds internally-generated sharpness metrics to CaptureMetadata r...
virtual float getBinData(BayerChannel channel, const Location &binLocation, Status *status=NULL) const =0
Returns the sharpness data for a single bin.
A unique identifier for an libargus Interface.
Definition: Types.h:322
Aggregates width and height in a single structure.
Definition: Types.h:505
static const InterfaceID & id()
BayerChannel
Definition: Types.h:207
virtual Size getBinSize() const =0
Returns the size of each bin, in pixels.