geo/tcPixelOp.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 _tcPixelOp_h_
  21 #define _tcPixelOp_h_
  22
  23 /**
  24  * @file tcPixelOp.h
  25  * @brief Performs a pixel operation on a set of input channels.
  26  */
  27
  28 #include "tcChannel.h"
  29
  30 #include <QList>
  31
  32 /// Performs a pixel operation on a set of input channels.
  33 class tcPixelOp : public tcChannel
  34 {
  35   public:
  36
  37     /*
  38      * Types
  39      */
  40
  41     /// Operations
  42     enum Op
  43     {
  44       Add,
  45       Subtract,
  46       Diff
  47     };
  48
  49     /*
  50      * Constructors + destructor
  51      */
  52
  53     /// Primary constructor.
  54     tcPixelOp(Op op, const QList<tcChannel*>& inputChannels, float scale = 1.0f);
  55
  56     /// Primary constructor.
  57     tcPixelOp(Op op, const QList<tcChannel*>& inputChannels, bool radiance);
  58
  59     /// Destructor.
  60     virtual ~tcPixelOp();
  61
  62   protected:
  63
  64     /*
  65      * Interface for derived class to implement
  66      */
  67
  68     // Reimplemented
  69     virtual void roundPortion(double* x1, double* y1, double* x2, double* y2);
  70
  71     // Reimplemented
  72     virtual tcAbstractPixelData* loadPortion(double x1, double y1, double x2, double y2, bool changed);
  73
  74   private:
  75
  76     /*
  77      * Variables
  78      */
  79
  80     /// Input channels.
  81     QList<tcChannel*> m_inputChannels;
  82
  83     /// Operation.
  84     Op m_op;
  85
  86     /// Automatically scale to [,1].
  87     bool m_autoScale;
  88
  89     /// Whether to use radiance.
  90     bool m_radiance;
  91
  92     /// Overall scale.
  93     float m_scale;
  94 };
  95
  96 #endif