Binarization.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"

#pragma warning(push, 0)    // no warnings from includes
#include <QObject>

#include <opencv2/core.hpp>
#pragma warning(pop)


#pragma warning (disable: 4251) // inlined Qt functions in dll interface

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

// Qt defines

namespace rdf {

class DllCoreExport SimpleBinarizationConfig : public ModuleConfig {

public:
    SimpleBinarizationConfig();

    int thresh();
    
    virtual QString toString() const override;

protected:
    // parameters
    int mThresh = 100;

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

// read defines
class DllCoreExport SimpleBinarization : public Module {

public:
    SimpleBinarization(const cv::Mat& img);
    
    bool isEmpty() const override;
    bool compute() override;
    cv::Mat binaryImage() const;
    QString toString() const override;
    
    QSharedPointer<SimpleBinarizationConfig> config() const;

private:
    cv::Mat mSrcImg;
    cv::Mat mBwImg;
    
    bool checkInput() const override;

};

class DllCoreExport BaseBinarizationSuConfig : public ModuleConfig {

public:
    BaseBinarizationSuConfig();

    int erodedMaskSize() const;
    void setErodedMaskSize(int s);

    QString toString() const override;

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

    int mErodeMaskSize = 3 * 6;                         //size for the boundary erosion
};

class DllCoreExport BaseBinarizationSu : public Module {

public:
    BaseBinarizationSu(const cv::Mat& img, const cv::Mat& mask = cv::Mat());

    bool isEmpty() const override;
    virtual bool compute() override;
    cv::Mat binaryImage() const;
    virtual QString toString() const override;
    void setPreFiltering(bool preFilter = true, int preFilterSize = 10);

    QSharedPointer<BaseBinarizationSuConfig> config() const;

protected:
    cv::Mat compContrastImg(const cv::Mat& srcImg, const cv::Mat& mask) const;
    cv::Mat compBinContrastImg(const cv::Mat& contrastImg) const;
    virtual float contrastVal(const unsigned char* maxVal, const unsigned char * minVal) const;
    virtual void calcFilterParams(int &filterS, int &Nm);
    virtual float strokeWidth(const cv::Mat& contrastImg) const;
    virtual float thresholdVal(float *mean, float *std) const;
    void computeDistHist(const cv::Mat& src, QList<int> *maxDiffList, QList<float> *localIntensity) const;
    void computeThrImg(const cv::Mat& grayImg32F, const cv::Mat& binContrast, cv::Mat& thresholdImg, cv::Mat& thresholdContrastPxImg);
    bool checkInput() const override;
    //void compThrImg();
    //void compDisHist();

    cv::Mat mSrcImg;                                    //the input image  either 3 channel or 1 channel [0 255]
    cv::Mat mBwImg;                                     //the binarized image [0 255]
    cv::Mat mMask;                                      //the mask image [0 255]
                                                        //cv::Mat mContrastImg;
                                                        //cv::Mat mBinContrastImg;
                                                        //cv::Mat mThrImg;

    bool mPreFilter = true;
    int mPreFilterSize = 10;
    float mStrokeW = 4;                                 //estimated strokeWidth

};

class DllCoreExport BinarizationSuAdapted : public BaseBinarizationSu {

public:
    BinarizationSuAdapted(const cv::Mat& img, const cv::Mat& mask = cv::Mat());

    virtual bool compute() override;
    virtual QString toString() const override;
    void setFiltering(bool medianFilter);

protected:
    float setStrokeWidth(float strokeW);
    virtual float thresholdVal(float *mean, float *std) const;
    virtual float contrastVal(const unsigned char* maxVal, const unsigned char * minVal) const override;
    virtual void calcFilterParams(int &filterS, int &Nm) override;

    cv::Mat mContrastImg;
    cv::Mat mBinContrastImg;
    cv::Mat mThrImg;
private:
    bool mMedianFilter = true;
};


    class DllCoreExport BinarizationSuFgdWeight : public BinarizationSuAdapted {

public:
    BinarizationSuFgdWeight(const cv::Mat& img, const cv::Mat& mask = cv::Mat());

    virtual bool compute() override;

protected:
    cv::Mat computeFgd() const;
    cv::Mat computeMeanFgdEst(const cv::Mat& grayImg32F, const cv::Mat& mask) const;
    cv::Scalar computeConfidence() const;
    //virtual void init();
    virtual void weightFunction(cv::Mat& grayImg, cv::Mat& thrImg, const cv::Mat& mask);

    int mFgdEstFilterSize = 32;                             //the filter size for the foreground estimation
    float mSigmSlope = 15.0f;
    cv::Mat mFgdEstImg;
    cv::Scalar mMeanContrast = cv::Scalar(-1.0f,-1.0f,-1.0f,-1.0f);
    cv::Scalar mStdContrast = cv::Scalar(-1.0f,-1.0f,-1.0f,-1.0f);
    float mConfidence = -1.0f;

private:
};



}