Merge pull request #13887 from OSGeo/backport-13877-to-release/3.12

[Backport release/3.12] gdal raster as-features: make it output --layer-name and expose option when used in pipeline

Author: rouault

apps/gdalalg_abstract_pipeline.h

@@ -351,6 +351,9 @@ class GDALPipelineStepAlgorithm /* non final */ : public GDALAlgorithm
     void AddVectorInputArgs(bool hiddenForCLI);
     void AddVectorOutputArgs(bool hiddenForCLI,
                              bool shortNameOutputLayerAllowed);
+    using GDALAlgorithm::AddOutputLayerNameArg;
+    void AddOutputLayerNameArg(bool hiddenForCLI,
+                               bool shortNameOutputLayerAllowed);
 
   private:
     bool RunImpl(GDALProgressFunc pfnProgress, void *pProgressData) override;

apps/gdalalg_pipeline.cpp

@@ -221,11 +221,7 @@ void GDALPipelineStepAlgorithm::AddVectorOutputArgs(
     }
     if (m_constructorOptions.addOutputLayerNameArgument)
     {
-        AddArg(GDAL_ARG_NAME_OUTPUT_LAYER,
-               shortNameOutputLayerAllowed ? 'l' : 0, _("Output layer name"),
-               &m_outputLayerName)
-            .AddHiddenAlias("nln")  // For ogr2ogr nostalgic people
-            .SetHiddenForCLI(hiddenForCLI);
+        AddOutputLayerNameArg(hiddenForCLI, shortNameOutputLayerAllowed);
     }
     if (m_constructorOptions.addSkipErrorsArgument)
     {
@@ -235,6 +231,20 @@ void GDALPipelineStepAlgorithm::AddVectorOutputArgs(
     }
 }
 
+/************************************************************************/
+/*          GDALPipelineStepAlgorithm::AddOutputLayerNameArg()          */
+/************************************************************************/
+
+void GDALPipelineStepAlgorithm::AddOutputLayerNameArg(
+    bool hiddenForCLI, bool shortNameOutputLayerAllowed)
+{
+    AddArg(GDAL_ARG_NAME_OUTPUT_LAYER, shortNameOutputLayerAllowed ? 'l' : 0,
+           _("Output layer name"),
+           &m_outputLayerName)
+        .AddHiddenAlias("nln")  // For ogr2ogr nostalgic people
+        .SetHiddenForCLI(hiddenForCLI);
+}
+
 /************************************************************************/
 /*                 GDALPipelineStepAlgorithm::RunImpl()                 */
 /************************************************************************/

apps/gdalalg_raster_contour.cpp

@@ -50,6 +50,11 @@ GDALRasterContourAlgorithm::GDALRasterContourAlgorithm(bool standaloneStep)
         AddRasterInputArgs(false, false);
         AddVectorOutputArgs(false, false);
     }
+    else
+    {
+        AddOutputLayerNameArg(/* hiddenForCLI = */ false,
+                              /* shortNameOutputLayerAllowed = */ false);
+    }
 
     // gdal_contour specific options
     AddBandArg(&m_band).SetDefault(1);

apps/gdalalg_raster_polygonize.cpp

@@ -46,6 +46,11 @@ GDALRasterPolygonizeAlgorithm::GDALRasterPolygonizeAlgorithm(
         AddRasterInputArgs(false, false);
         AddVectorOutputArgs(false, false);
     }
+    else
+    {
+        AddOutputLayerNameArg(/* hiddenForCLI = */ false,
+                              /* shortNameOutputLayerAllowed = */ false);
+    }
 
     // gdal_polygonize specific options
     AddBandArg(&m_band).SetDefault(m_band);

apps/gdalalg_vector_select.cpp

@@ -32,6 +32,11 @@ GDALVectorSelectAlgorithm::GDALVectorSelectAlgorithm(bool standaloneStep)
     : GDALVectorPipelineStepAlgorithm(NAME, DESCRIPTION, HELP_URL,
                                       standaloneStep)
 {
+    if (!standaloneStep)
+    {
+        AddOutputLayerNameArg(/* hiddenForCLI = */ false,
+                              /* shortNameOutputLayerAllowed = */ false);
+    }
     AddActiveLayerArg(&m_activeLayer);
     AddArg("fields", 0, _("Fields to select (or exclude if --exclude)"),
            &m_fields)
@@ -90,11 +95,14 @@ class GDALVectorSelectAlgorithmLayer final
     }
 
   public:
-    explicit GDALVectorSelectAlgorithmLayer(OGRLayer &oSrcLayer)
+    explicit GDALVectorSelectAlgorithmLayer(
+        OGRLayer &oSrcLayer, const std::string &osOutputLayerName)
         : GDALVectorPipelineOutputLayer(oSrcLayer),
-          m_poFeatureDefn(new OGRFeatureDefn(oSrcLayer.GetName()))
+          m_poFeatureDefn(new OGRFeatureDefn(osOutputLayerName.empty()
+                                                 ? oSrcLayer.GetName()
+                                                 : osOutputLayerName.c_str()))
     {
-        SetDescription(oSrcLayer.GetDescription());
+        SetDescription(m_poFeatureDefn->GetName());
         SetMetadata(oSrcLayer.GetMetadata());
         m_poFeatureDefn->SetGeomType(wkbNone);
         m_poFeatureDefn->Reference();
@@ -301,8 +309,8 @@ bool GDALVectorSelectAlgorithm::RunStep(GDALPipelineStepRunContext &)
         if (m_activeLayer.empty() ||
             m_activeLayer == poSrcLayer->GetDescription())
         {
-            auto poLayer =
-                std::make_unique<GDALVectorSelectAlgorithmLayer>(*poSrcLayer);
+            auto poLayer = std::make_unique<GDALVectorSelectAlgorithmLayer>(
+                *poSrcLayer, m_outputLayerName);
             if (m_exclude)
             {
                 poLayer->ExcludeFields(m_fields);

autotest/utilities/test_gdalalg_raster_contour.py

@@ -244,3 +244,12 @@ def test_gdalalg_raster_contour_all_nodata(tmp_vsimem):
     ds = alg.Output()
     lyr = ds.GetLayer(0)
     assert lyr.GetFeatureCount() == 0
+
+
+def test_gdalalg_raster_contour_pipeline_output_layer(tmp_vsimem):
+
+    with gdal.alg.pipeline(
+        pipeline="read ../gcore/data/byte.tif ! contour --interval 10 --output-layer foo"
+    ) as alg:
+        ds = alg.Output()
+        assert ds.GetLayer(0).GetName() == "foo"

autotest/utilities/test_gdalalg_raster_polygonize.py

@@ -304,3 +304,12 @@ def test_gdalalg_raster_polygonize_no_next_usable_step_in_pipeline(tmp_vsimem):
 
     with ogr.Open(out_filename) as ds:
         assert ds.GetLayer(0).GetFeatureCount() == 281
+
+
+def test_gdalalg_raster_polygonize_pipeline_output_layer(tmp_vsimem):
+
+    with gdal.alg.pipeline(
+        pipeline="read ../gcore/data/byte.tif ! polygonize --output-layer foo"
+    ) as alg:
+        ds = alg.Output()
+        assert ds.GetLayer(0).GetName() == "foo"

autotest/utilities/test_gdalalg_vector_select.py

@@ -241,3 +241,14 @@ def test_gdalalg_vector_select_active_layer():
 
     out_lyr = out_ds.GetLayer(1)
     assert out_lyr.GetLayerDefn().GetFieldCount() == 2
+
+
+def test_gdalalg_vector_select_pipeline_output_layer():
+
+    with gdal.alg.vector.pipeline(
+        pipeline="read ../ogr/data/poly.shp ! select --output-layer foo --fields EAS_ID"
+    ) as alg:
+        ds = alg.Output()
+        lyr = ds.GetLayer(0)
+        assert lyr.GetDescription() == "foo"
+        assert lyr.GetLayerDefn().GetName() == "foo"