tcElevationOptimization::loadSnapShot: simplify reliability expression
[tecorrec.git] / geo / tcElevationData.h
blob16ba2b91185040e29a7ff09e8a31a15972cf9e65
1 /***************************************************************************
2 * This file is part of Tecorrec. *
3 * Copyright 2008 James Hogan <james@albanarts.com> *
4 * *
5 * Tecorrec is free software: you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation, either version 2 of the License, or *
8 * (at your option) any later version. *
9 * *
10 * Tecorrec is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
14 * *
15 * You should have received a copy of the GNU General Public License *
16 * along with Tecorrec. If not, write to the Free Software Foundation, *
17 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
18 ***************************************************************************/
20 #ifndef _tcElevationData_h_
21 #define _tcElevationData_h_
23 /**
24 * @file tcElevationData.h
25 * @brief A block of pixel data representing elevation.
28 #include "tcPixelData.h"
29 #include "tcAffineTransform.h"
31 class tcGeo;
33 /// A block of pixel data representing elevation.
34 class tcElevationData : public tcPixelData<float>
36 private:
39 * Types
42 // Parent type.
43 typedef tcPixelData<float> Parent;
45 public:
48 * Constructors + destructor
51 /// Default constructor.
52 tcElevationData();
54 /// Primary constructor.
55 tcElevationData(int width, int height);
57 /// Destructor.
58 virtual ~tcElevationData();
61 * Elevation interface
64 /// Sample elevation at a coordinate.
65 float elevationAt(const tcGeo& coord) const;
67 /// Get the max elevation over a range of pixels.
68 float maxElevation(const tcGeo& swCorner, const tcGeo& neCorner, bool* inRange) const;
70 /** Get the mean elevation over a range of pixels.
71 * This is so elevation models can update their elevations from an elevation field.
73 float meanElevation(const tcGeo& swCorner, const tcGeo& neCorner, bool* inRange) const;
75 /// Set the geographical to pixels transformation.
76 void setGeoToPixels(const tcAffineTransform2<double>& geoToPixels);
79 * Accessors
82 /// Get the coordinate of the most south westerly corner.
83 tcGeo swCorner() const;
85 /// Get the coordinate of the most north easterly corner.
86 tcGeo neCorner() const;
88 private:
91 * Variables
94 /// Transformation from geographical to pixels.
95 tcAffineTransform2<double> m_geoToPixels;
98 #endif