LayoutPlugin.h

Go to the documentation of this file.

/*******************************************************************************************************
ReadModules are plugins for nomacs 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 ReadModules.

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 "DkPluginInterface.h"
#include "LineTrace.h"
#include "SuperPixelTrainer.h"
#include "SuperPixelClassification.h"

// opencv defines
namespace cv {
    class Mat;
}

namespace rdf {
    class LineTrace;
    class PageXmlParser;
}

namespace rdm {


class LayoutInfo : public nmc::DkBatchInfo {

public:
    LayoutInfo(const QString& id = QString(), const QString& filePath = QString());

    void setFeatureCollectionManager(const rdf::FeatureCollectionManager& manager);
    rdf::FeatureCollectionManager featureCollectionManager() const;

private:
    rdf::FeatureCollectionManager mManager;
};


class LayoutPlugin : public QObject, nmc::DkBatchPluginInterface {
    Q_OBJECT
        Q_INTERFACES(nmc::DkBatchPluginInterface)
        Q_PLUGIN_METADATA(IID "com.nomacs.ImageLounge.LayoutPlugin/3.0" FILE "LayoutPlugin.json")

public:
    LayoutPlugin(QObject* parent = 0);
    ~LayoutPlugin();

    QString id() const override;
    QImage image() const override;

    QList<QAction*> createActions(QWidget* parent) override;
    QList<QAction*> pluginActions() const override;
    QSharedPointer<nmc::DkImageContainer> runPlugin(
        const QString &runID, 
        QSharedPointer<nmc::DkImageContainer> imgC, 
        const nmc::DkSaveInfo& saveInfo,
        QSharedPointer<nmc::DkBatchInfo>& batchInfo) const override;

    virtual void preLoadPlugin() const override {};
    virtual void postLoadPlugin(const QVector<QSharedPointer<nmc::DkBatchInfo> > &) const override;

    enum {
        id_layout_draw,
        id_layout_xml,
        id_text_block,
        id_text_block_xml,
        id_lines,
        id_line_img,
        id_layout_collect_features,
        id_layout_train,
        // add actions here

        id_end
    };

protected:
    QList<QAction*> mActions;
    QStringList mRunIDs;
    QStringList mMenuNames;
    QStringList mMenuStatusTips;

    rdf::LineTraceConfig mLTRConfig;
    rdf::SuperPixelLabelerConfig mSplConfig;
    rdf::SuperPixelClassifierConfig mSpcConfig;

    void init();

    // layout plugin functions
    cv::Mat compute(const cv::Mat& src, const rdf::PageXmlParser& parser) const;
    cv::Mat computePageSegmentation(const cv::Mat& src, const rdf::PageXmlParser& parser) const;
    void collectFeatures(const cv::Mat& src, const rdf::PageXmlParser& parser, QSharedPointer<LayoutInfo>& layoutInfo) const;
    rdf::LineTrace computeLines(QSharedPointer<nmc::DkImageContainer> imgC) const;
};
};