GDAL

gdalalg_raster_zonal_stats.h
1/******************************************************************************
2 *
3 * Project: GDAL
4 * Purpose: gdal "raster zonal-stats" subcommand
5 * Author: Dan Baston
6 *
7 ******************************************************************************
8 * Copyright (c) 2025, ISciences LLC
9 *
10 * SPDX-License-Identifier: MIT
11 ****************************************************************************/
12
13#ifndef GDALALG_RASTER_ZONAL_STATS_INCLUDED
14#define GDALALG_RASTER_ZONAL_STATS_INCLUDED
15
16#include "gdalalg_abstract_pipeline.h"
17
19
20/************************************************************************/
21/* GDALRasterZonalStatsAlgorithm */
22/************************************************************************/
23
24 class GDALRasterZonalStatsAlgorithm /* non final */
25 : public GDALPipelineStepAlgorithm
26{
27 public:
28 static constexpr const char *NAME = "zonal-stats";
29 static constexpr const char *DESCRIPTION =
30 "Calculate raster zonal statistics";
31 static constexpr const char *HELP_URL =
32 "/programs/gdal_raster_zonal_stats.html";
33
34 explicit GDALRasterZonalStatsAlgorithm(bool bStandalone = false);
35
36 int GetInputType() const override
37 {
38 return GDAL_OF_RASTER;
39 }
40
41 int GetOutputType() const override
42 {
43 return GDAL_OF_VECTOR;
44 }
45
46 private:
47 bool RunStep(GDALPipelineStepRunContext &ctxt) override;
48 bool RunImpl(GDALProgressFunc pfnProgress, void *pProgressData) override;
49
50 GDALArgDatasetValue m_weights{};
51 GDALArgDatasetValue m_zones{};
52 std::string m_zonesLayer{};
53 int m_zonesBand{0};
54 std::vector<int> m_bands{};
55 std::vector<std::string> m_stats{};
56 std::vector<std::string> m_includeFields{};
57 std::string m_strategy{};
58 std::string m_memoryStr{"5%"};
59 std::string m_pixels{"default"};
60 int m_weightsBand{0};
61 size_t m_memoryBytes{
62 static_cast<size_t>(100) * 1024 *
63 1024}; // FIXME validation action doesn't seem to run if arg isn't specified, so this never gets sets?
64};
65
66/************************************************************************/
67/* GDALRasterZonalStatsAlgorithmStandalone */
68/************************************************************************/
69
70 class GDALRasterZonalStatsAlgorithmStandalone final
71 : public GDALRasterZonalStatsAlgorithm
72{
73 public:
74 GDALRasterZonalStatsAlgorithmStandalone()
75 : GDALRasterZonalStatsAlgorithm(/* standaloneStep = */ true)
76 {
77 }
78
79 ~GDALRasterZonalStatsAlgorithmStandalone() override;
80};
81
83
84#endif
GDALArgDatasetValue
Value for an argument that points to a GDALDataset.
Definition gdalalgorithm_cpp.h:149
GDAL_OF_RASTER
#define GDAL_OF_RASTER
Allow raster drivers to be used.
Definition gdal.h:1088
GDAL_OF_VECTOR
#define GDAL_OF_VECTOR
Allow vector drivers to be used.
Definition gdal.h:1093