ffi-gdal 1.0.0.beta6 → 1.0.0.beta11

data/lib/gdal/dataset_mixins/matching.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GDAL
   module DatasetMixins
     module Matching
@@ -15,7 +17,8 @@ module GDAL
           @c_pointer,
           other_dataset_ptr,
           options_ptr,
-          gcp_count_ptr)
+          gcp_count_ptr
+        )
 
         { count: gcp_count_ptr.read_int, gcp: gcp }
       end

data/lib/gdal/dataset_mixins/warp_methods.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module GDAL
   module DatasetMixins
     # Methods used for warping; most taken from gdalwarper.h.
     module WarpMethods
       # @param destination_dataset [GDAL::Dataset]
       # @param resample_algorithm [Symbol] One from FFI::GDAL::Warper::GDALResampleAlg.
-      # @param destination_spatial_reference [OGR::SpatialReference]
+      # @param destination_projection [String]
       # @param warp_memory_limit [Float] The amount of memory (in bytes) the API
       #   is allowed to use for caching. This is in addition to the amount of
       #   memory already allocated for caching (using GDALSetCacheMax). 0.0 uses
@@ -15,26 +17,65 @@ module GDAL
       #   callback for reporting progress.
       # @param progress_arg [FFI::Pointer] Argument to be passed to
       #   +progress_function+.
-      # @param options [Hash] Warp options, normally empty.
-      def reproject_image(destination_dataset, resample_algorithm, destination_spatial_reference: nil,
-        warp_memory_limit: 0.0, max_error: 0.0, progress_function: nil, progress_arg: nil, **options)
-        destination_spatial_reference_wkt = if destination_spatial_reference
-                                              destination_spatial_reference.to_wkt
-                                            end
-
-        options_ptr = GDAL::Options.pointer(options)
+      # @param warp_options [GDAL::WarpOptions] Warp options, normally empty.
+      def reproject_image(destination_dataset, resample_algorithm, destination_projection: nil,
+        warp_memory_limit: 0.0, max_error: 0.0, progress_function: nil, progress_arg: nil, warp_options: nil)
+        warp_options_struct = warp_options ? warp_options.c_struct : nil
 
         FFI::GDAL::Warper.GDALReprojectImage(
           @c_pointer,                           # hSrcDS
           nil,                                  # pszSrcWKT
           destination_dataset.c_pointer,        # hDstDS
-          destination_spatial_reference_wkt,    # pszDstWKT
+          destination_projection,               # pszDstWKT
+          resample_algorithm,                   # eResampleAlg
+          warp_memory_limit,                    # dfWarpMemoryLimit
+          max_error,                            # dfMaxError
+          progress_function,                    # pfnProgress
+          progress_arg,                         # pProgressArg
+          warp_options_struct                   # psOptions
+        )
+      end
+
+      # @param destination_file_name [String] Path to the output dataset.
+      # @param resample_algorithm [Symbol] One from FFI::GDAL::Warper::GDALResampleAlg.
+      # @param destination_projection [String] WKT of the projection to
+      #   be used for the destination dataset.
+      # @param destination_driver [GDAL::Driver] Driver to use for the
+      #   destination dataset.
+      # @param creation_options [Hash] Driver-specific options to use during
+      #   creation.
+      # @param warp_memory_limit [Float] The amount of memory (in bytes) the API
+      #   is allowed to use for caching. This is in addition to the amount of
+      #   memory already allocated for caching (using GDALSetCacheMax). 0.0 uses
+      #   default settings.
+      # @param max_error [Float] Maximum error, measured in input pixels that is
+      #   allowed in approximating the transformation. Defaults to 0.0.
+      # @param progress_function [Proc, FFI::GDAL::GDAL::GDALProgressFunc] A
+      #   callback for reporting progress.
+      # @param progress_arg [FFI::Pointer] Argument to be passed to
+      #   +progress_function+.
+      # @param warp_options [GDAL::WarpOptions] Warp options, normally empty.
+      def create_and_reproject_image(destination_file_name, resample_algorithm, destination_projection,
+        destination_driver, creation_options: {},
+        warp_memory_limit: 0.0, max_error: 0.0,
+        progress_function: nil, progress_arg: nil,
+        warp_options: nil)
+        creation_options_ptr = GDAL::Options.pointer(creation_options)
+        warp_options_struct = warp_options ? warp_options.c_struct : nil
+
+        FFI::GDAL::Warper.GDALCreateAndReprojectImage(
+          @c_pointer,                           # hSrcDS
+          nil,                                  # pszSrcWKT
+          destination_file_name,                # pszDstFilename
+          destination_projection,               # pszDstWKT
+          destination_driver.c_pointer,         # hDstDriver
+          creation_options_ptr,                 # papszCreateOptions
           resample_algorithm,                   # eResampleAlg
           warp_memory_limit,                    # dfWarpMemoryLimit
           max_error,                            # dfMaxError
           progress_function,                    # pfnProgress
           progress_arg,                         # pProgressArg
-          options_ptr                           # psOptions
+          warp_options_struct                   # psOptions
         )
       end
     end

data/lib/gdal/driver.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'multi_xml'
 require_relative '../gdal'
 require_relative 'major_object'
@@ -11,7 +13,7 @@ module GDAL
     include GDAL::Logger
     include DriverMixins::Extensions
 
-    GDAL_DOCS_URL = 'http://gdal.org'.freeze
+    GDAL_DOCS_URL = 'http://gdal.org'
 
     # @return [Fixnum]
     def self.count
@@ -25,9 +27,7 @@ module GDAL
     def self.by_name(name)
       driver_ptr = FFI::GDAL::GDAL.GDALGetDriverByName(name)
 
-      if driver_ptr.null?
-        raise InvalidDriverName, "'#{name}' is not a valid driver name."
-      end
+      raise InvalidDriverName, "'#{name}' is not a valid driver name." if driver_ptr.null?
 
       new(driver_ptr)
     end
@@ -37,9 +37,7 @@ module GDAL
     # @return [GDAL::Driver]
     # @raise [GDAL::InvalidDriverIndex] If driver at +index+ does not exist.
     def self.at_index(index)
-      if index > count
-        raise InvalidDriverIndex, "index must be between 0 and #{count - 1}."
-      end
+      raise InvalidDriverIndex, "index must be between 0 and #{count - 1}." if index > count
 
       driver_ptr = FFI::GDAL::GDAL.GDALGetDriver(index)
 
@@ -174,7 +172,7 @@ module GDAL
     def copy_dataset(source_dataset, destination_path, progress_block = nil, progress_arg = nil, strict: true,
       **options)
       source_dataset_ptr = make_dataset_pointer(source_dataset)
-      raise GDAL::OpenFailure, "Source dataset couldn't be read" if source_dataset_ptr && source_dataset_ptr.null?
+      raise GDAL::OpenFailure, "Source dataset couldn't be read" if source_dataset_ptr&.null?
 
       options_ptr = GDAL::Options.pointer(options)
 

data/lib/gdal/driver_mixins/extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GDAL
   module DriverMixins
     module Extensions

data/lib/gdal/environment_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GDAL
   # Getters and setters for the GDAL environment.
   module EnvironmentMethods

data/lib/gdal/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GDAL
   class BufferTooSmall < StandardError
   end

data/lib/gdal/geo_transform.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../gdal'
 require_relative 'geo_transform_mixins/extensions'
 
@@ -168,9 +170,7 @@ module GDAL
     def compose(other_geo_transform)
       other_ptr = GDAL._pointer(GDAL::GeoTransform, other_geo_transform)
 
-      unless other_ptr
-        raise GDAL::NullObject, "Unable to access pointer for '#{other_geo_transform}'"
-      end
+      raise GDAL::NullObject, "Unable to access pointer for '#{other_geo_transform}'" unless other_ptr
 
       new_gt_ptr = self.class.new_pointer
       FFI::GDAL::GDAL.GDALComposeGeoTransforms(@c_pointer, other_ptr, new_gt_ptr)

data/lib/gdal/geo_transform_mixins/extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require_relative '../exceptions'
 
@@ -90,23 +92,6 @@ module GDAL
           pixel_height
         ]
       end
-
-      # @return [Hash]
-      def as_json(_options = nil)
-        {
-          x_origin: x_origin,
-          x_rotation: x_rotation,
-          pixel_width: pixel_width,
-          y_origin: y_origin,
-          y_rotation: y_rotation,
-          pixel_height: pixel_height
-        }
-      end
-
-      # @return [String]
-      def to_json(options = nil)
-        as_json(options).to_json
-      end
     end
   end
 end

data/lib/gdal/grid.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'narray'
 require_relative '../gdal'
@@ -36,8 +38,9 @@ module GDAL
       points = points.to_a if points.is_a? NArray
       point_count = points.length
       log "Number of points: #{point_count}"
-      points = points.transpose
+      raise GDAL::NoValuesToGrid, 'No points to grid' if point_count.zero?
 
+      points = points.transpose
       x_input_coordinates_ptr = make_points_pointer(points[0])
       y_input_coordinates_ptr = make_points_pointer(points[1])
       z_input_coordinates_ptr = make_points_pointer(points[2])

data/lib/gdal/grid_algorithms.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GDAL
   module GridAlgorithms
     autoload :InverseDistanceToAPower,

data/lib/gdal/grid_algorithms/data_metrics_base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GDAL
   module GridAlgorithms
     class DataMetricsBase

data/lib/gdal/grid_algorithms/inverse_distance_to_a_power.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GDAL
   module GridAlgorithms
     class InverseDistanceToAPower

data/lib/gdal/grid_algorithms/metric_average_distance.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'data_metrics_base'
 
 module GDAL

data/lib/gdal/grid_algorithms/metric_average_distance_pts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'data_metrics_base'
 
 module GDAL

data/lib/gdal/grid_algorithms/metric_count.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'data_metrics_base'
 
 module GDAL

data/lib/gdal/grid_algorithms/metric_maximum.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'data_metrics_base'
 
 module GDAL

data/lib/gdal/grid_algorithms/metric_minimum.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'data_metrics_base'
 
 module GDAL

data/lib/gdal/grid_algorithms/metric_range.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'data_metrics_base'
 
 module GDAL

data/lib/gdal/grid_algorithms/moving_average.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GDAL
   module GridAlgorithms
     class MovingAverage

data/lib/gdal/grid_algorithms/nearest_neighbor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GDAL
   module GridAlgorithms
     class NearestNeighbor

data/lib/gdal/gridder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'narray'
 require_relative '../gdal'
 require_relative 'gridder_options'
@@ -249,7 +251,8 @@ module GDAL
         block_number.to_f / block_count,
         (block_number + 1).to_f / block_count,
         @options.progress_formatter,
-        nil)
+        nil
+      )
     end
 
     # Determines how large of a chunk of data to grid and rasterize.
@@ -287,8 +290,13 @@ module GDAL
     # @return [Fixnum] The total number of blocks that should be iterated
     #   through during the grid+rasterize process.
     def build_block_count(block_x_size, block_y_size, raster_width, raster_height)
-      ((raster_width + block_x_size - 1) / block_x_size) *
-        ((raster_height + block_y_size - 1) / block_y_size)
+      build_block_size(raster_width, block_x_size) * build_block_size(raster_height, block_y_size)
+    end
+
+    # @param total_pixels [Fixnum] Number of pixels in the width or height.
+    # @param block_size [Fixnum] Size of the reported block.
+    def build_block_size(total_pixels, block_size)
+      (total_pixels + block_size - 1) / block_size
     end
   end
 end

data/lib/gdal/gridder/point_extracting.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GDAL
   class Gridder
     # Methods used for extracting points from a OGR::Layer. Only used when
@@ -39,8 +41,7 @@ module GDAL
       #   set and the layer has no Z values.
       def ensure_z_values
         if layer_missing_specified_field?
-          raise OGR::InvalidFieldName,
-            "Field name not found in layer: '#{@options.input_field_name}'"
+          raise OGR::InvalidFieldName, "Field name not found in layer: '#{@options.input_field_name}'"
         elsif !@options.input_field_name && !@source_layer.any_geometries_with_z?
           raise GDAL::NoValuesToGrid,
             "No input_field_name option given and source layer #{@source_layer.name} has no Z values."

data/lib/gdal/gridder_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'grid'
 require_relative 'options'
 require_relative '../ogr'

data/lib/gdal/internal_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GDAL
   # @private
   module InternalHelpers
@@ -64,10 +66,7 @@ module GDAL
       # @param strings [Array<String>]
       # @return [FFI::MemoryPointer]
       def _string_array_to_pointer(strings)
-        string_pointers = strings.map do |string|
-          FFI::MemoryPointer.from_string(string.to_s)
-        end
-
+        string_pointers = strings.map { |string| FFI::MemoryPointer.from_string(string.to_s) }
         string_pointers << nil
         array_pointer = FFI::MemoryPointer.new(:pointer, strings.size + 1)
         i = 0

data/lib/gdal/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'log_switch'
 
 module GDAL

data/lib/gdal/major_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../gdal'
 require 'multi_xml'
 

data/lib/gdal/merger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'driver'
 
 module GDAL

data/lib/gdal/options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ffi'
 
 module GDAL
@@ -11,10 +13,20 @@ module GDAL
     #   +nil+.  If +false+, creates a 0-size pointer.
     # @return [FFI::MemoryPointer, nil]
     def self.pointer(hash, nil_on_empty: true)
-      if nil_on_empty
-        hash.empty? ? nil : new(hash).c_pointer
-      else
-        new(hash).c_pointer
+      return if nil_on_empty && hash.empty?
+
+      new(hash).c_pointer
+    end
+
+    # Takes a GDAL options pointer and turns it into a Ruby Hash.
+    #
+    # @param pointer [FFI::Pointer]
+    # @return [Hash]
+    def self.to_hash(pointer)
+      FFI::CPL::String.CSLCount(pointer).times.each_with_object({}) do |i, o|
+        key_and_value = FFI::CPL::String.CSLGetField(pointer, i)
+        key, value = key_and_value.split('=')
+        o[key.downcase.to_sym] = value
       end
     end
 
@@ -37,15 +49,6 @@ module GDAL
       options_ptr
     end
 
-    # def to_s
-    #   options_ptr = to_gdal
-    #   options_array = options_ptr.read_array_of_pointer(self.size)
-    #
-    #   0.upto(self.size).map do |i|
-    #     options_array[i].first.read_string
-    #   end
-    # end
-
     private
 
     def capitalize_keys!(hash)