File: gdalalg_vector_clean_coverage.cpp

package info (click to toggle)
gdal 3.12.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 92,292 kB
  • sloc: cpp: 1,223,498; ansic: 206,434; python: 26,278; java: 6,001; xml: 4,769; sh: 3,855; cs: 2,513; yacc: 1,306; makefile: 214
file content (233 lines) | stat: -rw-r--r-- 6,864 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
/******************************************************************************
*
 * Project:  GDAL
 * Purpose:  "gdal vector clean-coverage" subcommand
 * Author:   Daniel Baston
 *
 ******************************************************************************
 * Copyright (c) 2025, ISciences LLC
 *
 * SPDX-License-Identifier: MIT
 ****************************************************************************/

#include "gdalalg_vector_clean_coverage.h"

#include "cpl_error.h"
#include "gdal_priv.h"
#include "gdalalg_vector_geom.h"
#include "ogr_geometry.h"
#include "ogr_geos.h"
#include "ogrsf_frmts.h"

#include <cinttypes>

#ifndef _
#define _(x) (x)
#endif

//! @cond Doxygen_Suppress

GDALVectorCleanCoverageAlgorithm::GDALVectorCleanCoverageAlgorithm(
    bool standaloneStep)
    : GDALVectorPipelineStepAlgorithm(NAME, DESCRIPTION, HELP_URL,
                                      standaloneStep)
{
    AddActiveLayerArg(&m_activeLayer);
    AddArg("snapping-distance", 0, _("Distance tolerance for snapping nodes"),
           &m_opts.snappingTolerance)
        .SetMinValueIncluded(0);

    AddArg("merge-strategy", 0,
           _("Algorithm to assign overlaps to neighboring polygons"),
           &m_opts.mergeStrategy)
        .SetChoices({"longest-border", "max-area", "min-area", "min-index"});

    AddArg("maximum-gap-width", 0, _("Maximum width of a gap to be closed"),
           &m_opts.maximumGapWidth)
        .SetMinValueIncluded(0);
}

#if defined HAVE_GEOS &&                                                       \
    (GEOS_VERSION_MAJOR > 3 ||                                                 \
     (GEOS_VERSION_MAJOR == 3 && GEOS_VERSION_MINOR >= 14))

class GDALVectorCleanCoverageOutputDataset final
    : public GDALGeosNonStreamingAlgorithmDataset
{
  public:
    GDALVectorCleanCoverageOutputDataset(
        const GDALVectorCleanCoverageAlgorithm::Options &opts)
        : m_opts(opts), m_cleanParams(GetCoverageCleanParams())
    {
    }

    ~GDALVectorCleanCoverageOutputDataset() override;

    GEOSCoverageCleanParams *GetCoverageCleanParams() const
    {
        GEOSCoverageCleanParams *params =
            GEOSCoverageCleanParams_create_r(m_poGeosContext);

        if (!params)
        {
            CPLError(CE_Failure, CPLE_AppDefined,
                     "Failed to create coverage clean parameters");
            return nullptr;
        }

        if (!GEOSCoverageCleanParams_setSnappingDistance_r(
                m_poGeosContext, params, m_opts.snappingTolerance))
        {
            CPLError(CE_Failure, CPLE_AppDefined,
                     "Failed to set snapping tolerance");
            GEOSCoverageCleanParams_destroy_r(m_poGeosContext, params);
            return nullptr;
        }

        if (!GEOSCoverageCleanParams_setGapMaximumWidth_r(
                m_poGeosContext, params, m_opts.maximumGapWidth))
        {
            CPLError(CE_Failure, CPLE_AppDefined,
                     "Failed to set maximum gap width");
            GEOSCoverageCleanParams_destroy_r(m_poGeosContext, params);
            return nullptr;
        }

        int mergeStrategy;
        if (m_opts.mergeStrategy == "longest-border")
        {
            mergeStrategy = GEOS_MERGE_LONGEST_BORDER;
        }
        else if (m_opts.mergeStrategy == "max-area")
        {
            mergeStrategy = GEOS_MERGE_MAX_AREA;
        }
        else if (m_opts.mergeStrategy == "min-area")
        {
            mergeStrategy = GEOS_MERGE_MIN_AREA;
        }
        else if (m_opts.mergeStrategy == "min-index")
        {
            mergeStrategy = GEOS_MERGE_MIN_INDEX;
        }
        else
        {
            CPLError(CE_Failure, CPLE_AppDefined,
                     "Unknown overlap merge strategy: %s",
                     m_opts.mergeStrategy.c_str());
            GEOSCoverageCleanParams_destroy_r(m_poGeosContext, params);
            return nullptr;
        }

        if (!GEOSCoverageCleanParams_setOverlapMergeStrategy_r(
                m_poGeosContext, params, mergeStrategy))
        {
            CPLError(CE_Failure, CPLE_AppDefined,
                     "Failed to set overlap merge strategy");
            GEOSCoverageCleanParams_destroy_r(m_poGeosContext, params);
            return nullptr;
        }

        return params;
    }

    bool PolygonsOnly() const override
    {
        return true;
    }

    bool SkipEmpty() const override
    {
        return false;
    }

    bool ProcessGeos() override
    {
        // Perform coverage cleaning
        GEOSGeometry *coll = GEOSGeom_createCollection_r(
            m_poGeosContext, GEOS_GEOMETRYCOLLECTION, m_apoGeosInputs.data(),
            static_cast<unsigned int>(m_apoGeosInputs.size()));

        if (coll == nullptr)
        {
            return false;
        }

        m_apoGeosInputs.clear();

        m_poGeosResultAsCollection =
            GEOSCoverageCleanWithParams_r(m_poGeosContext, coll, m_cleanParams);
        GEOSGeom_destroy_r(m_poGeosContext, coll);

        return m_poGeosResultAsCollection != nullptr;
    }

    CPL_DISALLOW_COPY_ASSIGN(GDALVectorCleanCoverageOutputDataset)

  private:
    const GDALVectorCleanCoverageAlgorithm::Options &m_opts;
    GEOSCoverageCleanParams *m_cleanParams;
};

GDALVectorCleanCoverageOutputDataset::~GDALVectorCleanCoverageOutputDataset()
{
    if (m_poGeosContext != nullptr)
    {
        GEOSCoverageCleanParams_destroy_r(m_poGeosContext, m_cleanParams);
    }
}

bool GDALVectorCleanCoverageAlgorithm::RunStep(GDALPipelineStepRunContext &)
{
    auto poSrcDS = m_inputDataset[0].GetDatasetRef();
    auto poDstDS =
        std::make_unique<GDALVectorCleanCoverageOutputDataset>(m_opts);

    bool bFoundActiveLayer = false;

    for (auto &&poSrcLayer : poSrcDS->GetLayers())
    {
        if (m_activeLayer.empty() ||
            m_activeLayer == poSrcLayer->GetDescription())
        {
            if (!poDstDS->AddProcessedLayer(*poSrcLayer))
            {
                return false;
            }
            bFoundActiveLayer = true;
        }
        else
        {
            poDstDS->AddPassThroughLayer(*poSrcLayer);
        }
    }

    if (!bFoundActiveLayer)
    {
        ReportError(CE_Failure, CPLE_AppDefined,
                    "Specified layer '%s' was not found",
                    m_activeLayer.c_str());
        return false;
    }

    m_outputDataset.Set(std::move(poDstDS));

    return true;
}

#else

bool GDALVectorCleanCoverageAlgorithm::RunStep(GDALPipelineStepRunContext &)
{
    ReportError(CE_Failure, CPLE_AppDefined,
                "%s requires GDAL to be built against version 3.14 or later of "
                "the GEOS library.",
                NAME);
    return false;
}
#endif  // HAVE_GEOS

GDALVectorCleanCoverageAlgorithmStandalone::
    ~GDALVectorCleanCoverageAlgorithmStandalone() = default;

//! @endcond