terrainerrorfield.h

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-3.0-or-later
 
#ifndef OPENSWMM_MESH_TERRAINERRORFIELD_H
#define OPENSWMM_MESH_TERRAINERRORFIELD_H
 
#include <QPointF>
#include <QRectF>
#include <QString>
#include <functional>
#include <memory>
 
namespace mesh
{
 
class TerrainErrorField
{
public:
    struct Query {
        double maxError = 0.0;     
        double upperBound = 0.0;   
        QPointF point;             
        quint64 samples = 0;       
        quint64 noDataSamples = 0; 
        bool valid = true;         
    };
    TerrainErrorField();
    ~TerrainErrorField();
    TerrainErrorField(const TerrainErrorField &) = delete;
    TerrainErrorField &operator=(const TerrainErrorField &) = delete;
 
    bool open(const QString &path, const QString &meshCRS, const QRectF &domain,
              double zScale = 1.0, int cacheMiB = 64,
              const std::function<bool(double)> &progress = {}, const QString &indexFile = {});
    bool indexLoaded() const; 
    bool indexSaved() const; 
    // Test seam; coordinates are pixel centres (col+.5,row+.5).
    bool buildFromGrid(const float *z, int cols, int rows,
                       const std::function<bool(double)> &progress = {});
    double sampleAt(double x, double y) const;
    void prefetch(const QVector<QRectF> &meshBoxes) const;
    Query queryTriangle(const QPointF *xy, const double *z, double tolerance,
                        bool exhaustive = false) const;
    Query queryWorst(const QPointF *xy, const double *z, double tolerance) const;
    QString errorMsg() const;
    quint64 referenceSamples() const;
    qint64 summaryBytes() const;
    double verticalQuantum() const; 
    double leafResidualQuantile(double q) const;
    void setCancellation(std::function<bool()> cancelled);
    // Composite references (e.g. authored channel bathymetry) override pixel
    // elevations only inside the supplied bounds. Ordinary terrain keeps its
    // fast planar hierarchy. sampleAt() still samples the original raster.
    void setQueryOverride(const QRectF &bounds, std::function<double(double, double, double)> value,
                          std::function<bool(const QRectF &)> intersects = {});
 
private:
    struct Impl;
    std::unique_ptr<Impl> d;
};
}
#endif