1
+ /************************************************************************
2
+ * This file has been generated automatically from *
3
+ * *
4
+ * src/core/raster/qgsrasterbandstats.h *
5
+ * *
6
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again *
7
+ ************************************************************************/
8
+
9
+
10
+
11
+
12
+
1
13
2
- /** \ingroup core
3
- * The RasterBandStats struct is a container for statistics about a single
4
- * raster band.
5
- */
6
14
class QgsRasterBandStats
7
15
{
8
- %TypeHeaderCode
9
- #include <qgsrasterbandstats.h>
16
+ %Docstring
17
+ The RasterBandStats struct is a container for statistics about a single
18
+ raster band.
10
19
%End
11
20
21
+ %TypeHeaderCode
22
+ #include "qgsrasterbandstats.h"
23
+ %End
12
24
public:
13
25
enum Stats
14
26
{
@@ -25,48 +37,80 @@ class QgsRasterBandStats
25
37
26
38
QgsRasterBandStats();
27
39
28
- /** Compares region, size etc. not collected statistics */
29
40
bool contains( const QgsRasterBandStats &s ) const;
41
+ %Docstring
42
+ Compares region, size etc. not collected statistics
43
+ :rtype: bool
44
+ %End
30
45
31
- /** \brief The gdal band number (starts at 1)*/
32
46
int bandNumber;
47
+ %Docstring
48
+ The gdal band number (starts at 1)
49
+ %End
33
50
34
- /** \brief The number of not no data cells in the band. */
35
- // TODO: check if no data are excluded in stats calculation
36
51
qgssize elementCount;
37
52
38
- /** \brief The maximum cell value in the raster band. NO_DATA values
39
- * are ignored. This does not use the gdal GetMaximmum function. */
40
53
double maximumValue;
54
+ %Docstring
55
+ The maximum cell value in the raster band. NO_DATA values
56
+ are ignored. This does not use the gdal GetMaximmum function. *
57
+ %End
41
58
42
- /** \brief The minimum cell value in the raster band. NO_DATA values
43
- * are ignored. This does not use the gdal GetMinimum function. */
44
59
double minimumValue;
60
+ %Docstring
61
+ The minimum cell value in the raster band. NO_DATA values
62
+ are ignored. This does not use the gdal GetMinimum function. *
63
+ %End
45
64
46
- /** \brief The mean cell value for the band. NO_DATA values are excluded. */
47
65
double mean;
66
+ %Docstring
67
+ The mean cell value for the band. NO_DATA values are excluded.
68
+ %End
48
69
49
- /** \brief The range is the distance between min & max. */
50
70
double range;
71
+ %Docstring
72
+ The range is the distance between min & max.
73
+ %End
51
74
52
- /** \brief The standard deviation of the cell values. */
53
75
double stdDev;
76
+ %Docstring
77
+ The standard deviation of the cell values.
78
+ %End
54
79
55
- /** \brief Collected statistics */
56
80
int statsGathered;
81
+ %Docstring
82
+ Collected statistics
83
+ %End
57
84
58
- /** \brief The sum of all cells in the band. NO_DATA values are excluded. */
59
85
double sum;
86
+ %Docstring
87
+ The sum of all cells in the band. NO_DATA values are excluded.
88
+ %End
60
89
61
- /** \brief The sum of the squares. Used to calculate standard deviation. */
62
90
double sumOfSquares;
91
+ %Docstring
92
+ The sum of the squares. Used to calculate standard deviation.
93
+ %End
63
94
64
- /** \brief Number of columns used to calc statistics */
65
95
int width;
96
+ %Docstring
97
+ Number of columns used to calc statistics
98
+ %End
66
99
67
- /** \brief Number of rows used to calc statistics */
68
100
int height;
101
+ %Docstring
102
+ Number of rows used to calc statistics
103
+ %End
69
104
70
- /** \brief Extent used to calc statistics */
71
105
QgsRectangle extent;
106
+ %Docstring
107
+ Extent used to calc statistics
108
+ %End
72
109
};
110
+ /************************************************************************
111
+ * This file has been generated automatically from *
112
+ * *
113
+ * src/core/raster/qgsrasterbandstats.h *
114
+ * *
115
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again *
116
+ ************************************************************************/
0 commit comments