geo/tcChannel.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 _tcChannel_h_
  21 #define _tcChannel_h_
  22
  23 /**
  24  * @file tcChannel.h
  25  * @brief A single abstract image channel.
  26  */
  27
  28 #include "tcPixelData.h"
  29 #include "tcGeo.h"
  30
  31 #include <QObject>
  32 #include <QString>
  33 #include <QList>
  34
  35 #include <GL/gl.h>
  36
  37 class tcChannelConfigWidget;
  38 class tcChannelManager;
  39
  40 /// A single abstract image channel.
  41 class tcChannel : public QObject
  42 {
  43     Q_OBJECT
  44
  45   public:
  46
  47     /*
  48      * Constructors + destructor
  49      */
  50
  51     /// Primary constructor.
  52     tcChannel(const QString& name, const QString& description);
  53
  54     /// Destructor.
  55     virtual ~tcChannel();
  56
  57     /*
  58      * Metadata
  59      */
  60
  61     /// Get the channel manager.
  62     tcChannelManager* channelManager() const;
  63
  64     /// Set the channel manager.
  65     void setChannelManager(tcChannelManager* channelManager);
  66
  67     /// Get the channel name.
  68     const QString& name() const;
  69
  70     /// Get the channel description;
  71     const QString& description() const;
  72
  73     /// Set the channel name.
  74     void setName(const QString& name);
  75
  76     /// Set the channel description.
  77     void setDescription(const QString& description);
  78
  79     /// Set radiance offset and gain.
  80     void setRadianceTransform(float offset, float gain);
  81
  82     /// New cross section selected.
  83     void newCrossSection(const tcGeo& p1, const tcGeo& p2);
  84
  85     /*
  86      * Dependencies
  87      */
  88
  89     /// Add derivitive of this channel.
  90     void addDerivitive(tcChannel* derivitive);
  91
  92     /// Remove a derivitive of this channel.
  93     void removeDerivitive(tcChannel* derivitive);
  94
  95     /*
  96      * Main image interface
  97      */
  98
  99     /// Get configuration widget.
 100     virtual tcChannelConfigWidget* configWidget();
 101
 102     /// Get GL texture ID of thumbnail of the channel.
 103     virtual GLuint thumbnailTexture();
 104
 105     /// Get a reference to the pixel data of the current portion of the image.
 106     Reference<tcAbstractPixelData> portion() const;
 107
 108     /// Get a reference to the pixel data of a portion of the image.
 109     Reference<tcAbstractPixelData> portion(double* x1, double* y1, double* x2, double* y2);
 110
 111     /// Get a reference to the pixel data of a portion of the image.
 112     Reference<tcAbstractPixelData> portion(double x1, double y1, double x2, double y2);
 113
 114     /// Get GL texture ID of portion of the channel.
 115     GLuint portionTexture(double* x1, double* y1, double* x2, double* y2);
 116
 117     /// Radiance scaling.
 118     float valueToRadiance(float value)
 119     {
 120       return m_radianceOffset + value*m_radianceGain;
 121     }
 122
 123     /// Get the last portion position.
 124     const double* portionPosition() const;
 125
 126   //protected:
 127
 128     /*
 129      * Interface for derived class to implement
 130      */
 131
 132     /// Round coordinates to sensible values.
 133     virtual void roundPortion(double* x1, double* y1, double* x2, double* y2) = 0;
 134
 135     /// Load a portion of pixel data from the channel source, wherever that may be.
 136     virtual tcAbstractPixelData* loadPortion(double x1, double y1, double x2, double y2, bool changed) = 0;
 137
 138   public slots:
 139
 140     /*
 141      * Interface for derived classes
 142      */
 143
 144     /** Invalidate this channel.
 145      * For example if one of the inputs has changed.
 146      */
 147     void invalidate();
 148
 149   signals:
 150
 151     /*
 152      * Signals
 153      */
 154
 155     /// Emitted to indicate progress of processing.
 156     void progressing(const QString& message);
 157
 158   protected:
 159
 160     /*
 161      * Progress functions
 162      */
 163
 164     /// Start a processing step.
 165     void startProcessing(const QString& step);
 166
 167     /// Update progress.
 168     void progress(float progress);
 169
 170     /// Update progress.
 171     void progress(const QString& info);
 172
 173     /// End processing step.
 174     void endProcessing();
 175
 176   private:
 177
 178     /*
 179      * Variables
 180      */
 181
 182     /// Channel manager.
 183     tcChannelManager* m_channelManager;
 184
 185     /// Name of the channel.
 186     QString m_name;
 187
 188     /// Description of the channel.
 189     QString m_description;
 190
 191     /// List of channels which are derived from this channel.
 192     QList<tcChannel*> m_derivitives;
 193
 194     /// Pixel data of a portion of the channel.
 195     Reference<tcAbstractPixelData> m_portion;
 196
 197     /// Portion coordinates.
 198     double m_portionPosition[2][2];
 199
 200     /// Radiance scaling information.
 201     float m_radianceOffset, m_radianceGain;
 202
 203   protected:
 204
 205     /// Whether cross sectioned.
 206     bool m_crossSectioned;
 207
 208     /// Current cross section.
 209     tcGeo m_crossSection[2];
 210
 211   private:
 212
 213     /*
 214      * Static variables
 215      */
 216
 217     /// Current processing step.
 218     static QString s_processingStep;
 219
 220     /// Last progress percent.
 221     static int s_processingLastPercent;
 222 };
 223
 224 #endif