geo/tcChannel.cpp

   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 /**
  21  * @file tcChannel.cpp
  22  * @brief A single abstract image channel.
  23  */
  24
  25 #include "tcChannel.h"
  26
  27 /*
  28  * Static variables
  29  */
  30
  31 /// Current processing step.
  32 QString tcChannel::s_processingStep;
  33
  34 /// Last progress percent.
  35 int tcChannel::s_processingLastPercent;
  36
  37 /*
  38  * Constructors + destructor
  39  */
  40
  41 /// Primary constructor.
  42 tcChannel::tcChannel(const QString& name, const QString& description)
  43 : m_channelManager(0)
  44 , m_name(name)
  45 , m_description(description)
  46 , m_radianceOffset(0.0f)
  47 , m_radianceGain(1.0f)
  48 , m_crossSectioned(false)
  49 {
  50 }
  51
  52 /// Destructor.
  53 tcChannel::~tcChannel()
  54 {
  55 }
  56
  57 /*
  58  * Metadata
  59  */
  60
  61 /// Get the channel manager.
  62 tcChannelManager* tcChannel::channelManager() const
  63 {
  64   return m_channelManager;
  65 }
  66
  67 /// Set the channel manager.
  68 void tcChannel::setChannelManager(tcChannelManager* channelManager)
  69 {
  70   m_channelManager = channelManager;
  71 }
  72
  73 /// Get the channel name.
  74 const QString& tcChannel::name() const
  75 {
  76   return m_name;
  77 }
  78
  79 /// Get the channel description;
  80 const QString& tcChannel::description() const
  81 {
  82   return m_description;
  83 }
  84
  85 /// Set the channel name.
  86 void tcChannel::setName(const QString& name)
  87 {
  88   m_name = name;
  89 }
  90
  91 /// Set the channel description.
  92 void tcChannel::setDescription(const QString& description)
  93 {
  94   m_description = description;
  95 }
  96
  97 /// Set radiance offset and gain.
  98 void tcChannel::setRadianceTransform(float offset, float gain)
  99 {
 100   m_radianceOffset = offset;
 101   m_radianceGain = gain;
 102 }
 103
 104 /// New cross section selected.
 105 void tcChannel::newCrossSection(const tcGeo& p1, const tcGeo& p2)
 106 {
 107   m_crossSectioned = true;
 108   m_crossSection[0] = p1;
 109   m_crossSection[1] = p2;
 110 }
 111
 112 /*
 113  * Dependencies
 114  */
 115
 116 /// Add derivitive of this channel.
 117 void tcChannel::addDerivitive(tcChannel* derivitive)
 118 {
 119   m_derivitives += derivitive;
 120 }
 121
 122 /// Remove a derivitive of this channel.
 123 void tcChannel::removeDerivitive(tcChannel* derivitive)
 124 {
 125   m_derivitives.removeOne(derivitive);
 126 }
 127
 128 /*
 129  * Main image interface
 130  */
 131
 132 /// Get configuration widget.
 133 tcChannelConfigWidget* tcChannel::configWidget()
 134 {
 135   return 0;
 136 }
 137
 138 /// Get GL texture ID of thumbnail of the channel.
 139 GLuint tcChannel::thumbnailTexture()
 140 {
 141   return 0;
 142 }
 143
 144 /// Get a reference to the pixel data of the current portion of the image.
 145 Reference<tcAbstractPixelData> tcChannel::portion() const
 146 {
 147   return m_portion;
 148 }
 149
 150 /// Get a reference to the pixel data of a portion of the image.
 151 Reference<tcAbstractPixelData> tcChannel::portion(double* x1, double* y1, double* x2, double* y2)
 152 {
 153   // If the portion is out of date, remove it
 154   roundPortion(x1,y1,x2,y2);
 155   bool changed = false;
 156   if (0 != m_portion)
 157   {
 158     if (m_portionPosition[0][0] != *x1 ||
 159         m_portionPosition[0][1] != *y1 ||
 160         m_portionPosition[1][0] != *x2 ||
 161         m_portionPosition[1][1] != *y2)
 162     {
 163       m_portion = 0;
 164       changed = true;
 165     }
 166   }
 167   m_portionPosition[0][0] = *x1;
 168   m_portionPosition[0][1] = *y1;
 169   m_portionPosition[1][0] = *x2;
 170   m_portionPosition[1][1] = *y2;
 171   // Create the new portion
 172   if (0 == m_portion)
 173   {
 174     m_portion = loadPortion(*x1,*y1,*x2,*y2, changed);
 175   }
 176   return m_portion;
 177 }
 178
 179 /// Get a reference to the pixel data of a portion of the image.
 180 Reference<tcAbstractPixelData> tcChannel::portion(double x1, double y1, double x2, double y2)
 181 {
 182   return portion(&x1, &y1, &x2, &y2);
 183 }
 184
 185 /// Get GL texture ID of portion of the channel.
 186 GLuint tcChannel::portionTexture(double* x1, double* y1, double* x2, double* y2)
 187 {
 188   Reference<tcAbstractPixelData> data = portion(x1,y1,x2,y2);
 189   if (0 != data)
 190   {
 191     return data->texture();
 192   }
 193   else
 194   {
 195     return 0;
 196   }
 197 }
 198
 199 /// Get the last portion position.
 200 const double* tcChannel::portionPosition() const
 201 {
 202   return &m_portionPosition[0][0];
 203 }
 204
 205 /*
 206  * Interface for derived classes
 207  */
 208
 209 /// Invalidate this channel.
 210 void tcChannel::invalidate()
 211 {
 212   m_portion = 0;
 213   foreach (tcChannel* derivitive, m_derivitives)
 214   {
 215     derivitive->invalidate();
 216   }
 217 }
 218
 219 /*
 220  * Progress functions
 221  */
 222
 223 /// Start a processing step.
 224 void tcChannel::startProcessing(const QString& step)
 225 {
 226   if (step.isEmpty())
 227   {
 228     s_processingStep = step;
 229   }
 230   else
 231   {
 232     s_processingStep = step + ": ";
 233   }
 234   s_processingLastPercent = -1;
 235   emit progressing(tr("%1: %2").arg(name()).arg(s_processingStep));
 236 }
 237
 238 /// Update progress.
 239 void tcChannel::progress(float progress)
 240 {
 241   int percent = progress*100.0f;
 242   if (percent != s_processingLastPercent)
 243   {
 244     s_processingLastPercent = percent;
 245     emit progressing(tr("%1: %2%3%").arg(name()).arg(s_processingStep).arg(percent));
 246   }
 247 }
 248
 249 /// Update progress.
 250 void tcChannel::progress(const QString& info)
 251 {
 252   emit progressing(tr("%1: %2%3").arg(name()).arg(s_processingStep).arg(info));
 253 }
 254
 255 /// End processing step.
 256 void tcChannel::endProcessing()
 257 {
 258   emit progressing(tr("%1: %2Complete").arg(name()).arg(s_processingStep));
 259 }