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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/raster/qgscontrastenhancementfunction.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsContrastEnhancementFunction
{
%Docstring(signature="appended")
A contrast enhancement function is the base class for all raster
contrast enhancements.
The purpose of a contrast enhancement is to enhanceContrast or clip a
pixel value into a specified bounding range.
%End
%TypeHeaderCode
#include "qgscontrastenhancementfunction.h"
%End
public:
QgsContrastEnhancementFunction( Qgis::DataType, double, double );
QgsContrastEnhancementFunction( const QgsContrastEnhancementFunction &f );
virtual ~QgsContrastEnhancementFunction();
virtual int enhance( double value );
%Docstring
A customizable method that takes in a double ``value`` and returns a int
between 0 and 255.
%End
virtual bool isValueInDisplayableRange( double value );
%Docstring
A customizable method to indicate if a pixel's value is within the
displayable range.
%End
void setMaximumValue( double value );
%Docstring
Sets the maximum ``value``.
.. seealso:: :py:func:`maximumValue`
.. seealso:: :py:func:`setMinimumValue`
%End
void setMinimumValue( double value );
%Docstring
Sets the minimum ``value``.
.. seealso:: :py:func:`minimumValue`
.. seealso:: :py:func:`setMaximumValue`
%End
double maximumValue() const;
%Docstring
Returns the maximum value.
.. seealso:: :py:func:`setMaximumValue`
.. seealso:: :py:func:`minimumValue`
.. versionadded:: 3.2
%End
double minimumValue() const;
%Docstring
Returns the minimum value.
.. seealso:: :py:func:`setMinimumValue`
.. seealso:: :py:func:`maximumValue`
.. versionadded:: 3.2
%End
protected:
private:
QgsContrastEnhancementFunction &operator=( const QgsContrastEnhancementFunction & );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/raster/qgscontrastenhancementfunction.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
