LayoutAnalysis.h

Go to the documentation of this file.

/*******************************************************************************************************
 ReadFramework is the basis for modules developed at CVL/TU Wien for the EU project READ. 
  
 Copyright (C) 2016 Markus Diem <diem@caa.tuwien.ac.at>
 Copyright (C) 2016 Stefan Fiel <fiel@caa.tuwien.ac.at>
 Copyright (C) 2016 Florian Kleber <kleber@caa.tuwien.ac.at>

 This file is part of ReadFramework.

 ReadFramework is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 ReadFramework is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.

 The READ project  has  received  funding  from  the European  Union’s  Horizon  2020  
 research  and innovation programme under grant agreement No 674943
 
 related links:
 [1] http://www.caa.tuwien.ac.at/cvl/
 [2] https://transkribus.eu/Transkribus/
 [3] https://github.com/TUWien/
 [4] http://nomacs.org
 *******************************************************************************************************/

#pragma once

#include "BaseModule.h"
#include "PixelSet.h"
#include "Image.h"
#include "ScaleFactory.h"

#pragma warning(push, 0)    // no warnings from includes
// Qt Includes
#pragma warning(pop)

#ifndef DllCoreExport
#ifdef DLL_CORE_EXPORT
#define DllCoreExport Q_DECL_EXPORT
#else
#define DllCoreExport Q_DECL_IMPORT
#endif
#endif

// Qt defines

namespace rdf {

// read defines
class Region;
class RootRegion;
class SeparatorRegion;
class Polygon;
class TextLine;

class DllCoreExport LayoutAnalysisConfig : public ModuleConfig {

public:
    LayoutAnalysisConfig();

    virtual QString toString() const override;

    void setRemoveWeakTextLines(bool remove);
    bool removeWeakTextLines() const;

    void setMinSuperPixelsPerBlock(int minPx);
    int minSuperixelsPerBlock() const;

    void setLocalBlockOrientation(bool lor);
    bool localBlockOrientation() const;

    void setComputeSeparators(bool cs);
    bool computeSeparators() const;

    void setClassiferPath(const QString& cp);
    QString classifierPath() const;

protected:

    void load(const QSettings& settings) override;
    void save(QSettings& settings) const override;

    bool mRemoveWeakTextLines = true;       // if true, unstable text lines are removed
    int mMinSuperPixelsPerBlock = 15;       // the minimum number of components that are required to run the text line segmentation
    bool mLocalBlockOrientation = false;    // local orientation is estimated per text block
    bool mComputeSeparators = true;         // if true, separators lines are computed
    QString mClassifierPath = "";
};

class DllCoreExport LayoutAnalysis : public Module {

public:
    LayoutAnalysis(const cv::Mat& img);

    bool isEmpty() const override;
    bool compute() override;
    QSharedPointer<LayoutAnalysisConfig> config() const;

    cv::Mat draw(const cv::Mat& img, const QColor& col = QColor()) const;
    QString toString() const override;

    void setRootRegion(const QSharedPointer<RootRegion>& region);

    TextBlockSet textBlockSet() const;
    QVector<SeparatorRegion> stopLines() const;
    PixelSet pixels() const;
    
    QSharedPointer<ScaleFactory> scaleFactory() const;

private:
    bool checkInput() const override;

    // input
    cv::Mat mImg;
    QSharedPointer<RootRegion> mRoot;

    // output
    TextBlockSet mTextBlockSet;
    QVector<Line> mStopLines;
    QSharedPointer<ScaleFactory> mScaleFactory;

    TextBlockSet createTextBlocks() const;
    QVector<Line> createStopLines() const;
    bool computeLocalStats(PixelSet& pixels) const;
};


}