tcElevationOptimization: fix typo s/write/read/
[tecorrec.git] / geo / tcSrtmData.h
blob3732450c81aa3928a40c6bc1934c1a600d6fcecb
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 _tcSrtmData_h_
21 #define _tcSrtmData_h_
23 /**
24 * @file tcSrtmData.h
25 * @brief Block of raw SRTM elevation data.
28 #include "tcGeo.h"
30 #include <QObject>
32 #include <inttypes.h>
34 class tcElevationData;
36 class QFile;
37 class QString;
39 /// Block of raw SRTM elevation data.
40 class tcSrtmData : public QObject
42 Q_OBJECT
44 public:
47 * Constructors + destructor
50 /** Load SRTM data.
51 * @param lon Longitude in degrees.
52 * @param lat Latitude in degrees.
53 * @param file File to read data from.
55 tcSrtmData(int lon, int lat, QFile& file, QObject* progressObj, const char* progressMember);
57 /// Destructor.
58 virtual ~tcSrtmData();
61 * Accessors
64 /// Get the longitude in degrees.
65 int lon() const;
67 /// Get the latitude in degrees.
68 int lat() const;
70 /// Get the number of scan lines.
71 int lines() const;
73 /// Get the number of samples in each scan line.
74 int samples() const;
76 /// Find the geographical angles between samples.
77 tcGeo sampleResolution() const;
79 /// Get the geographical coordinate of a sample.
80 tcGeo sampleCoordinate(int line, int sample) const;
82 /// Does data exist for a sample?
83 bool sampleExists(int line, int sample) const;
85 /// Get the altitude at a sample (interpolating gaps).
86 uint16_t sampleAltitude(int line, int sample, bool corrected = false, bool* exists = 0) const;
88 /// Get the altitude at a coordinate.
89 float sampleAltitude(const tcGeo& coord, bool corrected = false, bool* exists = 0) const;
92 * Mutators
95 /// Correct the altitude at a sample.
96 void setSampleAltitude(int line, int sample, uint16_t altitude);
98 /// Update any samples affected by the elevation field.
99 void updateFromElevationData(const tcElevationData* elevation);
101 /// Fill voids using bilinear interpolation.
102 void fillVoidsBilinear();
104 /// Fill voids using bicubic interpolation.
105 void fillVoidsBicubic();
107 signals:
110 * Signals
113 /// Process notifier.
114 void progressing(const QString& message);
116 private:
119 * Private functions
122 /// Index into the data array.
123 unsigned int indexData(int corrected, int line, int sample) const;
125 private:
128 * Variables
131 /// Longitude in degrees.
132 int m_lat;
134 /// Latitude in degrees.
135 int m_lon;
137 /// Number of scan lines.
138 int m_lines;
140 /// Number of samples per scan line.
141 int m_samples;
143 /** Fixed resolution elevation data.
144 * Indexed by correction, scanline, sample.
145 * Most significant bit means that original data is missing.
147 uint16_t* m_data;
150 #endif