GridHealerAbstractBase.h

Go to the documentation of this file.

/******************************************************************************************************
 * (C) 2014 markummitchell@github.com. This file is part of Engauge Digitizer, which is released      *
 * under GNU General Public License version 2 (GPLv2) or (at your option) any later version. See file *
 * LICENSE or go to gnu.org/licenses for details. Distribution requires prior written permission.     *
 ******************************************************************************************************/
 
#ifndef GRID_HEALER_ABSTRACT_BASE_H
#define GRID_HEALER_ABSTRACT_BASE_H
 
#include "DocumentModelGridRemoval.h"
#include "GridIndependentToDependent.h"
#include <QImage>
 
class GridLog;
class QImage;
class QTextStream;
 
// Trick to discriminate horizontal and vertical pixels is to use different sizes
const double HALFWIDTH_HORIZONTAL = 0.46;
const double HALFWIDTH_VERTICAL = 0.54;

typedef QList<QPoint> MutualPairHalves;

class GridHealerAbstractBase
{
 public:

  GridHealerAbstractBase(GridLog &gridLog,
                         const DocumentModelGridRemoval &modelGridRemoval);
  virtual ~GridHealerAbstractBase();

  void addMutualPair (int x0,
                      int y0,
                      int x1,
                      int y1);

  static int pixelCountInRegionThreshold (const DocumentModelGridRemoval &modelGridRemoval);

  void healed (QImage &image);
 
 protected:

  virtual void applyMutualPairs (const QImage &image) = 0;

  virtual void doHealingAcrossGaps (QImage &image) = 0;

  void fillTrapezoid (QImage &image,
                      int xBL, int yBL,
                      int xBR, int yBR,
                      int xTR, int yTR,
                      int xTL, int yTL);

  GridLog &gridLog ();

  double maxPointSeparation () const;

  DocumentModelGridRemoval &modelGridRemoval();

  const MutualPairHalves &mutualPairHalvesAbove () const;

  const MutualPairHalves &mutualPairHalvesBelow () const;

  bool pointsAreGood (const QImage &image,
                      int x0,
                      int y0,
                      int x1,
                      int y1) const;

  void saveGapSeparation (double gapSeparation);
 
 private:
  GridHealerAbstractBase();

  bool blackPixelRegionIsBigEnough (const QImage &image,
                                    int x,
                                    int y) const;

  void doHealingOnBelowAndAboveRangePair (QImage &image,
                                          int xBelowStart,
                                          int xBelowEnd,
                                          int xAboveStart,
                                          int xAboveEnd);

  void doHealingOnBelowRange (QImage &image,
                              int xBelowStart,
                              int xBelowEnd,
                              int maxHorSep);
 
  DocumentModelGridRemoval m_modelGridRemoval;
 
  int m_maxPointSeparation; // Pixel distance between two connected points
 
  // Store opposing mutual pair points as each grid line is removed, then after all removals are
  // done (when complex vertical/horizontal interactions have finished) we heal
  // across these mutual pairs
  MutualPairHalves m_mutualPairHalvesBelow;
  MutualPairHalves m_mutualPairHalvesAbove;
 
  GridLog &m_gridLog;
};
 
#endif // GRID_HEALER_ABSTRACT_BASE_H