GoWebScanHistogram.h

Go to the documentation of this file.

/**
* @file    GoWebScanHistogram.h
* @brief   Declares a GoWebScanHistogram object.
*
* @internal
* Copyright (C) 2017-2026 by LMI Technologies Inc.
* Licensed under the MIT License.
* Redistributed files must retain the above copyright notice.
*/

#ifndef GO_WEB_SCAN_HISTOGRAM_H
#define GO_WEB_SCAN_HISTOGRAM_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>

/**
* @class   GoWebScanHistogram
* @extends kObject
* @ingroup GoWebScanSdk-Algorithms
* @brief   Represents a histogram.
*/
typedef kObject GoWebScanHistogram;

/**
* Constructs a GoWebScanHistogram object.
*
* @public                   @memberof GoWebScanHistogram
* @param  histogram         Receives the constructed GoWebScanHistogram object. 
* @param  minValue          Minimum value of the range of values represented by the histogram.
* @param  maxValue          Maximum value of the range of values represented by the histogram.
* @param  binWidthBits      Bit shift for the bin width. The bin width is determined by 1 << binWidthBits.    
* @param  allocator         Memory allocator (or kNULL for default). 
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanHistogram_Construct(GoWebScanHistogram* histogram, k32s minValue, k32s maxValue, k32s binWidthBits, kAlloc allocator);

/**
* Adds a single value to the histogram.
*
* @public                   @memberof GoWebScanHistogram
* @param  histogram         GoWebScanHistogram object. 
* @param  value             Value to add to histogram.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanHistogram_Add(GoWebScanHistogram histogram, k32s value); 

/**
* Adds an array of 8-bit unsigned values to the histogram.
*
* @public                   @memberof GoWebScanHistogram
* @param  histogram         GoWebScanHistogram object. 
* @param  values            Pointer to start of data buffer.
* @param  count             Count of values in data buffer.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanHistogram_AddArray8u(GoWebScanHistogram histogram, const k8u* values, kSize count);

/**
* Adds an array of 16-bit signed values to the histogram. Null values are ignored.
*
* @public                   @memberof GoWebScanHistogram
* @param  histogram         GoWebScanHistogram object. 
* @param  values            Pointer to start of data buffer.
* @param  count             Count of values in data buffer.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanHistogram_AddArray16sn(GoWebScanHistogram histogram, const k16s* values, kSize count); 

/**
* Adds an array of 32-bit signed values to the histogram. Null values are ignored.
*
* @public                   @memberof GoWebScanHistogram
* @param  histogram         GoWebScanHistogram object. 
* @param  values            Pointer to start of data buffer.
* @param  count             Count of values in data buffer.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanHistogram_AddArray32sn(GoWebScanHistogram histogram, const k32s* values, kSize count);

/**
* Adds an array of 32-bit signed values to the histogram.
*
* @public                   @memberof GoWebScanHistogram
* @param  histogram         GoWebScanHistogram object. 
* @param  values            Pointer to start of data buffer.
* @param  count             Count of values in data buffer.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanHistogram_AddArray32s(GoWebScanHistogram histogram, const k32s* values, kSize count); 

/**
* Clears histogram. Count is set to zero and bins are cleared.
*
* @public                   @memberof GoWebScanHistogram
* @param  histogram         GoWebScanHistogram object. 
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanHistogram_Clear(GoWebScanHistogram histogram); 

/**
* Gets the X-axis value at a specified quantile.
*
* @public                   @memberof GoWebScanHistogram
* @param  histogram         GoWebScanHistogram object. 
* @param  quantile          Quantile specified as a fraction. 
* @return                   Value at specified quantile.
*/
GoWebScanFx(k32s) GoWebScanHistogram_Quantile(GoWebScanHistogram histogram, k64f quantile); 

/**
* Gets the mode of the histogram.
*
* @public                   @memberof GoWebScanHistogram
* @param  histogram         GoWebScanHistogram object.  
* @return                   Mode of histogram.
*/
GoWebScanFx(k32s) GoWebScanHistogram_Mode(GoWebScanHistogram histogram); 

/**
* Gets the count of values contained in the histogram
*
* @public                   @memberof GoWebScanHistogram
* @param  histogram         GoWebScanHistogram object.  
* @return                   Histogram count.
*/
GoWebScanFx(kSize) GoWebScanHistogram_Count(GoWebScanHistogram histogram); 

/**
* Gets the number of bins.
*
* @public                   @memberof GoWebScanHistogram
* @param  histogram         GoWebScanHistogram object.  
* @return                   Bin count.
*/
GoWebScanFx(kSize) GoWebScanHistogram_BinCount(GoWebScanHistogram histogram); 

/**
* Gets the distribution at a given bin index.
*
* @public                   @memberof GoWebScanHistogram
* @param  histogram         GoWebScanHistogram object.  
* @param  binIndex          Bin index.  
* @return                   Distribution.
*/
GoWebScanFx(k32s) GoWebScanHistogram_BinAt(GoWebScanHistogram histogram, kSize binIndex); 

#include <GoWebScanSdk/GoWebScanHistogram.x.h>

#endif