File: qgsrasterminmaxorigin.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (176 lines) | stat: -rw-r--r-- 4,552 bytes parent folder | download | duplicates (6)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/raster/qgsrasterminmaxorigin.h                              *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/





class QgsRasterMinMaxOrigin
{
%Docstring(signature="appended")
This class describes the origin of min/max values. It does not store by
itself the min/max values.
%End

%TypeHeaderCode
#include "qgsrasterminmaxorigin.h"
%End
  public:

    static const double CUMULATIVE_CUT_LOWER;

    static const double CUMULATIVE_CUT_UPPER;

    static const double DEFAULT_STDDEV_FACTOR;

    //! \brief This enumerator describes the limits used to compute min/max values
    enum Limits /BaseType=IntEnum/
    {
      None /PyName=None_/,
      MinMax,
      StdDev,
      CumulativeCut
    };

    enum Extent /BaseType=IntEnum/
    {
      //! Whole raster is used to compute statistics.
      WholeRaster,
      //! Current extent of the canvas (at the time of computation) is used to compute statistics.
      CurrentCanvas,
      //! Constantly updated extent of the canvas is used to compute statistics.
      UpdatedCanvas
    };

    enum StatAccuracy /BaseType=IntEnum/
    {
      //! Exact statistics.
      Exact,
      //! Approximated statistics.
      Estimated
    };

    QgsRasterMinMaxOrigin();

    bool operator ==( const QgsRasterMinMaxOrigin &other ) const;


    QgsRasterMinMaxOrigin::Limits limits() const;
%Docstring
Returns the raster limits.
%End

    QgsRasterMinMaxOrigin::Extent extent() const;
%Docstring
Returns the raster extent.
%End

    QgsRasterMinMaxOrigin::StatAccuracy statAccuracy() const;
%Docstring
Returns the raster statistic accuracy.
%End

    double cumulativeCutLower() const;
%Docstring
Returns the lower bound of cumulative cut method (between 0 and 1).
%End

    double cumulativeCutUpper() const;
%Docstring
Returns the upper bound of cumulative cut method (between 0 and 1).
%End

    double stdDevFactor() const;
%Docstring
Returns the factor f so that the min/max range is [ mean - f * stddev ,
mean + f * stddev ]
%End


    void setLimits( QgsRasterMinMaxOrigin::Limits limits );
%Docstring
Sets the limits.
%End

    void setExtent( QgsRasterMinMaxOrigin::Extent extent );
%Docstring
Sets the extent.
%End

    void setStatAccuracy( QgsRasterMinMaxOrigin::StatAccuracy accuracy );
%Docstring
Sets the statistics accuracy.
%End

    void setCumulativeCutLower( double val );
%Docstring
Sets the lower bound of cumulative cut method (between 0 and 1).
%End

    void setCumulativeCutUpper( double val );
%Docstring
Sets the upper bound of cumulative cut method (between 0 and 1).
%End

    void setStdDevFactor( double val );
%Docstring
Sets the factor f so that the min/max range is [ mean - f * stddev ,
mean + f * stddev ]
%End


    void writeXml( QDomDocument &doc, QDomElement &parentElem ) const;
%Docstring
Serialize object.
%End

    void readXml( const QDomElement &elem );
%Docstring
Deserialize object.
%End


    static QString limitsString( Limits limits );
%Docstring
Returns a string to serialize Limits
%End

    static Limits limitsFromString( const QString &limits );
%Docstring
Deserialize Limits
%End

    static QString extentString( QgsRasterMinMaxOrigin::Extent extent );
%Docstring
Returns a string to serialize Extent
%End

    static QgsRasterMinMaxOrigin::Extent extentFromString( const QString &extent );
%Docstring
Deserialize Extent
%End

    static QString statAccuracyString( QgsRasterMinMaxOrigin::StatAccuracy accuracy );
%Docstring
Returns a string to serialize StatAccuracy
%End

    static QgsRasterMinMaxOrigin::StatAccuracy statAccuracyFromString( const QString &accuracy );
%Docstring
Deserialize StatAccuracy
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/raster/qgsrasterminmaxorigin.h                              *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/