geo/tcShadowDepth.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 _tcShadowDepth_h_
  21 #define _tcShadowDepth_h_
  22
  23 /**
  24  * @file tcShadowDepth.h
  25  * @brief 2D depth into shadow along light direction.
  26  */
  27
  28 #include "tcChannelDem.h"
  29
  30 /// 2D depth into shadow along light direction.
  31 class tcShadowDepth : public tcChannelDem
  32 {
  33   public:
  34
  35     /*
  36      * Constructors + destructor
  37      */
  38
  39     /// Primary constructor.
  40     tcShadowDepth(tcChannel* lit, tcSrtmModel* dem, tcGeoImageData* imagery, bool exitDepth);
  41
  42     /// Destructor.
  43     virtual ~tcShadowDepth();
  44
  45   protected:
  46
  47     /*
  48      * Interface for derived class to implement
  49      */
  50
  51     // Reimplemented
  52     virtual void roundPortion(double* x1, double* y1, double* x2, double* y2);
  53
  54     // Reimplemented
  55     virtual tcAbstractPixelData* loadPortion(double x1, double y1, double x2, double y2);
  56
  57   private:
  58
  59     /*
  60      * Private functions
  61      */
  62
  63     /// Structure for temporary data during the calculation process.
  64     struct tempData
  65     {
  66       double x1, y1, x2, y2;
  67       int width, height;
  68       Reference<tcAbstractPixelData> lit;
  69       tcPixelData<float>* shadowDepths;
  70     };
  71
  72     /// Calculate the shadow depth of a pixel, recursively as necessary.
  73     float pixelShadowDepth(const tempData* data, int i, int j);
  74
  75     /*
  76      * Variables
  77      */
  78
  79     /// We'll use the same resolution as this reference channel.
  80     tcChannel* m_litChannel;
  81
  82     /// Whether to measure the exit depth.
  83     bool m_exitDepth;
  84 };
  85
  86 #endif