VeniVidiVici
/
gdal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

gdal raster edit/reproject: use --bbox instead of --extent 

Fixes #11526
This commit is contained in:
Even Rouault 2024-12-20 19:32:26 +01:00
parent 704109600d
commit 5c13e6dd1d
No known key found for this signature in database
GPG Key ID: 33EBBFC47B3DD87D
13 changed files with 81 additions and 106 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
apps/gdalalg_raster_edit.cpp
View File

@ -44,29 +44,7 @@ GDALRasterEditAlgorithm::GDALRasterEditAlgorithm(bool standaloneStep)
.AddHiddenAlias("a_srs")
.SetIsCRSArg(/*noneAllowed=*/true);
{
auto &arg =
AddArg("extent", 0, _("Extent as xmin,ymin,xmax,ymax"), &m_extent)
.SetRepeatedArgAllowed(false)
.SetMinCount(4)
.SetMaxCount(4)
.SetDisplayHintAboutRepetition(false);
arg.AddValidationAction(
[&arg]()
{
const auto &val = arg.Get<std::vector<double>>();
CPLAssert(val.size() == 4);
if (!(val[0] <= val[2]) || !(val[1] <= val[3]))
{
CPLError(
CE_Failure, CPLE_AppDefined,
"Value of 'extent' should be xmin,ymin,xmax,ymax with "
"xmin <= xmax and ymin <= ymax");
return false;
}
return true;
});
}
AddBBOXArg(&m_bbox);
{
auto &arg = AddArg("metadata", 0, _("Add/update dataset metadata item"),
@ -122,7 +100,7 @@ bool GDALRasterEditAlgorithm::RunImpl(GDALProgressFunc pfnProgress,
}
}
if (!m_extent.empty())
if (!m_bbox.empty())
{
if (poDS->GetRasterXSize() == 0 || poDS->GetRasterYSize() == 0)
{
@ -132,12 +110,12 @@ bool GDALRasterEditAlgorithm::RunImpl(GDALProgressFunc pfnProgress,
return false;
}
double adfGT[6];
adfGT[0] = m_extent[0];
adfGT[1] = (m_extent[2] - m_extent[0]) / poDS->GetRasterXSize();
adfGT[0] = m_bbox[0];
adfGT[1] = (m_bbox[2] - m_bbox[0]) / poDS->GetRasterXSize();
adfGT[2] = 0;
adfGT[3] = m_extent[3];
adfGT[3] = m_bbox[3];
adfGT[4] = 0;
adfGT[5] = -(m_extent[3] - m_extent[1]) / poDS->GetRasterYSize();
adfGT[5] = -(m_bbox[3] - m_bbox[1]) / poDS->GetRasterYSize();
if (poDS->SetGeoTransform(adfGT) != CE_None)
{
ReportError(CE_Failure, CPLE_AppDefined,
@ -193,15 +171,13 @@ bool GDALRasterEditAlgorithm::RunStep(GDALProgressFunc, void *)
aosOptions.AddString("-a_srs");
aosOptions.AddString(m_overrideCrs.c_str());
}
if (!m_extent.empty())
if (!m_bbox.empty())
{
aosOptions.AddString("-a_ullr");
aosOptions.AddString(CPLSPrintf("%.17g", m_extent[0])); // upper-left X
aosOptions.AddString(CPLSPrintf("%.17g", m_extent[3])); // upper-left Y
aosOptions.AddString(
CPLSPrintf("%.17g", m_extent[2])); // lower-right X
aosOptions.AddString(
CPLSPrintf("%.17g", m_extent[1])); // lower-right Y
aosOptions.AddString(CPLSPrintf("%.17g", m_bbox[0])); // upper-left X
aosOptions.AddString(CPLSPrintf("%.17g", m_bbox[3])); // upper-left Y
aosOptions.AddString(CPLSPrintf("%.17g", m_bbox[2])); // lower-right X
aosOptions.AddString(CPLSPrintf("%.17g", m_bbox[1])); // lower-right Y
}
for (const auto &val : m_metadata)

2
apps/gdalalg_raster_edit.h
View File

@ -42,7 +42,7 @@ class GDALRasterEditAlgorithm /* non final */
GDALArgDatasetValue m_dataset{}; // standalone mode only
std::string m_overrideCrs{};
std::vector<double> m_extent{};
std::vector<double> m_bbox{};
std::vector<std::string> m_metadata{};
std::vector<std::string> m_unsetMetadata{};
};

33
apps/gdalalg_raster_reproject.cpp
View File

@ -62,28 +62,7 @@ GDALRasterReprojectAlgorithm::GDALRasterReprojectAlgorithm(bool standaloneStep)
return true;
});
auto &extentArg =
AddArg("extent", 0, _("Target extent (in destination CRS units)"),
&m_extent)
.SetMinCount(4)
.SetMaxCount(4)
.SetRepeatedArgAllowed(false)
.SetDisplayHintAboutRepetition(false)
.SetMetaVar("<xmin>,<ymin>,<xmax>,<ymax>");
extentArg.AddValidationAction(
[&extentArg]()
{
const auto &val = extentArg.Get<std::vector<double>>();
CPLAssert(val.size() == 4);
if (!(val[0] <= val[2]) || !(val[1] <= val[3]))
{
CPLError(CE_Failure, CPLE_AppDefined,
"Value of 'extent' should be xmin,ymin,xmax,ymax with "
"xmin <= xmax and ymin <= ymax");
return false;
}
return true;
});
AddBBOXArg(&m_bbox, _("Target bounding box (in destination CRS units)"));
AddArg("target-aligned-pixels", 0,
_("Round target extent to target resolution"),
@ -125,13 +104,13 @@ bool GDALRasterReprojectAlgorithm::RunStep(GDALProgressFunc, void *)
aosOptions.AddString(CPLSPrintf("%.17g", m_resolution[0]));
aosOptions.AddString(CPLSPrintf("%.17g", m_resolution[1]));
}
if (!m_extent.empty())
if (!m_bbox.empty())
{
aosOptions.AddString("-te");
aosOptions.AddString(CPLSPrintf("%.17g", m_extent[0]));
aosOptions.AddString(CPLSPrintf("%.17g", m_extent[1]));
aosOptions.AddString(CPLSPrintf("%.17g", m_extent[2]));
aosOptions.AddString(CPLSPrintf("%.17g", m_extent[3]));
aosOptions.AddString(CPLSPrintf("%.17g", m_bbox[0]));
aosOptions.AddString(CPLSPrintf("%.17g", m_bbox[1]));
aosOptions.AddString(CPLSPrintf("%.17g", m_bbox[2]));
aosOptions.AddString(CPLSPrintf("%.17g", m_bbox[3]));
}
if (m_targetAlignedPixels)
{

2
apps/gdalalg_raster_reproject.h
View File

@ -44,7 +44,7 @@ class GDALRasterReprojectAlgorithm /* non final */
std::string m_dstCrs{};
std::string m_resampling{};
std::vector<double> m_resolution{};
std::vector<double> m_extent{};
std::vector<double> m_bbox{};
bool m_targetAlignedPixels = false;
};

21
apps/gdalalg_vector_filter.cpp
View File

@ -29,26 +29,7 @@ GDALVectorFilterAlgorithm::GDALVectorFilterAlgorithm(bool standaloneStep)
: GDALVectorPipelineStepAlgorithm(NAME, DESCRIPTION, HELP_URL,
standaloneStep)
{
auto &arg =
AddArg("bbox", 0, _("Bounding box as xmin,ymin,xmax,ymax"), &m_bbox)
.SetRepeatedArgAllowed(false)
.SetMinCount(4)
.SetMaxCount(4)
.SetDisplayHintAboutRepetition(false);
arg.AddValidationAction(
[&arg]()
{
const auto &val = arg.Get<std::vector<double>>();
CPLAssert(val.size() == 4);
if (!(val[0] <= val[2]) || !(val[1] <= val[3]))
{
CPLError(CE_Failure, CPLE_AppDefined,
"Value of 'bbox' should be xmin,ymin,xmax,ymax with "
"xmin <= xmax and ymin <= ymax");
return false;
}
return true;
});
AddBBOXArg(&m_bbox);
}
/************************************************************************/

4
autotest/cpp/test_gdal_algorithm.cpp
View File

@ -3106,7 +3106,7 @@ TEST_F(test_gdal_algorithm, raster_edit_failures_dataset_0_0)
ASSERT_NE(datasetArg, nullptr);
datasetArg->Get<GDALArgDatasetValue>().Set(std::make_unique<MyDataset>());
auto extentArg = edit->GetArg("extent");
auto extentArg = edit->GetArg("bbox");
ASSERT_NE(extentArg, nullptr);
extentArg->Set(std::vector<double>{2, 49, 3, 50});
@ -3219,7 +3219,7 @@ TEST_F(test_gdal_algorithm, raster_edit_failures_set_geo_transform)
ASSERT_NE(datasetArg, nullptr);
datasetArg->Get<GDALArgDatasetValue>().Set(std::make_unique<MyDataset>());
auto extentArg = edit->GetArg("extent");
auto extentArg = edit->GetArg("bbox");
ASSERT_NE(extentArg, nullptr);
extentArg->Set(std::vector<double>{2, 49, 3, 50});

14
autotest/utilities/test_gdalalg_raster_edit.py
View File

@ -69,7 +69,7 @@ def test_gdalalg_raster_edit_crs_none(tmp_vsimem):
assert ds.GetSpatialRef() is None
def test_gdalalg_raster_edit_extent(tmp_vsimem):
def test_gdalalg_raster_edit_bbox(tmp_vsimem):
tmp_filename = str(tmp_vsimem / "tmp.tif")
gdal.FileFromMemBuffer(tmp_filename, open("../gcore/data/byte.tif", "rb").read())
@ -77,7 +77,7 @@ def test_gdalalg_raster_edit_extent(tmp_vsimem):
pipeline = get_edit_alg()
assert pipeline.ParseRunAndFinalize(
[
"--extent=1,2,10,200",
"--bbox=1,2,10,200",
tmp_filename,
]
)
@ -86,7 +86,7 @@ def test_gdalalg_raster_edit_extent(tmp_vsimem):
assert ds.GetGeoTransform() == pytest.approx((1.0, 0.45, 0.0, 200.0, 0.0, -9.9))
def test_gdalalg_raster_edit_extent_invalid(tmp_vsimem):
def test_gdalalg_raster_edit_bbox_invalid(tmp_vsimem):
tmp_filename = str(tmp_vsimem / "tmp.tif")
gdal.FileFromMemBuffer(tmp_filename, open("../gcore/data/byte.tif", "rb").read())
@ -94,11 +94,11 @@ def test_gdalalg_raster_edit_extent_invalid(tmp_vsimem):
pipeline = get_edit_alg()
with pytest.raises(
Exception,
match="Value of 'extent' should be xmin,ymin,xmax,ymax with xmin <= xmax and ymin <= ymax",
match="Value of 'bbox' should be xmin,ymin,xmax,ymax with xmin <= xmax and ymin <= ymax",
):
pipeline.ParseRunAndFinalize(
[
"--extent=1,200,10,2",
"--bbox=1,200,10,2",
tmp_filename,
]
)
@ -189,7 +189,7 @@ def test_gdalalg_raster_pipeline_edit_crs_none(tmp_vsimem):
assert ds.GetSpatialRef() is None
def test_gdalalg_raster_pipeline_edit_extent(tmp_vsimem):
def test_gdalalg_raster_pipeline_edit_bbox(tmp_vsimem):
out_filename = str(tmp_vsimem / "out.tif")
@ -200,7 +200,7 @@ def test_gdalalg_raster_pipeline_edit_extent(tmp_vsimem):
"../gcore/data/byte.tif",
"!",
"edit",
"--extent=1,2,10,200",
"--bbox=1,2,10,200",
"!",
"write",
"--overwrite",

10
autotest/utilities/test_gdalalg_raster_pipeline.py
View File

@ -458,14 +458,14 @@ def test_gdalalg_raster_pipeline_reproject_no_args(tmp_vsimem):
assert ds.GetRasterBand(1).Checksum() == 4672
def test_gdalalg_raster_pipeline_reproject_invalid_extent(tmp_vsimem):
def test_gdalalg_raster_pipeline_reproject_invalid_bbox(tmp_vsimem):
out_filename = str(tmp_vsimem / "out.tif")
pipeline = get_pipeline_alg()
with pytest.raises(
Exception,
match="Value of 'extent' should be xmin,ymin,xmax,ymax with xmin <= xmax and ymin <= ymax",
match="Value of 'bbox' should be xmin,ymin,xmax,ymax with xmin <= xmax and ymin <= ymax",
):
pipeline.ParseRunAndFinalize(
[
@ -473,7 +473,7 @@ def test_gdalalg_raster_pipeline_reproject_invalid_extent(tmp_vsimem):
"../gcore/data/byte.tif",
"!",
"reproject",
"--extent=3,4,2,1",
"--bbox=3,4,2,1",
"!",
"write",
out_filename,
@ -481,7 +481,7 @@ def test_gdalalg_raster_pipeline_reproject_invalid_extent(tmp_vsimem):
)
def test_gdalalg_raster_pipeline_reproject_extent_arg(tmp_vsimem):
def test_gdalalg_raster_pipeline_reproject_bbox_arg(tmp_vsimem):
out_filename = str(tmp_vsimem / "out.tif")
@ -494,7 +494,7 @@ def test_gdalalg_raster_pipeline_reproject_extent_arg(tmp_vsimem):
"reproject",
"--src-crs=EPSG:32611",
"--dst-crs=EPSG:4326",
"--extent=-117.641,33.89,-117.628,33.9005",
"--bbox=-117.641,33.89,-117.628,33.9005",
"!",
"write",
"--overwrite",

12
doc/source/programs/gdal_raster_edit.rst
View File

@ -32,7 +32,7 @@ Synopsis
Options:
--crs <CRS> Override CRS (without reprojection)
--extent <EXTENT> Extent as xmin,ymin,xmax,ymax
--bbox <EXTENT> Bounding box as xmin,ymin,xmax,ymax
--metadata <KEY>=<VALUE> Add/update dataset metadata item [may be repeated]
--unset-metadata <KEY> Remove dataset metadata item [may be repeated]
@ -61,9 +61,11 @@ This subcommand is also available as a potential step of :ref:`gdal_raster_pipel
Note that the spatial extent is also left unchanged.
.. option:: --extent <xmin>,<ymin>,<xmax>,ymax>
.. option:: --bbox <xmin>,<ymin>,<xmax>,ymax>
Override the spatial extent, without reprojecting or subsetting.
Override the spatial bounding box, in CRS units, without reprojecting or subsetting.
'x' is longitude values for geographic CRS and easting for projected CRS.
'y' is latitude values for geographic CRS and northing for projected CRS.
.. option:: --metadata <KEY>=<VALUE>
@ -85,11 +87,11 @@ Examples
$ gdal raster edit --crs=EPSG:32632 my.tif
.. example::
:title: Override (without reprojecting or subsetting) the extent of a dataset
:title: Override (without reprojecting or subsetting) the bounding box of a dataset
.. code-block:: bash
$ gdal raster edit --extent=2,49,3,50 my.tif
$ gdal raster edit --bbox=2,49,3,50 my.tif
.. example::
:title: Add a metadata item

4
doc/source/programs/gdal_raster_pipeline.rst
View File

@ -57,7 +57,7 @@ Potential steps are:
Options:
--crs <CRS> Override CRS (without reprojection)
--extent <EXTENT> Extent as xmin,ymin,xmax,ymax
--bbox <EXTENT> Bounding box as xmin,ymin,xmax,ymax
--metadata <KEY>=<VALUE> Add/update dataset metadata item [may be repeated]
--unset-metadata <KEY> Remove dataset metadata item [may be repeated]
@ -74,7 +74,7 @@ Details for options can be found in :ref:`gdal_raster_edit_subcommand`.
-d, --dst-crs <DST-CRS> Destination CRS
-r, --resampling <RESAMPLING> Resampling method. RESAMPLING=near|bilinear|cubic|cubicspline|lanczos|average|rms|mode|min|max|med|q1|q3|sum
--resolution <xres>,<yres> Target resolution (in destination CRS units)
--extent <xmin>,<ymin>,<xmax>,<ymax> Target extent (in destination CRS units)
--bbox <xmin>,<ymin>,<xmax>,<ymax> Target bounding box (in destination CRS units)
--target-aligned-pixels Round target extent to target resolution
Details for options can be found in :ref:`gdal_raster_reproject_subcommand`.

2
doc/source/programs/gdal_raster_reproject.rst
View File

@ -40,7 +40,7 @@ Synopsis
-d, --dst-crs <DST-CRS> Destination CRS
-r, --resampling <RESAMPLING> Resampling method. RESAMPLING=near|bilinear|cubic|cubicspline|lanczos|average|rms|mode|min|max|med|q1|q3|sum
--resolution <xres>,<yres> Target resolution (in destination CRS units)
--extent <xmin>,<ymin>,<xmax>,<ymax> Target extent (in destination CRS units)
--bbox <xmin>,<ymin>,<xmax>,<ymax> Target bounding box (in destination CRS units)
--target-aligned-pixels Round target extent to target resolution
Advanced Options:

33
gcore/gdalalgorithm.cpp
View File

@ -2123,6 +2123,39 @@ GDALAlgorithm::AddLayerCreationOptionsArg(std::vector<std::string> *pValue)
return arg;
}
/************************************************************************/
/* GDALAlgorithm::AddBBOXArg() */
/************************************************************************/
/** Add bbox=xmin,ymin,xmax,ymax argument. */
GDALInConstructionAlgorithmArg &
GDALAlgorithm::AddBBOXArg(std::vector<double> *pValue, const char *helpMessage)
{
auto &arg = AddArg("bbox", 0,
helpMessage ? helpMessage
: _("Bounding box as xmin,ymin,xmax,ymax"),
pValue)
.SetRepeatedArgAllowed(false)
.SetMinCount(4)
.SetMaxCount(4)
.SetDisplayHintAboutRepetition(false);
arg.AddValidationAction(
[&arg]()
{
const auto &val = arg.Get<std::vector<double>>();
CPLAssert(val.size() == 4);
if (!(val[0] <= val[2]) || !(val[1] <= val[3]))
{
CPLError(CE_Failure, CPLE_AppDefined,
"Value of 'bbox' should be xmin,ymin,xmax,ymax with "
"xmin <= xmax and ymin <= ymax");
return false;
}
return true;
});
return arg;
}
/************************************************************************/
/* GDALAlgorithm::AddProgressArg() */
/************************************************************************/

4
gcore/gdalalgorithm.h
View File

@ -2064,6 +2064,10 @@ class CPL_DLL GDALAlgorithmRegistry
GDALInConstructionAlgorithmArg &
AddLayerNameArg(std::vector<std::string> *pValue);
/** Add bbox=xmin,ymin,xmax,ymax argument. */
GDALInConstructionAlgorithmArg &
AddBBOXArg(std::vector<double> *pValue, const char *helpMessage = nullptr);
/** Add --progress argument. */
GDALInConstructionAlgorithmArg &AddProgressArg();