geo/tcSrtmData.h

   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  ***************************************************************************/
  19
  20 #ifndef _tcSrtmData_h_
  21 #define _tcSrtmData_h_
  22
  23 /**
  24  * @file tcSrtmData.h
  25  * @brief Block of raw SRTM elevation data.
  26  */
  27
  28 #include "tcGeo.h"
  29
  30 #include <inttypes.h>
  31
  32 class QFile;
  33
  34 /// Block of raw SRTM elevation data.
  35 class tcSrtmData
  36 {
  37   public:
  38
  39     /*
  40      * Constructors + destructor
  41      */
  42
  43     /** Load SRTM data.
  44      * @param lon Longitude in degrees.
  45      * @param lat Latitude in degrees.
  46      * @param file File to read data from.
  47      */
  48     tcSrtmData(int lon, int lat, QFile& file);
  49
  50     /// Destructor.
  51     virtual ~tcSrtmData();
  52
  53     /*
  54      * Accessors
  55      */
  56
  57     /// Get the longitude in degrees.
  58     int lon() const;
  59
  60     /// Get the latitude in degrees.
  61     int lat() const;
  62
  63     /// Get the number of scan lines.
  64     int lines() const;
  65
  66     /// Get the number of samples in each scan line.
  67     int samples() const;
  68
  69     /// Find the geographical angles between samples.
  70     tcGeo sampleResolution() const;
  71
  72     /// Get the geographical coordinate of a sample.
  73     tcGeo sampleCoordinate(int line, int sample) const;
  74
  75     /// Does data exist for a sample?
  76     bool sampleExists(int line, int sample) const;
  77
  78     /// Get the altitude at a sample (interpolating gaps).
  79     uint16_t sampleAltitude(int line, int sample, bool corrected = false, bool* exists = 0) const;
  80
  81     /// Get the altitude at a coordinate.
  82     uint16_t sampleAltitude(const tcGeo& coord, bool corrected = false, bool* exists = 0) const;
  83
  84     /*
  85      * Mutators
  86      */
  87
  88     /// Correct the altitude at a sample.
  89     void setSampleAltitude(int line, int sample, uint16_t altitude);
  90
  91   private:
  92
  93     /*
  94      * Private functions
  95      */
  96
  97     /// Index into the data array.
  98     unsigned int indexData(int corrected, int line, int sample) const;
  99
 100   private:
 101
 102     /*
 103      * Variables
 104      */
 105
 106     /// Longitude in degrees.
 107     int m_lat;
 108
 109     /// Latitude in degrees.
 110     int m_lon;
 111
 112     /// Number of scan lines.
 113     int m_lines;
 114
 115     /// Number of samples per scan line.
 116     int m_samples;
 117
 118     /** Fixed resolution elevation data.
 119      * Indexed by correction, scanline, sample.
 120      * Most significant bit means that original data is missing.
 121      */
 122     uint16_t* m_data;
 123 };
 124
 125 #endif
 126