Implemented raster::warp::reproject_into and raster::warp::create_and…

…_reproject.

CHANGES.md

@@ -21,6 +21,12 @@
 
 - Added `DriverManager::get_output_driver_for_dataset_name` and `DriverManager::get_output_drivers_for_dataset_name` for the ability to auto detect compatible `Driver`(s) for writing data.
   - <https://github.com/georust/gdal/pull/510>
+
+- **Breaking**: Moved `raster::processing::dem` to `raster::dem`
+- **Breaking**: Moved `raster::reproject` to `raster::warp::reproject_into` and added more options
+- Added `raster::warp::create_and_reproject_image`.
+
+  - <https://github.com/georust/gdal/pull/508>
 
 - Added `Feature::unset_field`
 

src/errors.rs

@@ -87,6 +87,8 @@ pub enum GdalError {
     IntConversionError(#[from] TryFromIntError),
     #[error("Buffer length {0} does not match raster size {1:?}")]
     BufferSizeMismatch(usize, (usize, usize)),
+    #[error("An unexpected logic error has occurred: {0}")]
+    UnexpectedLogicError(String),
 }
 
 /// A wrapper for [`CPLErr::Type`] that reflects it as an enum

src/lib.rs

@@ -124,6 +124,7 @@ mod utils;
 pub mod vector;
 pub mod version;
 pub mod vsi;
+pub mod xml;
 
 pub use dataset::Dataset;
 pub use geo_transform::{GeoTransform, GeoTransformEx};

src/raster/buffer.rs

@@ -6,6 +6,7 @@ use std::vec::IntoIter;
 #[cfg(feature = "ndarray")]
 use ndarray::Array2;
 
+#[cfg_attr(not(feature = "ndarray"), allow(rustdoc::broken_intra_doc_links))]
 /// `Buffer<T>` manages cell values in in raster I/O operations.
 ///
 /// It conceptually represents a 2-D array backed by a `Vec<T>` with row-major organization

src/raster/processing/dem/aspect.rs → src/raster/dem/aspect.rs

@@ -3,7 +3,7 @@ use std::num::NonZeroUsize;
 use super::options::{common_dem_options, CommonOptions};
 use crate::cpl::CslStringList;
 use crate::errors;
-use crate::raster::processing::dem::DemSlopeAlg;
+use crate::raster::dem::DemSlopeAlg;
 
 /// Configuration options for [`aspect()`][super::aspect()].
 #[derive(Debug, Clone, Default)]
@@ -71,7 +71,7 @@ mod tests {
     use crate::assert_near;
     use crate::cpl::CslStringList;
     use crate::errors::Result;
-    use crate::raster::processing::dem::aspect;
+    use crate::raster::dem::aspect;
     use crate::raster::StatisticsAll;
     use crate::test_utils::{fixture, InMemoryFixture};
     use crate::Dataset;

src/raster/processing/dem/color_relief.rs → src/raster/dem/color_relief.rs

@@ -3,7 +3,7 @@ use std::path::{Path, PathBuf};
 
 use crate::cpl::CslStringList;
 use crate::errors;
-use crate::raster::processing::dem::options::common_dem_options;
+use crate::raster::dem::options::common_dem_options;
 
 use super::options::CommonOptions;
 
@@ -125,7 +125,7 @@ mod tests {
     use crate::assert_near;
     use crate::cpl::CslStringList;
     use crate::errors::Result;
-    use crate::raster::processing::dem::color_relief;
+    use crate::raster::dem::color_relief;
     use crate::raster::StatisticsAll;
     use crate::test_utils::{fixture, InMemoryFixture};
     use crate::Dataset;

src/raster/processing/dem/hillshade.rs → src/raster/dem/hillshade.rs

@@ -2,8 +2,8 @@ use std::num::NonZeroUsize;
 
 use crate::cpl::CslStringList;
 use crate::errors;
-use crate::raster::processing::dem::options::common_dem_options;
-use crate::raster::processing::dem::DemSlopeAlg;
+use crate::raster::dem::options::common_dem_options;
+use crate::raster::dem::DemSlopeAlg;
 
 use super::options::CommonOptions;
 
@@ -160,7 +160,7 @@ mod tests {
     use crate::assert_near;
     use crate::cpl::CslStringList;
     use crate::errors::Result;
-    use crate::raster::processing::dem::hillshade;
+    use crate::raster::dem::hillshade;
     use crate::raster::StatisticsAll;
     use crate::test_utils::{fixture, InMemoryFixture};
     use crate::Dataset;

src/raster/processing/dem/mod.rs → src/raster/dem/mod.rs

@@ -75,7 +75,7 @@ mod tri;
 /// use gdal::Dataset;
 /// # fn main() -> gdal::errors::Result<()> {
 /// use std::path::Path;
-/// use gdal::raster::processing::dem::*;
+/// use gdal::raster::dem::*;
 /// let ds = Dataset::open("fixtures/dem-hills.tiff")?;
 /// let mut opts = AspectOptions::new();
 /// opts
@@ -135,7 +135,7 @@ pub fn aspect<P: AsRef<Path>>(
 /// use gdal::Dataset;
 /// # fn main() -> gdal::errors::Result<()> {
 /// use std::path::Path;
-/// use gdal::raster::processing::dem::*;
+/// use gdal::raster::dem::*;
 /// let ds = Dataset::open("fixtures/dem-hills.tiff")?;
 /// let mut opts = ColorReliefOptions::new("fixtures/color-relief.clr");
 /// opts.with_alpha(true);
@@ -189,7 +189,7 @@ pub fn color_relief<P: AsRef<Path>>(
 ///
 /// ```rust, no_run
 /// use gdal::Dataset;
-/// use gdal::raster::processing::dem::*;
+/// use gdal::raster::dem::*;
 /// # fn main() -> gdal::errors::Result<()> {
 /// use std::path::Path;
 /// let ds = Dataset::open("fixtures/dem-hills.tiff")?;
@@ -247,7 +247,7 @@ pub fn hillshade<P: AsRef<Path>>(
 /// # fn main() -> gdal::errors::Result<()> {
 /// use gdal::Dataset;
 /// use std::path::Path;
-/// use gdal::raster::processing::dem::*;
+/// use gdal::raster::dem::*;
 /// let ds = Dataset::open("fixtures/dem-hills.tiff")?;
 /// let roughness_ds = roughness(&ds, Path::new("target/dem-hills-roughness.tiff"), &RoughnessOptions::default())?;
 /// let stats = roughness_ds.rasterband(1)?.get_statistics(true, false)?.unwrap();
@@ -301,7 +301,7 @@ pub fn roughness<P: AsRef<Path>>(
 /// # fn main() -> gdal::errors::Result<()> {
 /// use std::path::Path;
 /// use gdal::Dataset;
-/// use gdal::raster::processing::dem::*;
+/// use gdal::raster::dem::*;
 /// let ds = Dataset::open("fixtures/dem-hills.tiff")?;
 /// let mut opts = SlopeOptions::new();
 /// opts
@@ -356,7 +356,7 @@ pub fn slope<P: AsRef<Path>>(
 /// # fn main() -> gdal::errors::Result<()> {
 /// use std::path::Path;
 /// use gdal::Dataset;
-/// use gdal::raster::processing::dem::*;
+/// use gdal::raster::dem::*;
 /// let ds = Dataset::open("fixtures/dem-hills.tiff")?;
 /// let tpi_ds = topographic_position_index(&ds, Path::new("target/dem-hills-tpi.tiff"), &TpiOptions::default())?;
 /// let stats = tpi_ds.rasterband(1)?.get_statistics(true, false)?.unwrap();
@@ -404,7 +404,7 @@ pub fn topographic_position_index<P: AsRef<Path>>(
 /// # fn main() -> gdal::errors::Result<()> {
 /// use std::path::Path;
 /// use gdal::Dataset;
-/// use gdal::raster::processing::dem::*;
+/// use gdal::raster::dem::*;
 /// let ds = Dataset::open("fixtures/dem-hills.tiff")?;
 /// let mut opts = TriOptions::new();
 /// opts.with_algorithm(DemTriAlg::Wilson);

src/raster/processing/dem/roughness.rs → src/raster/dem/roughness.rs

@@ -2,7 +2,7 @@ use std::num::NonZeroUsize;
 
 use crate::cpl::CslStringList;
 use crate::errors;
-use crate::raster::processing::dem::options::common_dem_options;
+use crate::raster::dem::options::common_dem_options;
 
 use super::options::CommonOptions;
 
@@ -35,8 +35,8 @@ mod tests {
     use crate::assert_near;
     use crate::cpl::CslStringList;
     use crate::errors::Result;
-    use crate::raster::processing::dem::roughness;
-    use crate::raster::processing::dem::roughness::RoughnessOptions;
+    use crate::raster::dem::roughness;
+    use crate::raster::dem::roughness::RoughnessOptions;
     use crate::raster::StatisticsAll;
     use crate::test_utils::{fixture, InMemoryFixture};
     use crate::Dataset;

src/raster/processing/dem/slope.rs → src/raster/dem/slope.rs

@@ -2,8 +2,8 @@ use std::num::NonZeroUsize;
 
 use crate::cpl::CslStringList;
 use crate::errors;
-use crate::raster::processing::dem::options::common_dem_options;
-use crate::raster::processing::dem::DemSlopeAlg;
+use crate::raster::dem::options::common_dem_options;
+use crate::raster::dem::DemSlopeAlg;
 
 use super::options::CommonOptions;
 
@@ -85,7 +85,7 @@ impl SlopeOptions {
 mod tests {
     use crate::cpl::CslStringList;
     use crate::errors::Result;
-    use crate::raster::processing::dem::slope;
+    use crate::raster::dem::slope;
     use crate::raster::StatisticsAll;
     use crate::test_utils::{fixture, InMemoryFixture};
     use crate::Dataset;

src/raster/processing/dem/tpi.rs → src/raster/dem/tpi.rs

@@ -2,7 +2,7 @@ use std::num::NonZeroUsize;
 
 use crate::cpl::CslStringList;
 use crate::errors;
-use crate::raster::processing::dem::options::common_dem_options;
+use crate::raster::dem::options::common_dem_options;
 
 use super::options::CommonOptions;
 
@@ -34,8 +34,8 @@ mod tests {
     use crate::assert_near;
     use crate::cpl::CslStringList;
     use crate::errors::Result;
-    use crate::raster::processing::dem::topographic_position_index;
-    use crate::raster::processing::dem::tpi::TpiOptions;
+    use crate::raster::dem::topographic_position_index;
+    use crate::raster::dem::tpi::TpiOptions;
     use crate::raster::StatisticsAll;
     use crate::test_utils::{fixture, InMemoryFixture};
     use crate::Dataset;

src/raster/processing/dem/tri.rs → src/raster/dem/tri.rs

@@ -2,7 +2,7 @@ use std::num::NonZeroUsize;
 
 use crate::cpl::CslStringList;
 use crate::errors;
-use crate::raster::processing::dem::options::common_dem_options;
+use crate::raster::dem::options::common_dem_options;
 
 use super::options::CommonOptions;
 
@@ -80,7 +80,7 @@ impl DemTriAlg {
 mod tests {
     use crate::assert_near;
     use crate::errors::Result;
-    use crate::raster::processing::dem::terrain_ruggedness_index;
+    use crate::raster::dem::terrain_ruggedness_index;
     use crate::raster::StatisticsAll;
     use crate::test_utils::{fixture, InMemoryFixture};
     use crate::Dataset;

src/raster/mod.rs

@@ -75,7 +75,6 @@
 //! ```
 
 pub use buffer::{Buffer, ByteBuffer};
-pub use create_options::RasterCreationOptions;
 #[cfg(all(major_ge_3, minor_ge_1))]
 pub use mdarray::{
     Attribute, Dimension, ExtendedDataType, ExtendedDataTypeClass, Group, MDArray, MdStatisticsAll,
@@ -86,16 +85,24 @@ pub use rasterband::{
 };
 pub use rasterize::{rasterize, BurnSource, MergeAlgorithm, OptimizeMode, RasterizeOptions};
 pub use types::{AdjustedValue, GdalDataType, GdalType};
-pub use warp::reproject;
 
 mod buffer;
-mod create_options;
+pub mod dem;
 #[cfg(all(major_ge_3, minor_ge_1))]
 mod mdarray;
-pub mod processing;
 mod rasterband;
 mod rasterize;
 #[cfg(test)]
 mod tests;
 mod types;
-mod warp;
+pub mod warp;
+
+/// Key/value pair for passing driver-specific creation options to
+/// [`Driver::create_with_band_type_wth_options`](crate::Driver::create_with_band_type_with_options`).
+///
+/// See `papszOptions` in [GDAL's `Create(...)` API documentation](https://gdal.org/api/gdaldriver_cpp.html#_CPPv4N10GDALDriver6CreateEPKciii12GDALDataType12CSLConstList).
+#[derive(Debug)]
+pub struct RasterCreationOption<'a> {
+    pub key: &'a str,
+    pub value: &'a str,
+}