DetectorOp.h

/*
 
MIT License
 
Copyright (c) 2017 FMI Open Development / Markus Peura, first.last@fmi.fi
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
/*
Part of Rack development has been done in the BALTRAD projects part-financed
by the European Union (European Regional Development Fund and European
Neighbourhood Partnership Instrument, Baltic Sea Region Programme 2007-2013)
*/
 
#ifndef ANDRE_DETECTOR2_H_
#define ANDRE_DETECTOR2_H_
 
 
#include <main/palette-manager.h>
#include "AndreOp.h"
 
 
namespace rack {
 
using namespace drain::image;
 
 
 
class DetectorOp : public AndreOp {
 
public:
 
    /*
    DetectorOp(const std::string & name = __FUNCTION__, const std::string &description = "", unsigned short code = 0) : AndreOp(name,description), classCode(code ? code : 128+(++_count)) {
        // dataSelector.path = ". * /da ta[0-9]+/?$";
        // dataSelector.quantity = "DBZ.*";
        dataSelector.setQuantity("^DBZH$");
        // cumulateDetections = MAX;
        REQUIRE_STANDARD_DATA = true;
        UNIVERSAL = false;
    }
    */
 
    DetectorOp(const std::string & name = __FUNCTION__, const std::string & description = "", const std::string & echoClass = "") :
            AndreOp(name,description), classEntry(PaletteManager::getPalette("CLASS").getEntryByCode(echoClass)) {
            // classCode(PaletteManager::getPalette("CLASS").getValueByCode(echoClass)) {
            // classCode(getClassCode(echoClass)) {
 
        // dataSelector.path = ". * /da ta[0-9]+/?$";
        //dataSelector.quantity = "DBZ.*";
        //dataSelector.setQuantityRegExp("^DBZH$");
        dataSelector.setQuantities("DBZH:DBZ");
        //cumulateDetections = MAX;
        REQUIRE_STANDARD_DATA = true;
        UNIVERSAL = false;
 
        //PaletteManager::getPalette("CLASS").getEntryByCode(code, lenient);
        // std::cout << __FUNCTION__ << ':' << name << ':' << echoClass << '\n';
    }
 
    // inline
    // DetectorOp(const DetectorOp & op) : AndreOp(op), classCode(op.classCode), REQUIRE_STANDARD_DATA(op.REQUIRE_STANDARD_DATA), UNIVERSAL(op.UNIVERSAL) {}
    inline
//  DetectorOp(const DetectorOp & op) : AndreOp(op), classCode(op.classCode), UNIVERSAL(op.UNIVERSAL), REQUIRE_STANDARD_DATA(op.REQUIRE_STANDARD_DATA) {};
    DetectorOp(const DetectorOp & op) : AndreOp(op), classEntry(op.classEntry), UNIVERSAL(op.UNIVERSAL), REQUIRE_STANDARD_DATA(op.REQUIRE_STANDARD_DATA) {};
 
    virtual
    ~DetectorOp(){};
 
 
    virtual
    const std::string & getOutputQuantity(const std::string & inputQuantity = "") const;
 
    static bool SUPPORT_UNIVERSAL;
 
    //const unsigned short int classCode;
 
    const drain::image::Palette::value_type & classEntry;
 
 
    // NEW
    //virtual
    //void processProduct(DataSetList<PolarDst> & srcVolume, DataSetList<PolarDst> & dstVolume) const;
 
 
    virtual inline
    void computeProducts(const DataSetMap<PolarSrc> & srcVolume, DataSetMap<PolarDst> & dstVolume) const {
        drain::Logger mout(__FILE__, __FUNCTION__);
        mout.unimplemented<LOG_INFO>("TODO... redirecting...");
        runDetection(srcVolume, dstVolume);
    }
 
 
    // NEW
    virtual
    void runDetection(const DataSetMap<PolarSrc> & srcVolume, DataSetMap<PolarDst> & dstVolume) const;
 
    //virtual
    //void processDataSets(const DataSetMap<PolarSrc> & srcVolume, DataSetMap<PolarDst> & dstVolume) const;
 
 
    virtual
    void runDetection(const DataSet<PolarSrc> & srcDataSet, PlainData<PolarDst> & dstProb, DataSet<PolarDst> & aux)  const;
 
 
    //virtual
    //void processDataSet(const DataSet<PolarSrc> & srcDataSet, PlainData<PolarDst> & dstProb, DataSet<PolarDst> & aux)  const;
 
 
    virtual inline
    void runDetector(const PlainData<PolarSrc> & srcData, PlainData<PolarDst> & dstProb) const {
        drain::Logger mout(__FILE__, __FUNCTION__);
        mout.unimplemented("function ", __FUNCTION__," not implemented for ", getName());
        mout.error("stopping");
    }
    /*
     {
        drain::Logger mout(__FILE__, __FUNCTION__);
        mout.unimplemented("function ", __FUNCTION__," not implemented for ", getName());
    }*
     */
 
    virtual
    void processData(const Data<src_t > & srcData, Data<dst_t > & dstData) const {
        drain::Logger mout(__FILE__, __FUNCTION__);
        mout.special(__FUNCTION__, " now, here!");
        //runDetector((const PlainData<PolarSrc> &) srcData, (PlainData<PolarDst> &)dstData);
        // Default implementation is simple, creates no (2nd order) quality field of the detection
        runDetector(srcData, dstData);
    };
 
    bool UNIVERSAL = false;
 
protected:
 
    virtual
    void initDataDst(const PlainData<PolarSrc> & srcData, PlainData<PolarDst> & dstData, const std::string & quantity = "") const;
 
    // This is difficult...
    //const Hi5Tree & getNormalizedData(const DataSet<> & srcDataSet, DataSet<> & dstDataSet, const std::string & quantity) const;
 
    // Consider raise to VolumeOp ?
    void storeDebugData(int debugLevel, const ImageFrame & srcImage, const std::string & label) const;
 
    // Consider raise
    void storeDebugData(const ImageFrame & srcImage, PlainData<PolarDst> & dstData, const std::string & quantityLabel) const;
 
 
    virtual
    void writeHow(PlainData<PolarDst> & dstData) const;
 
    // Detector classCode. Obsolete...
    static
    unsigned short int _count;
 
    mutable std::string upperCaseName;
 
 
    bool REQUIRE_STANDARD_DATA = false;
 
 
 
    void _enhanceDirectionally(Image & data, float medianPos, int windowWidth) const;
 
    void _infect(Image & data, int windowWidth, int windowHeight, double enhancement) const;
 
 
};
 
 
}  // rack::
 
#endif /* ANDRE_OP_H_ */