ffi-gdal 0.0.4 → 1.0.0.beta1

data/lib/ffi-gdal/driver.rb

@@ -1,151 +0,0 @@
-require_relative '../ffi/gdal'
-require_relative 'major_object'
-require 'multi_xml'
-require 'log_switch'
-
-
-module GDAL
-  class Driver
-    include FFI::GDAL
-    include MajorObject
-    include LogSwitch::Mixin
-
-    GDAL_DOCS_URL = 'http://gdal.org'
-
-    # @return [Fixnum]
-    def self.driver_count
-      FFI::GDAL.GDALGetDriverCount
-    end
-
-    # @return [GDAL::Driver]
-    def self.by_name(name)
-      new(name: name)
-    end
-
-    # Creates a new GDAL::Driver object based on the mutually exclusive given
-    # parameters.  Pass in only one of the allowed parameters.
-    #
-    # @param file_path [String] File to get the driver for.
-    # @param name [String] Name of the registered GDALDriver.
-    # @param index [Fixnum] Index of the registered driver.  Must be less than
-    #   GDAL::Driver.driver_count.
-    # @param dataset [FFI::Pointer] Pointer to the GDALDataset.
-    def initialize(file_path: file_path, name: name, index: index, dataset: dataset)
-      @gdal_driver_handle = if file_path
-        GDALIdentifyDriver(::File.expand_path(file_path), nil)
-      elsif name
-        GDALGetDriverByName(name)
-      elsif index
-        count = self.class.driver_count
-        raise "index must be between 0 and #{count - 1}." if index > count
-
-        GDALGetDriver(index)
-      elsif dataset
-        GDALGetDatasetDriver(dataset)
-      end
-    end
-
-    def c_pointer
-      @gdal_driver_handle
-    end
-
-    # @return [String]
-    def short_name
-      return '' unless @gdal_driver_handle
-
-      GDALGetDriverShortName(@gdal_driver_handle)
-    end
-
-    # @return [String]
-    def long_name
-      return '' unless @gdal_driver_handle
-
-      GDALGetDriverLongName(@gdal_driver_handle)
-    end
-
-    # @return [String]
-    def help_topic
-      return '' unless @gdal_driver_handle
-
-      "#{GDAL_DOCS_URL}/#{GDALGetDriverHelpTopic(@gdal_driver_handle)}"
-    end
-
-    # Lists and describes the options that can be used when calling
-    # GDAL::Dataset.create or GDAL::Dataset.create_copy.
-    #
-    # @return [Array]
-    def creation_option_list
-      return [] unless @gdal_driver_handle
-
-      creation_option_list_xml = GDALGetDriverCreationOptionList(@gdal_driver_handle)
-      MultiXml.parse(creation_option_list_xml)['CreationOptionList']['Option']
-    end
-
-    # Copy all of the associated files of a dataset from one file to another.
-    #
-    # @param new_name [String]
-    # @param old_name [String]
-    # @return true on success, false on warning.
-    # @raise [GDAL::CPLErrFailure] If failures.
-    def copy_dataset_files(new_name, old_name)
-      cpl_err = GDALCopyDatasetFiles(@gdal_driver_handle, new_name, old_name)
-
-      cpl_err.to_bool
-    end
-
-    # Create a new Dataset with this driver.  Legal arguments depend on the
-    # driver and can't be retrieved programmatically.
-    #
-    # @param filename [String]
-    # @param x_size [Fixnum] Width of created raster in pixels.
-    # @param y_size [Fixnum] Height of created raster in pixels.
-    # @param bands [Fixnum]
-    # @param type [FFI::GDAL::GDALDataType]
-    # @return [GDAL::Dataset] Returns the *closed* dataset.  You'll need to
-    #   reopen it if you with to continue working with it.
-    # @todo Implement options.
-    def create_dataset(filename, x_size, y_size, bands: 1, type: :GDT_Byte, **options)
-      log "creating dataset with size #{x_size},#{y_size}"
-
-      dataset_pointer = GDALCreate(@gdal_driver_handle,
-        filename,
-        x_size,
-        y_size,
-        bands,
-        type,
-        nil
-      )
-
-      raise CreateFail if dataset_pointer.null?
-
-      dataset = Dataset.new(dataset_pointer)
-      yield(dataset) if block_given?
-      dataset.close
-
-      dataset
-    end
-
-    # Delete the dataset represented by +file_name+.  Depending on the driver,
-    # this could mean deleting associated files, database objects, etc.
-    #
-    # @param file_name [String]
-    # @return true on success, false on warning.
-    # @raise [GDAL::CPLErrFailure] If failures.
-    def delete_dataset(file_name)
-      cpl_err = GDALDeleteDataset(@gdal_driver_handle, file_name)
-
-      cpl_err.to_bool
-    end
-
-    # @param new_name [String]
-    # @param old_name [String]
-    # @return true on success, false on warning.
-    # @raise [GDAL::CPLErrFailure] If failures.
-    def rename_dataset(new_name, old_name)
-      cpl_err = GDALRenameDataset(@gdal_driver_handle, new_name, old_name)
-
-
-      cpl_err.to_bool
-    end
-  end
-end

data/lib/ffi-gdal/geo_transform.rb

@@ -1,137 +0,0 @@
-require_relative '../ffi/gdal'
-
-
-module GDAL
-  class GeoTransform
-    include FFI::GDAL
-
-    attr_accessor :gdal_dataset
-
-    # @param gdal_dataset [FFI::Pointer]
-    def initialize(dataset, geo_transform_pointer: nil)
-      @gdal_dataset = if dataset.nil?
-        FFI::MemoryPointer.new(:pointer)
-      elsif dataset.is_a? GDAL::Dataset
-        dataset.c_pointer
-      else
-        dataset
-      end
-
-      @gdal_geo_transform = if geo_transform_pointer
-        geo_transform_pointer
-      else
-        container_pointer = FFI::MemoryPointer.new(:double, 6)
-        GDALGetGeoTransform(@gdal_dataset, container_pointer).to_ruby
-        container_pointer
-      end
-
-      to_a
-    end
-
-    def c_pointer
-      @gdal_geo_transform
-    end
-
-    def null?
-      @gdal_geo_transform.null?
-    end
-
-    # All attributes as an Array, in the order:
-    #   * x_origin
-    #   * pixel_width
-    #   * x_rotation
-    #   * y_origin
-    #   * y_rotation
-    #   * pixel_height
-    #
-    # @return [Array]
-    def to_a
-      [
-        x_origin,
-        pixel_width,
-        x_rotation,
-        y_origin,
-        y_rotation,
-        pixel_height
-      ]
-    end
-
-    # X-coordinate of the center of the upper left pixel.
-    # In wikipedia's World Map definition, this is "C".
-    #
-    # @return [Float]
-    def x_origin
-      return nil if null?
-
-      @gdal_geo_transform[0].read_double
-    end
-
-    # AKA X-pixel size.
-    # In wikipedia's World Map definition, this is "A".
-    #
-    # @return [Float]
-    def pixel_width
-      return nil if null?
-
-      @gdal_geo_transform[1].read_double
-    end
-
-    # Rotation about the x-axis.
-    # In wikipedia's World Map definition, this is "B".
-    #
-    # @return [Float]
-    def x_rotation
-      return nil if null?
-
-      @gdal_geo_transform[2].read_double
-    end
-
-    # Y-coordinate of the center of the upper left pixel.
-    # In wikipedia's World Map definition, this is "F".
-    #
-    # @return [Float]
-    def y_origin
-      return nil if null?
-
-      @gdal_geo_transform[3].read_double
-    end
-
-    # Rotation about the y-axis.
-    # In wikipedia's World Map definition, this is "D".
-    #
-    # @return [Float]
-    def y_rotation
-      return nil if null?
-
-      @gdal_geo_transform[4].read_double
-    end
-
-    # AKA Y-pixel size.
-    # In wikipedia's World Map definition, this is "E".
-    #
-    # @return [Float]
-    def pixel_height
-      return nil if null?
-
-      @gdal_geo_transform[5].read_double
-    end
-
-    # The calculated UTM easting of the pixel on the map.
-    #
-    # @return [Float]
-    def x_projection(x_pixel, y_pixel)
-      return nil if null?
-
-      (pixel_width * x_pixel) + (x_rotation * y_pixel) + x_origin
-    end
-
-    # The calculated UTM northing of the pixel on the map.
-    #
-    # @return [Float]
-    def y_projection(x_pixel, y_pixel)
-      return nil if null?
-
-      (y_rotation * x_pixel) + (pixel_height * y_pixel) + y_origin
-    end
-  end
-end

data/lib/ffi-gdal/raster_attribute_table.rb

@@ -1,78 +0,0 @@
-require_relative '../ffi/gdal'
-
-
-module GDAL
-  class RasterAttributeTable
-    include FFI::GDAL
-
-    # @param raster_band [GDAL::RasterBand, FFI::Pointer]
-    # @param raster_attribute_table_pointer [FFI::Pointer]
-    def initialize(raster_band, raster_attribute_table_pointer: nil)
-      @raster_band = if raster_band.is_a? GDAL::RasterBand
-        raster_band.c_pointer
-      else
-        raster_band
-      end
-
-      @gdal_raster_attribute_table = if raster_attribute_table_pointer
-        raster_attribute_table_pointer
-      else
-        GDALGetDefaultRAT(@raster_band)
-      end
-    end
-
-    def c_pointer
-      @gdal_raster_attribute_table
-    end
-
-    # @param index [Fixnum] The column number.
-    # @return [Fixnum]
-    def column_count
-      GDALRATGetColumnCount(c_pointer)
-    end
-
-    # @param index [Fixnum] The column number.
-    # @return [String]
-    def columnn_name(index)
-      GDALRATGetNameOfCol(c_pointer, index)
-    end
-
-    # @param index [Fixnum] The column number.
-    # @return [GDALRATFieldUsage]
-    def column_usage(index)
-      GDALRATGetUsageOfCol(c_pointer, index)
-    end
-
-    # @param index [Fixnum] The column number.
-    # @return [GDALRATFieldType]
-    def column_type(index)
-      GDALRATGetTypeOfCol(c_pointer, index)
-    end
-
-    # @param field_usage [GDALRATFieldUsage]
-    # @return [Fixnum] The column number.
-    def column_of_usage(field_usage)
-      GDALRATGetColOfUsage(c_pointer, index)
-    end
-
-    # @param field_usage [GDALRATFieldUsage]
-    # @return [Fixnum] The column number.
-    def row_count
-      GDALRATGetRowCount(c_pointer)
-    end
-
-    # @param entry_count [Fixnum] The number of entries to produce.  The default
-    #   will try to auto-determine the number.
-    # @return [GDAL::ColorTable]
-    def to_color_table(entry_count = -1)
-      color_table_pointer = GDALRATTranslateToColorTable(c_pointer, entry_count)
-
-      GDAL::ColorTable.new(@raster_band, color_table_pointer: color_table_pointer)
-    end
-
-    # @param file_path [String]
-    def dump_readable(file_path = 'stdout')
-      GDALRATDumpReadable(c_pointer, file_path)
-    end
-  end
-end

data/lib/ffi/gdal/ogr_api.rb

@@ -1,21 +0,0 @@
-module FFI
-  module GDAL
-
-    #------------------------------------------------------------------------
-    # Typedefs
-    #------------------------------------------------------------------------
-    typedef :pointer, :OGRGeometryH
-    typedef :pointer, :OGRSpatialReferenceH
-    typedef :pointer, :OGRCoordinateTransformationH
-    typedef :pointer, :OGRFieldDefnH
-    typedef :pointer, :OGRFeatureDefnH
-    typedef :pointer, :OGRFeatureH
-    typedef :pointer, :OGRStyleTableH
-    typedef :pointer, :OGRGeomFieldDefnH
-    typedef :pointer, :OGRLayerH
-    typedef :pointer, :OGRDataSourceH
-    typedef :pointer, :OGRSFDriverH
-    typedef :pointer, :OGRStyleMgrH
-    typedef :pointer, :OGRStyleToolH
-  end
-end

data/lib/ffi/gdal/ogr_core.rb

@@ -1,195 +0,0 @@
-module FFI
-  module GDAL
-
-    #------------------------------------------------------------------------
-    # Defines
-    #------------------------------------------------------------------------
-    OGRERR_NONE                       = 0
-    OGRERR_NOT_ENOUGH_DATA            = 1
-    OGRERR_NOT_ENOUGH_MEMORY          = 2
-    OGRERR_UNSUPPORTED_GEOMETRY_TYPE  = 3
-    OGRERR_UNSUPPORTED_OPERATION      = 4
-    OGRERR_CORRUPT_DATA               = 5
-    OGRERR_FAILURE                    = 6
-    OGRERR_UNSUPPORTED_SRS            = 7
-    OGRERR_INVALID_HANDLE             = 8
-
-    WKB_25D_BIT = 0x80000000
-    #WKB_FLATTEN
-    OGR_Z_MARKER = 0x21125711
-
-    ALTER_NAME_FLAG = 0x1
-    ALTER_TYPE_FLAG = 0x2
-    ALTER_WIDTH_PRECISION_FLAG = 0x4
-    ALTER_ALL_FLAG =
-      ALTER_NAME_FLAG | ALTER_TYPE_FLAG | ALTER_WIDTH_PRECISION_FLAG
-
-    OGRNullFID = -1
-    OGRUnsetMarker = -21121
-    OLCRandomRead = 'RandomRead'
-    OLCSequentialWrite = 'SequentialWrite'
-    OLCRandomeWrite = 'RandomWrite'
-    OLCFastSpatialFilter = 'FastSpatialFilter'
-    OLCFastFeatureCount = 'FastFeatureCount'
-    OLCFastGetExtent = 'FastGetExtent'
-    OLCCreateField = 'CreateField'
-    OLCDeleteField = 'DeleteField'
-    OLCReorderFields = 'ReorderFields'
-    OLCAlterFieldDefn = 'AlterFieldDefn'
-    OLCTransactions = 'Transactions'
-    OLCDeleteFeature = 'DeleteFeature'
-    OLCFastSetNextByIndex = 'FastSetNextByIndex'
-    OLCStringsAsUTF8 = 'StringsAsUTF8'
-    OLCIgnoreFields = 'IgnoreFields'
-    OLCCreateGeomField = 'CreateGeomField'
-
-    ODsCCreateLayer = 'CreateLayer'
-    ODsCDeleteLayer = 'DeleteLayer'
-    ODsCCreateGeomFieldAfterCreateLayer = 'CreateGeomFieldAfterCreateLayer'
-
-    ODrCCreateDataSource = 'CreateDataSource'
-    ODrCDeleteDataSource = 'DeleteDataSource'
-
-    #------------------------------------------------------------------------
-    # Enums
-    #------------------------------------------------------------------------
-    OGRwkbGeometryType = enum :wkb_unknown, 0,
-      :wkb_point,                   1,
-      :wkb_line_string,             2,
-      :wkb_polygon,                 3,
-      :wkb_multi_point,             4,
-      :wkb_multi_line_string,       5,
-      :wkb_mulit_polygon,           6,
-      :wkb_geometry_collection,     7,
-      :wkb_none,                    100,
-      :wkb_linear_ring,             101,
-      :wkb_point_25d,               0x80000001,
-      :wkb_line_string_25d,         0x80000002,
-      :wkb_polygon_25d,             0x80000003,
-      :wkb_multi_point_25d,         0x80000004,
-      :wkb_multi_line_string_25d,   0x80000005,
-      :wkb_multi_polygon_25d,       0x80000006,
-      :wkb_geometry_collection_25d, 0x80000007
-
-    OGRwkbVariant = enum :wkb_variant_ogc, :wkb_variant_iso
-    OGRwkbByteOrder = enum :wkb_xdr, 0,
-      :wkb_ndr, 1
-
-    OGRFieldType = enum :oft_integer, 0,
-      :oft_integer_list,      1,
-      :oft_real,              2,
-      :oft_real_list,         3,
-      :oft_string,            4,
-      :oft_string_list,       5,
-      :oft_wide_string,       6,
-      :oft_wide_string_list,  7,
-      :oft_binary,            8,
-      :oft_date,              9,
-      :oft_time,              10,
-      :oft_date_time,         11,
-      :oft_max_type,          11
-
-    OGRJustification = enum :oj_undefined, 0,
-      :oj_left,   1,
-      :oj_right,  2
-
-    OGRStyleToolClassID = enum :ogr_stc_none, 0,
-      :ogr_stc_pen,     1,
-      :ogr_stc_brush,   2,
-      :ogr_stc_symbol,  3,
-      :ogr_stc_label,   4,
-      :ogr_stc_vector,  5
-
-    OGRStyleToolUnitsID = enum :ogr_stu_ground, 0,
-      :ogr_stu_pixel,   1,
-      :ogr_stu_points,  2,
-      :ogr_stu_mm,      3,
-      :ogr_stu_cm,      4,
-      :ogr_stu_inches,  5
-
-    OGRStyleToolParamPenID = enum :ogr_st_pen_color, 0,
-      :ogr_st_pen_width,        1,
-      :ogr_st_pen_pattern,      2,
-      :ogr_st_pen_id,           3,
-      :ogr_st_pen_per_offset,   4,
-      :ogr_st_pen_per_cap,      5,
-      :ogr_st_pen_per_join,     6,
-      :ogr_st_pen_per_priority, 7,
-      :ogr_st_pen_last,         8
-
-    OGRStyleToolParamBrushID = enum :ogr_st_brush_f_color, 0,
-      :ogr_st_brush_b_color,  1,
-      :ogr_st_brush_id,       2,
-      :ogr_st_brush_angle,    3,
-      :ogr_st_brush_size,     4,
-      :ogr_st_brush_dx,       5,
-      :ogr_st_brush_dry,      6,
-      :ogr_st_brush_priority, 7,
-      :ogr_st_brush_last,     8
-
-    OGRStyleToolParamSymbolID = enum :ogr_st_symbol_id, 0,
-      :ogr_st_symbol_angle,     1,
-      :ogr_st_symbol_color,     2,
-      :ogr_st_symbol_size,      3,
-      :ogr_st_symbol_dx,        4,
-      :ogr_st_symbol_dy,        5,
-      :ogr_st_symbol_step,      6,
-      :ogr_st_symbol_perp,      7,
-      :ogr_st_symbol_offset,    8,
-      :ogr_st_symbol_priority,  9,
-      :ogr_st_symbol_font_name, 10,
-      :ogr_st_symbol_o_color,   11,
-      :ogr_st_symbol_last,      12
-
-    OGRStyleToolParamLabelID = enum :ogr_st_label_font_name, 0,
-      :ogr_st_label_size,         1,
-      :ogr_st_label_text_string,  2,
-      :ogr_st_label_angle,        3,
-      :ogr_st_label_f_color,      4,
-      :ogr_st_label_b_color,      5,
-      :ogr_st_label_placement,    6,
-      :ogr_st_label_anchor,       7,
-      :ogr_st_label_dx,           8,
-      :ogr_st_label_dy,           9,
-      :ogr_st_label_perp,         10,
-      :ogr_st_label_bold,         11,
-      :ogr_st_label_italic,       12,
-      :ogr_st_label_underline,    13,
-      :ogr_st_label_priority,     14,
-      :ogr_st_label_strikeout,    15,
-      :ogr_st_label_stretch,      16,
-      :ogr_st_label_adj_hor,      17,
-      :ogr_st_label_adj_vert,     18,
-      :ogr_st_label_h_color,      19,
-      :ogr_st_label_o_color,      20,
-      :ogr_st_label_last,         21
-
-    #------------------------------------------------------------------------
-    # Typedefs
-    #------------------------------------------------------------------------
-    typedef :int, :OGRErr
-    typedef :int, :OGRBoolean
-    typedef OGRStyleToolClassID, :OGRSTClassId
-    typedef OGRStyleToolUnitsID, :OGRSTUnitId
-    typedef OGRStyleToolParamPenID, :OGRSTPenParam
-    typedef OGRStyleToolParamBrushID, :OGRSTBrushParam
-    typedef OGRStyleToolParamSymbolID, :OGRSTSymbolParam
-    typedef OGRStyleToolParamLabelID, :OGRSTLabelParam
-
-    #------------------------------------------------------------------------
-    # Functions
-    #------------------------------------------------------------------------
-    attach_function :OGRMalloc, [:size_t], :pointer
-    attach_function :OGRCalloc, [:size_t, :size_t], :pointer
-    attach_function :OGRRealloc, [:pointer, :size_t], :pointer
-    #attach_function :OGRStrdup, [:string], :string
-    attach_function :OGRFree, [:pointer], :void
-    attach_function :OGRGeometryTypeToName, [OGRwkbGeometryType], :string
-    attach_function :OGRMergeGeometryTypes,
-      [OGRwkbGeometryType, OGRwkbGeometryType],
-      OGRwkbGeometryType
-    attach_function :OGRParseDate, [:string, :pointer, :int], :int
-    attach_function :GDALVersionInfo, [:string], :string
-    attach_function :GDALCheckVersion, [:int, :int, :string], :int
-  end
-end