geo/tcIlluminantDirection.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 _tcIlluminantDirection_h_
  21 #define _tcIlluminantDirection_h_
  22
  23 /**
  24  * @file tcIlluminantDirection.h
  25  * @brief Illuminant direction based calculation.
  26  */
  27
  28 #include "tcChannelGroup.h"
  29 #include "tcPixelData.h"
  30 #include <VarVector.h>
  31
  32 #include <QList>
  33
  34 class tcChannel;
  35
  36 /// Illuminant direction based calculation.
  37 class tcIlluminantDirection : public tcChannelGroup
  38 {
  39     Q_OBJECT
  40
  41   public:
  42
  43     /*
  44      * Constructors + destructor
  45      */
  46
  47     /// Primary constructor.
  48     tcIlluminantDirection(const QList<tcChannel*>& chromaticities,
  49                           int outputs, const QString& name, const QString& description);
  50
  51     /// Destructor.
  52     virtual ~tcIlluminantDirection();
  53
  54     /*
  55      * Accessors
  56      */
  57
  58     /// Get the number of chromaticity channels.
  59     int numChromaticities() const;
  60
  61     /// Get the list of chromaticitiy channels.
  62     const QList<tcChannel*>& chromaticities() const;
  63
  64     /// Get the illuminant direction.
  65     const maths::VarVector<float>& illuminantDirection() const;
  66
  67     /*
  68      * Main image interface
  69      */
  70
  71     // Reimplemented
  72     virtual tcChannelConfigWidget* configWidget();
  73
  74   private slots:
  75
  76     /*
  77      * Private slots
  78      */
  79
  80     /// Reset the illuminant direction vector.
  81     void resetIlluminantDirection();
  82
  83     /// Start choosing a shadow / non shadow pair.
  84     void startShadowNonShadow();
  85
  86     /// New shadow point.
  87     void selectShadowPoint(const maths::Vector<2,float>& point);
  88
  89     /// New non-shadow point.
  90     void selectNonShadowPoint(const maths::Vector<2,float>& point);
  91
  92   protected:
  93
  94     /*
  95      * Interface for derived class to implement
  96      */
  97
  98     // Reimplemented
  99     virtual void roundPortion(double* x1, double* y1, double* x2, double* y2);
 100
 101     // Reimplemented
 102     virtual void loadPortions(double x1, double y1, double x2, double y2, bool changed);
 103
 104     /// Load portions using nicely accessed chromaticity data.
 105     virtual void loadPortions(const QList< Reference< tcPixelData<float> > >& chromaticities, int width, int height) = 0;
 106
 107   private:
 108
 109     /*
 110      * Variables
 111      */
 112
 113     /// Input chromaticities.
 114     QList<tcChannel*> m_chromaticities;
 115
 116     /// Current log chromaticity illuminant direction.
 117     maths::VarVector<float> m_illuminantDirection;
 118
 119     /// Number of samples used to approximate illuminant direction.
 120     int m_illuminantDirectionSamples;
 121
 122     /// Configuration widget.
 123     tcChannelConfigWidget* m_configWidget;
 124
 125     /// Current shadow point.
 126     maths::Vector<2,float> m_shadowPoint;
 127 };
 128
 129 #endif