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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgshistogram.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsHistogram
{
%Docstring(signature="appended")
Calculator for a numeric histogram from a list of values.
%End
%TypeHeaderCode
#include "qgshistogram.h"
%End
public:
QgsHistogram();
virtual ~QgsHistogram();
void setValues( const QList<double> &values );
%Docstring
Assigns numeric source values for the histogram.
:param values: list of doubles
%End
bool setValues( const QgsVectorLayer *layer, const QString &fieldOrExpression, QgsFeedback *feedback = 0 );
%Docstring
Assigns numeric source values for the histogram from a vector layer's
field or as the result of an expression.
:param layer: vector layer
:param fieldOrExpression: field name or expression to be evaluated
:param feedback: optional feedback object to allow cancellation of
calculation
:return: ``True`` if values were successfully set
%End
double optimalBinWidth() const;
%Docstring
Calculates the optimal bin width using the Freedman-Diaconis rule. Bins
widths are determined by the inter-quartile range of values and the
number of values.
:return: optimal width for bins
.. seealso:: :py:func:`optimalNumberBins`
.. note::
values must first be specified using :py:func:`~QgsHistogram.setValues`
%End
int optimalNumberBins() const;
%Docstring
Returns the optimal number of bins for the source values, calculated
using the Freedman-Diaconis rule. The number of bins are determined by
the inter-quartile range of values and the number of values.
:return: optimal number of bins
.. seealso:: :py:func:`optimalBinWidth`
.. note::
values must first be specified using :py:func:`~QgsHistogram.setValues`
%End
QList<double> binEdges( int bins ) const;
%Docstring
Returns a list of edges for the histogram for a specified number of
bins. This list will be length bins + 1, as both the first and last
value are also included.
:param bins: number of bins
:return: list of bin edges
.. note::
values must first be specified using :py:func:`~QgsHistogram.setValues`
%End
QList<int> counts( int bins ) const;
%Docstring
Returns the calculated list of the counts for the histogram bins.
:param bins: number of histogram bins
:return: list of histogram counts
.. note::
values must first be specified using :py:func:`~QgsHistogram.setValues`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgshistogram.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
