GeoFrame.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 GEOFRAME_H_
#define GEOFRAME_H_
 
#include "drain/StringTools.h"
#include "drain/util/BoundingBox.h"
#include "drain/util/Proj6.h"  // for geographical projection of radar data bins
#include "drain/util/Units.h"
#include "Geometry.h"
 
namespace drain
{
 
namespace image
{
 
class GeoInfo {
 
public:
    // TODO: CartesianODIM compatibility
};
 
 
class GeoFrame  { //  See also
 
public:
 
    GeoFrame();
 
    GeoFrame(unsigned int width, unsigned int height);
 
    virtual inline
    ~GeoFrame(){
    };
 
    void reset();
 
 
    inline
    bool projectionIsSet() const {
        return projGeo2Native.isSet();
    };
 
    inline
    bool geometryIsSet() const {
        return ((frame.width > 0) && (frame.height > 0));
    };
 
 
    inline
    bool bboxIsSet() const {
        return (bBoxD.getArea() > 0.0);
    };
 
 
    inline
    bool isDefined() const {
        return geometryIsSet() && projectionIsSet() && bboxIsSet();
    };
 
    inline
    void setGeometry(const Frame2D<int> & frame){
        setGeometry(frame.width, frame.height);
    }
 
    virtual
    void setGeometry(unsigned int width, unsigned int height);
 
    inline
    const Frame2D<int> & getGeometry() const { return frame; };
 
    inline
    int getFrameWidth() const {return frame.width; };
 
    inline
    int getFrameHeight() const {return  frame.height; };
 
 
 
 
    void setBoundingBox(double lonLL, double latLL, double lonUR, double latUR);
 
    inline
    void setBoundingBox(const drain::Rectangle<double> & bbox){
        setBoundingBox(bbox.lowerLeft.x, bbox.lowerLeft.y, bbox.upperRight.x, bbox.upperRight.y);
    }
 
 
    //inline
    void setBoundingBoxD(double lonLL, double latLL, double lonUR, double latUR);
    // { setBoundingBoxR(DEG2RAD*lonLL, DEG2RAD*latLL, DEG2RAD*lonUR, DEG2RAD*latUR);}
 
    inline
    void setBoundingBoxD(const drain::Rectangle<double> & bboxD){
        setBoundingBoxD(bboxD.lowerLeft.x, bboxD.lowerLeft.y, bboxD.upperRight.x, bboxD.upperRight.y);
    }
 
 
    inline
    void setBoundingBoxR(double lonLL, double latLL, double lonUR, double latUR){
        setBoundingBoxD(RAD2DEG*lonLL, RAD2DEG*latLL, RAD2DEG*lonUR, RAD2DEG*latUR);
    }
 
    inline
    void setBoundingBoxR(const drain::Rectangle<double> & bboxR){
        setBoundingBoxR(bboxR.lowerLeft.x, bboxR.lowerLeft.y, bboxR.upperRight.x, bboxR.upperRight.y);
    }
 
 
    void setBoundingBoxNat(double xLL, double yLL, double xUR, double yUR);
 
    inline
    /*
    void setBoundingBoxNat(const drain::Rectangle<double> & bboxM) {
        setBoundingBoxNat(bboxM.lowerLeft.x, bboxM.lowerLeft.y, bboxM.upperRight.x, bboxM.upperRight.y);
    }*/
    void setBoundingBoxNat(const drain::UniTuple<double,4> & bboxM) {
        setBoundingBoxNat(bboxM[0], bboxM[1], bboxM[2], bboxM[3]);
    }
 
protected:
 
    void updateBoundingBoxR(); //double lonLL, double latLL, double lonUR, double latUR);
 
    // void updateBoundingBoxD(); //double lonLL, double latLL, double lonUR, double latUR);
 
    void updateBoundingBoxNat(); // double lonLL, double latLL, double lonUR, double latUR);
 
 
    void updateScaling();
 
public:
 
 
 
    inline
    const drain::Rectangle<double> & getBoundingBoxDeg() const { return bBoxD; };
 
    inline
    const drain::Rectangle<double> & getBoundingBoxNat() const { return bBoxNative; };
 
    inline
    const drain::Rectangle<double> & getBoundingBoxRad() const { return bBoxR; };
 
    void getCenterPixel(drain::Rectangle<double> & pixelD) const;
 
    inline
    double getXScale() const {
        return xScale;
    }
 
    inline
    double getYScale() const {
        return yScale;
    }
 
 
 
    /*
     *  \par bboxM - bounding box (xLowerLeft, yLowerLeft, xUpperRight, yUpperRight).
     */
    inline
    void cropWithM(drain::Rectangle<double> & bboxM) {
        cropWithM(bboxM.lowerLeft.x, bboxM.lowerLeft.y, bboxM.upperRight.x, bboxM.upperRight.y);
    }
 
    void cropWithM(double xLL, double yLL, double xUR, double yUR);
 
 
    virtual inline
    void deg2pix(double lon, double lat, int & i, int & j) const {
        projGeo2Native.projectFwd(lon, lat, lon, lat); // PROJ6-CRS uses degrees
        // ...Now (lon,lat) are metric
        // projGeo2Native.projectFwd(lon*DEG2RAD, lat*DEG2RAD, lon, lat); // PROJ6-CRS uses degrees
        m2pix(lon, lat, i,j);
    }
 
    inline
    void deg2pix(const drain::Point2D<double> & loc, drain::Point2D<int> & pix) const {
        deg2pix(loc.x, loc.y, pix.x, pix.y);
    }
 
 
    virtual inline
    void deg2m(double lon, double lat, double &x, double &y) const {
        projGeo2Native.projectFwd(lon, lat, x, y); // PROJ6-CRS uses degrees
    }
 
 
    inline
    void deg2m(const drain::Point2D<double> & pDeg, drain::Point2D<double> & pMet) const {
        deg2m(pDeg.x, pDeg.y, pMet.x, pMet.y);
    }
 
    virtual inline
    void pix2deg(int i, int j, double & lon, double & lat) const {
        pix2m(i,j, lon,lat); //pix2m(i,j, x,y);
        projGeo2Native.projectInv(lon,lat, lon,lat);
        // lon *= RAD2DEG; // PROJ6-CRS uses degrees
        // lat *= RAD2DEG; // PROJ6-CRS uses degrees
    }
 
    virtual inline
    void pix2rad(int i, int j, double & lon, double & lat) const {
        pix2m(i,j, lon,lat);
        projGeo2Native.projectInv(lon,lat, lon,lat);
        // PROJ6-CRS uses degrees:
        lon *= DEG2RAD;
        lat *= DEG2RAD;
    }
 
 
    inline
    void pix2deg(const drain::Point2D<int> & pix, drain::Point2D<double> & loc) const {
        pix2deg(pix.x,pix.y, loc.x,loc.y);
    }
 
    virtual inline
    void pix2LLdeg(int i,int j, double & lon, double & lat) const {
        double x, y; // metric
        pix2LLm(i,j, x,y);
        projGeo2Native.projectInv(x,y, lon,lat);
        // lon *= RAD2DEG; // PROJ6-CRS uses degrees
        // lat *= RAD2DEG; // PROJ6-CRS uses degrees
    }
 
 
    virtual inline
    void m2deg(double x, double y, double & lon, double & lat) const {
        projGeo2Native.projectInv(x,y, lon,lat);
        // lon *= RAD2DEG; // PROJ6-CRS uses degrees
        // lat *= RAD2DEG; // PROJ6-CRS uses degrees
    }
 
 
    virtual inline
    void m2deg(const drain::Point2D<double> & pMetric, drain::Point2D<double> & pDeg) const {
        projGeo2Native.projectInv(pMetric.x, pMetric.y, pDeg.x, pDeg.y); // lon, lat);
        //pDeg.x *= RAD2DEG; // PROJ6-CRS uses degrees
        //pDeg.y *= RAD2DEG; // PROJ6-CRS uses degrees
    }
 
    /* UNTESTED
    inline virtual
    void LLdeg2m(const double & lon, const double & lat, double & x, double & y) const {
            projGeo2Native.projectFwd(lon,lat, x,y);
    }
    */
 
 
 
    inline virtual
    void m2pix(double x, double y, int & i, int & j) const {
        // i = static_cast<int>(0.5+ (x - bBoxNative.lowerLeft.x) / xScale); //  xOffset
        // j = frameHeight-1 - static_cast<int>(0.5+ (y - bBoxNative.lowerLeft.y) / yScale);
        // j = frameHeight-1 - static_cast<int>(0.5+ (y - bBoxNative.lowerLeft.y) / yScale);
        i = ::lround((x - bBoxNative.lowerLeft.x) / xScale); //  xOffset
        j = frame.height-1 - ::lround((y - bBoxNative.lowerLeft.y) / yScale);
    }
 
    inline // virtual
    void m2pix(const drain::Point2D<double> & pMetric, drain::Point2D<int> & pImage) const {
        // pImage.x = ::lround( (pMetric.x - bBoxNative.lowerLeft.x) / xScale); //  xOffset
        // pImage.y = frame.height-1 - ::lround((pMetric.y - bBoxNative.lowerLeft.y) / yScale);
        m2pix(pMetric.x, pMetric.y, pImage.x, pImage.y);
    }
 
 
 
    virtual inline
    void pix2m(int i, int j, double & x, double & y) const {
        x = (static_cast<double>(i)+0.5)*xScale + bBoxNative.lowerLeft.x;
        y = (static_cast<double>(frame.height-1 - j)+0.5)*yScale + bBoxNative.lowerLeft.y;
    }
 
 
    virtual inline
    void pix2m(const drain::Point2D<int> & pImage, drain::Point2D<double> & pMetric) const {
        pMetric.x = (static_cast<double>(pImage.x)+0.5)*xScale + bBoxNative.lowerLeft.x;
        pMetric.y = (static_cast<double>(frame.height-1 - pImage.y)+0.5)*yScale + bBoxNative.lowerLeft.y;
    }
 
 
    virtual inline
    void pix2LLm(int i, int j, double & x, double & y) const {
        x = (static_cast<double>(i))*xScale + bBoxNative.lowerLeft.x;
        y = (static_cast<double>(frame.height-1 - j))*yScale + bBoxNative.lowerLeft.y;
    }
 
 
    inline
    void setProjection(const Projector & proj){
        if (proj.getEPSG() > 0){
            projGeo2Native.setProjectionDst(proj.getEPSG());
        }
        else {
            projGeo2Native.setProjectionDst(proj.getProjDef()); // variant?
        }
        updateProjection();
    }
 
    inline
    void setProjection(const std::string & projDef){
        projGeo2Native.setProjectionDst(projDef);
        updateProjection();
    }
 
    inline
    void setProjectionEPSG(int epsg){
        projGeo2Native.setProjectionDst(epsg);
        //projGeo2Native.dst.setProjection(epsg);
        //projGeo2Native.setDirectMapping(true); // was missing?
        updateProjection();
    }
 
 
    inline
    const Proj6 & getProj() const {
        return projGeo2Native;
    };
 
    inline
    int getEPSG() const {
        return projGeo2Native.getDst().getEPSG();
    };
 
    inline
    const std::string & getProjStr() const {
        return projGeo2Native.getProjStrDst();
    };
 
    //  Consider: rename src/input projection coord system
    inline
    const std::string & getInputProjStr() const {
        return projGeo2Native.getProjStrSrc();
    };
 
 
    inline
    //const drain::Rectangle<double> & getDataBBoxD() const { return dataBBoxD; };
    const drain::Rectangle<double> & getDataBBoxNat() const { return dataBBoxNat; };
 
    inline
    //const drain::Rectangle<double> & getDataOverlapD() const { return dataOverlapD; };
    const drain::Rectangle<double> & getDataOverlapBBoxNat() const { return dataOverlapBBoxNat; };
 
 
    void updateDataExtentDeg(const drain::Rectangle<double> &inputBBoxDeg);
 
    void updateDataExtentNat(const drain::Rectangle<double> &inputBBoxNat);
 
 
    inline
    bool isLongLat() const {
        return projGeo2Native.isLongLat();
    }
 
 
    template <typename BB>
    drain::Unit convert(const std::string & bboxStr, BB & bbox);
 
    // Todo: templatize to support bb[0...3]
    void convert(const std::vector<double> &bb, drain::Unit unit,
            drain::Rectangle<double> &bboxNat, drain::Rectangle<int> &bboxImg);
 
    // Todo: templatize to support bb[0...3]
    drain::Unit convert(const std::string & bbox,
            drain::Rectangle<double> &bboxNat, drain::Rectangle<int> &bboxImg);
 
 
    //std::ostream & toOStr(std::ostream & ostr) const ;
    virtual
    std::ostream & toStream(std::ostream & ostr) const;
 
 
 
protected:
 
    drain::Proj6 projGeo2Native;
 
    void updateProjection();
 
 
    // drain::image::AreaGeometry frameGeometry; would be fine, but unsigned caused conversion/cast underflows
    Frame2D<int> frame;
    // int frameWidth;
    // int frameHeight;
 
    drain::Rectangle<double> bBoxR;
 
    drain::Rectangle<double> bBoxD;
 
    drain::Rectangle<double> bBoxNative;
 
    // experimental
    drain::Rectangle<double> dataBBoxNat;
 
    // experimental
    drain::Rectangle<double> dataOverlapBBoxNat;
 
    // ... needed in mapping...
    double xScale = 0.0;
    double yScale = 0.0;
 
};
 
 
 
template <typename BB>
drain::Unit GeoFrame::convert(const std::string & bboxStr, BB & bbox){
 
    drain::StringTools::split(bboxStr, bbox, ',');
 
    drain::Unit unit = drain::Units::extract<drain::Unit>(bboxStr);
    if (unit == drain::Unit::UNDEFINED){
        if (BBox::isMetric({bbox[0], bbox[1]}) && BBox::isMetric({bbox[2], bbox[3]})){
            // TODO: add numeric support to guess...
 
        };
        unit = drain::Unit::PIXEL;
    }
 
    return unit;
}
 
 
inline
std::ostream & operator<<(std::ostream & ostr, const GeoFrame & frame){
    frame.GeoFrame::toStream(ostr);
    ostr << '\n';
    return ostr;
}
 
 
} // ::image
} // ::drain
 
#endif /*COMPOSITOR_R_H_*/
 
// Drain