Skip to content

Commit 401b8e1

Browse files
author
timlinux
committed
Api documentation updates - added class descriptions for all raster classes
git-svn-id: http://svn.osgeo.org/qgis/trunk@9226 c8812cc2-4d05-0410-92ff-de0c093fc19c
1 parent 2f03fa0 commit 401b8e1

18 files changed

+130
-80
lines changed

src/core/qgsdistancearea.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
class QgsGeometry;
2424

2525
/** \ingroup core
26-
General purpose distance and area calculator
26+
General purpose distance and area calculator.
2727
- calculations are done on ellipsoid
2828
- it's possible to pass points/features in any CRS, coordinates are transformed
2929
- two options how to use it

src/core/raster/qgscliptominmaxenhancement.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ email : ersts@amnh.org
2121

2222
#include "qgscontrastenhancementfunction.h"
2323

24+
/** \ingroup core
25+
* A raster contrast enhancement that will clip a value to the specified min/max range.
26+
* For example if a min max range of [10,240] is specified in the constructor, and
27+
* a value of 250 is called using enhanceValue(), the value will be truncated ('clipped')
28+
* to 240.
29+
*/
2430
class CORE_EXPORT QgsClipToMinMaxEnhancement : public QgsContrastEnhancementFunction
2531
{
2632

src/core/raster/qgscolorrampshader.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ originally part of the larger QgsRasterLayer class
2525

2626
#include "qgsrastershaderfunction.h"
2727

28+
/** \ingroup core
29+
* A ramp shader will color a raster pixel based on a list of values ranges in a ramp.
30+
*/
2831
class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction
2932
{
3033

src/core/raster/qgscolortable.h

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,6 @@
1919

2020
#include <QVector>
2121

22-
/*
23-
* Because of performance, this class can store color rules in 2 forms:
24-
* 1) discrete - vector of descrete values and their colors; can be accessed by index (from 0)
25-
* 2) ramp - vector of ramps defined by min and max value and a color for min amd max value,
26-
* colors between min and max are interpolated linearly.
27-
*
28-
* Only one type should be used for one instance.
29-
*
30-
*/
3122

3223

3324
typedef struct
@@ -41,6 +32,18 @@ typedef struct
4132
unsigned char min_c1, min_c2, min_c3, min_c4;
4233
unsigned char max_c1, max_c2, max_c3, max_c4;
4334
} RAMP;
35+
36+
/** \ingroup core
37+
* A raster color table contains a list of indexed values and the color associated with each index.
38+
* Because of performance, this class can store color rules in 2 forms:
39+
* 1) discrete - vector of descrete values and their colors; can be accessed by index (from 0)
40+
* 2) ramp - vector of ramps defined by min and max value and a color for min amd max value,
41+
* colors between min and max are interpolated linearly.
42+
*
43+
* Only one type should be used for one instance.
44+
*
45+
*/
46+
4447
class CORE_EXPORT QgsColorTable
4548
{
4649
public:

src/core/raster/qgscontrastenhancement.cpp

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@ class originally created circa 2004 by T.Sutton, Gary E.Sherman, Steve Halasz
2828

2929
QgsContrastEnhancement::QgsContrastEnhancement( QgsRasterDataType theDataType )
3030
{
31-
QgsDebugMsg( "called" );
32-
3331
mLookupTable = 0;
3432
mContrastEnhancementFunction = 0;
3533
mEnhancementDirty = false;

src/core/raster/qgscontrastenhancement.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@ class originally created circa 2004 by T.Sutton, Gary E.Sherman, Steve Halasz
2525

2626
class QgsContrastEnhancementFunction;
2727

28+
/** \ingroup core
29+
* Manipulates raster pixel values so that they stretch or clip into a
30+
* specified numerical range according to the specified
31+
* CONTRAST_ENHANCEMENT_ALGORITHM.
32+
*/
2833
class CORE_EXPORT QgsContrastEnhancement
2934
{
3035

src/core/raster/qgscontrastenhancementfunction.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ email : ersts@amnh.org
2121

2222
#include "qgscontrastenhancement.h"
2323

24+
/** \ingroup core
25+
* A contrast enhancement funcion is the base class for all raster contrast enhancements.
26+
*
27+
* The purpose of a contrast enhancement is to stretch or clip a pixel value into
28+
* a specified bounding range.
29+
*/
2430
class CORE_EXPORT QgsContrastEnhancementFunction
2531
{
2632

src/core/raster/qgsfreakoutshader.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ class originally created circa 2004 by T.Sutton, Gary E.Sherman, Steve Halasz
2323

2424
#include "qgsrastershaderfunction.h"
2525

26+
/** \ingroup core
27+
* A colorful false color shader that will frighten your granny and make your dogs howl.
28+
*/
2629
class CORE_EXPORT QgsFreakOutShader : public QgsRasterShaderFunction
2730
{
2831

src/core/raster/qgslinearminmaxenhancement.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ email : ersts@amnh.org
2121

2222
#include "qgscontrastenhancementfunction.h"
2323

24+
/** \ingroup core
25+
* A colour enhancement function that performs a linear stretch between min and max.
26+
*/
2427
class CORE_EXPORT QgsLinearMinMaxEnhancement : public QgsContrastEnhancementFunction
2528
{
2629

src/core/raster/qgslinearminmaxenhancementwithclip.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ email : ersts@amnh.org
2121

2222
#include "qgscontrastenhancementfunction.h"
2323

24+
/** \ingroup core
25+
* A linear stretch enhancement that first clips to min max and then stretches
26+
* linearly between min and max.
27+
*/
2428
class CORE_EXPORT QgsLinearMinMaxEnhancementWithClip : public QgsContrastEnhancementFunction
2529
{
2630

0 commit comments

Comments
 (0)