/usr/include/fg/histogram.h is in libforge-dev 0.9.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 | /*******************************************************
* Copyright (c) 2015-2019, ArrayFire
* All rights reserved.
*
* This file is distributed under 3-clause BSD license.
* The complete license agreement can be obtained at:
* http://arrayfire.com/licenses/BSD-3-Clause
********************************************************/
#pragma once
#include <fg/defines.h>
#ifdef __cplusplus
extern "C" {
#endif
/** \addtogroup hist_functions
* @{
*/
/**
Creates a Histogram object
\param[out] pHistogram will point to the histogram object created after this function call
\param[in] pNBins is number of bins the data is sorted out
\param[in] pDataType takes one of the values of \ref fg_dtype that indicates
the integral data type of histogram data
\return \ref fg_err error code
*/
FGAPI fg_err fg_create_histogram(fg_histogram *pHistogram,
const unsigned pNBins, const fg_dtype pDataType);
/**
Destroy Histogram object
\param[in] pHistogram is the histogram handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_destroy_histogram(fg_histogram pHistogram);
/**
Set the color of bar in the bar graph(histogram)
This is global alpha value for the histogram rendering that takes
effect if individual bar alphas are not set by calling the following
member functions
- Histogram::alphas()
- Histogram::alphasSize()
\param[in] pHistogram is the histogram handle
\param[in] pRed is Red component in range [0, 1]
\param[in] pGreen is Green component in range [0, 1]
\param[in] pBlue is Blue component in range [0, 1]
\param[in] pAlpha is Alpha component in range [0, 1]
\return \ref fg_err error code
*/
FGAPI fg_err fg_set_histogram_color(fg_histogram pHistogram,
const float pRed, const float pGreen,
const float pBlue, const float pAlpha);
/**
Set legend for histogram plot
\param[in] pHistogram is the histogram handle
\param[in] pLegend
\return \ref fg_err error code
*/
FGAPI fg_err fg_set_histogram_legend(fg_histogram pHistogram, const char* pLegend);
/**
Get the resource identifier for vertices buffer
\param[out] pOut will have the buffer identifier after this function is called
\param[in] pHistogram is the histogram handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_histogram_vertex_buffer(unsigned* pOut, const fg_histogram pHistogram);
/**
Get the resource identifier for colors buffer
\param[out] pOut will have the buffer identifier after this function is called
\param[in] pHistogram is the histogram handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_histogram_color_buffer(unsigned* pOut, const fg_histogram pHistogram);
/**
Get the resource identifier for alpha values buffer
\param[out] pOut will have the buffer identifier after this function is called
\param[in] pHistogram is the histogram handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_histogram_alpha_buffer(unsigned* pOut, const fg_histogram pHistogram);
/**
Get the vertices buffer size in bytes
\param[out] pOut will have the buffer size in bytes after this function is called
\param[in] pHistogram is the histogram handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_histogram_vertex_buffer_size(unsigned* pOut, const fg_histogram pHistogram);
/**
Get the colors buffer size in bytes
\param[out] pOut will have the buffer size in bytes after this function is called
\param[in] pHistogram is the histogram handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_histogram_color_buffer_size(unsigned* pOut, const fg_histogram pHistogram);
/**
Get the alpha values buffer size in bytes
\param[out] pOut will have the buffer size in bytes after this function is called
\param[in] pHistogram is the histogram handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_histogram_alpha_buffer_size(unsigned* pOut, const fg_histogram pHistogram);
/** @} */
#ifdef __cplusplus
}
#endif
#ifdef __cplusplus
namespace forge
{
/**
\class Histogram
\brief Histogram is a bar graph to display data frequencey.
*/
class Histogram {
private:
fg_histogram mValue;
public:
/**
Creates a Histogram object
\param[in] pNBins is number of bins the data is sorted out
\param[in] pDataType takes one of the values of \ref fg_dtype that indicates
the integral data type of histogram data
*/
FGAPI Histogram(const unsigned pNBins, const dtype pDataType);
/**
Copy constructor for Histogram
\param[in] pOther is the Histogram of which we make a copy of.
*/
FGAPI Histogram(const Histogram& pOther);
/**
Histogram Destructor
*/
FGAPI ~Histogram();
/**
Set the color of bar in the bar graph(histogram)
\param[in] pColor takes values of type forge::Color to define bar color
**/
FGAPI void setColor(const Color pColor);
/**
Set the color of bar in the bar graph(histogram)
This is global alpha value for the histogram rendering that takes
effect if individual bar alphas are not set by calling the following
member functions
- Histogram::alphas()
- Histogram::alphasSize()
\param[in] pRed is Red component in range [0, 1]
\param[in] pGreen is Green component in range [0, 1]
\param[in] pBlue is Blue component in range [0, 1]
\param[in] pAlpha is Alpha component in range [0, 1]
*/
FGAPI void setColor(const float pRed, const float pGreen,
const float pBlue, const float pAlpha);
/**
Set legend for histogram plot
\param[in] pLegend
*/
FGAPI void setLegend(const char* pLegend);
/**
Get the buffer identifier for vertices
\return vertex buffer resource id.
*/
FGAPI unsigned vertices() const;
/**
Get the buffer identifier for color values per vertex
\return colors buffer resource id.
*/
FGAPI unsigned colors() const;
/**
Get the buffer identifier for alpha values per vertex
\return alpha values buffer resource id.
*/
FGAPI unsigned alphas() const;
/**
Get the vertex buffer size in bytes
\return vertex buffer size in bytes
*/
FGAPI unsigned verticesSize() const;
/**
Get the colors buffer size in bytes
\return colors buffer size in bytes
*/
FGAPI unsigned colorsSize() const;
/**
Get the alpha values buffer size in bytes
\return alpha buffer size in bytes
*/
FGAPI unsigned alphasSize() const;
/**
Get the handle to internal implementation of Histogram
*/
FGAPI fg_histogram get() const;
};
}
#endif
|