proj4rb 4.1.1 → 5.0.0

data/lib/proj/pj_objects.rb

@@ -1,45 +1,45 @@
-# encoding: UTF-8
-module Proj
-  class PjObjects
-    # @!visibility private
-    def self.finalize(pointer)
-      proc do
-        Api.proj_list_destroy(pointer)
-      end
-    end
-
-    def initialize(pointer, context)
-      @pointer = pointer
-      @context = context
-      ObjectSpace.define_finalizer(self, self.class.finalize(@pointer))
-    end
-
-    def to_ptr
-      @pointer
-    end
-
-    def context
-      @context || Context.current
-    end
-
-    def count
-      Api.proj_list_get_count(self)
-    end
-    alias :size :count
-
-    def [](index)
-      ptr = Api.proj_list_get(context, self, index)
-      PjObject.create_object(ptr, self.context)
-    end
-
-    # Returns the index of the operation that would be the most appropriate to transform the specified coordinates.
-    #
-    # @param direction [PJ_DIRECTION] - Direction into which to transform the point.
-    # @param coord [Coordinate] - Coordinate to transform
-    #
-    # @return [Integer] - Index of operation
-    def suggested_operation(direction, coord)
-      Api.proj_get_suggested_operation(self.context, self, direction, coord)
-    end
-  end
-end
+# encoding: UTF-8
+module Proj
+  class PjObjects
+    # @!visibility private
+    def self.finalize(pointer)
+      proc do
+        Api.proj_list_destroy(pointer)
+      end
+    end
+
+    def initialize(pointer, context)
+      @pointer = pointer
+      @context = context
+      ObjectSpace.define_finalizer(self, self.class.finalize(@pointer))
+    end
+
+    def to_ptr
+      @pointer
+    end
+
+    def context
+      @context || Context.current
+    end
+
+    def count
+      Api.proj_list_get_count(self)
+    end
+    alias :size :count
+
+    def [](index)
+      ptr = Api.proj_list_get(context, self, index)
+      PjObject.create_object(ptr, self.context)
+    end
+
+    # Returns the index of the operation that would be the most appropriate to transform the specified coordinates.
+    #
+    # @param direction [PJ_DIRECTION] - Direction into which to transform the point.
+    # @param coord [Coordinate] - Coordinate to transform
+    #
+    # @return [Integer] - Index of operation
+    def suggested_operation(direction, coord)
+      Api.proj_get_suggested_operation(self.context, self, direction, coord)
+    end
+  end
+end

data/lib/proj/pj_param_description.rb

@@ -0,0 +1,28 @@
+module Proj
+  module Api
+    class PjParamDescription
+      attr_accessor :retained_ptrs
+
+      def self.create(name:, auth_name: nil, code: nil, value:, unit_name: nil, unit_conv_factor:, unit_type:)
+        result = PjParamDescription.new
+        result.retained_ptrs = []
+        result.put_string(:name, name)
+        result.put_string(:auth_name, auth_name)
+        result.put_string(:code, code)
+        result[:value] = value
+        result.put_string(:unit_name, unit_name)
+        result[:unit_conv_factor] = unit_conv_factor
+        result[:unit_type] = unit_type
+        result
+      end
+
+      # Write a string into a :string field and retain the pointer to prevent GC.
+      def put_string(field, value)
+        return if value.nil?
+        ptr = FFI::MemoryPointer.from_string(value)
+        @retained_ptrs << ptr
+        pointer.put_pointer(offset_of(field), ptr)
+      end
+    end
+  end
+end

data/lib/proj/prime_meridian.rb

@@ -1,66 +1,66 @@
-module Proj
-  class PrimeMeridian < PjObject
-    # Returns a list of Prime Meridians that are built into Proj. A more comprehensive
-    # list is stored in the Proj database and can be queried via PjObject#create_from_database
-    def self.built_in
-      pointer_to_array = FFI::Pointer.new(Api::PJ_PRIME_MERIDIANS, Api.proj_list_prime_meridians)
-      result = Array.new
-      0.step do |i|
-        prime_meridian_info = Api::PJ_PRIME_MERIDIANS.new(pointer_to_array[i])
-        break result if prime_meridian_info[:id].nil?
-        result << prime_meridian_info
-      end
-      result
-    end
-
-    # Returns prime meridian parameters
-    #
-    # @see https://proj.org/development/reference/functions.html#c.proj_prime_meridian_get_parameters
-    #
-    # @return [Hash] Hash of ellipsoid parameters. Axes are in meters
-    def parameters
-      @parameters ||= begin
-                        out_longitude = FFI::MemoryPointer.new(:double)
-                        out_unit_conv_factor = FFI::MemoryPointer.new(:double)
-                        out_unit_name = FFI::MemoryPointer.new(:string)
-
-                        result = Api.proj_prime_meridian_get_parameters(self.context, self, out_longitude, out_unit_conv_factor, out_unit_name)
-
-                        if result != 1
-                          Error.check_object(self)
-                        end
-
-                        {longitude: out_longitude.read_double,
-                         unit_conv_factor: out_unit_conv_factor.read_double,
-                         unit_name: out_unit_name.read_pointer.read_string_to_null}
-                      end
-    end
-
-    # Returns the longitude of the prime meridian in its native unit
-    #
-    # @see https://proj.org/development/reference/functions.html#c.proj_prime_meridian_get_parameters
-    #
-    # @return [Float]
-    def longitude
-      self.parameters[:longitude]
-    end
-
-    # Returns the conversion factor of the prime meridian longitude unit to radians
-    #
-    # @see https://proj.org/development/reference/functions.html#c.proj_prime_meridian_get_parameters
-    #
-    # @return [Float]
-    def unit_conv_factor
-      self.parameters[:unit_conv_factor]
-    end
-
-    # Returns the unit name
-    #
-    # @see https://proj.org/development/reference/functions.html#c.proj_prime_meridian_get_parameters
-    #
-    # @return [String ]
-    def unit_name
-      self.parameters[:unit_name]
-    end
-  end
+module Proj
+  class PrimeMeridian < PjObject
+    # Returns a list of Prime Meridians that are built into Proj. A more comprehensive
+    # list is stored in the Proj database and can be queried via PjObject#create_from_database
+    def self.built_in
+      pointer_to_array = FFI::Pointer.new(Api::PjPrimeMeridians, Api.proj_list_prime_meridians)
+      result = Array.new
+      0.step do |i|
+        prime_meridian_info = Api::PjPrimeMeridians.new(pointer_to_array[i])
+        break result if prime_meridian_info[:id].nil?
+        result << prime_meridian_info
+      end
+      result
+    end
+
+    # Returns prime meridian parameters
+    #
+    # @see https://proj.org/development/reference/functions.html#c.proj_prime_meridian_get_parameters
+    #
+    # @return [Hash] Hash of ellipsoid parameters. Axes are in meters
+    def parameters
+      @parameters ||= begin
+                        out_longitude = FFI::MemoryPointer.new(:double)
+                        out_unit_conv_factor = FFI::MemoryPointer.new(:double)
+                        out_unit_name = FFI::MemoryPointer.new(:string)
+
+                        result = Api.proj_prime_meridian_get_parameters(self.context, self, out_longitude, out_unit_conv_factor, out_unit_name)
+
+                        if result != 1
+                          Error.check_object(self)
+                        end
+
+                        {longitude: out_longitude.read_double,
+                         unit_conv_factor: out_unit_conv_factor.read_double,
+                         unit_name: out_unit_name.read_pointer.read_string_to_null}
+                      end
+    end
+
+    # Returns the longitude of the prime meridian in its native unit
+    #
+    # @see https://proj.org/development/reference/functions.html#c.proj_prime_meridian_get_parameters
+    #
+    # @return [Float]
+    def longitude
+      self.parameters[:longitude]
+    end
+
+    # Returns the conversion factor of the prime meridian longitude unit to radians
+    #
+    # @see https://proj.org/development/reference/functions.html#c.proj_prime_meridian_get_parameters
+    #
+    # @return [Float]
+    def unit_conv_factor
+      self.parameters[:unit_conv_factor]
+    end
+
+    # Returns the unit name
+    #
+    # @see https://proj.org/development/reference/functions.html#c.proj_prime_meridian_get_parameters
+    #
+    # @return [String ]
+    def unit_name
+      self.parameters[:unit_name]
+    end
+  end
 end

data/lib/proj/projection.rb

@@ -129,31 +129,6 @@ module Proj
       Conversion.create_object(ptr, context)
     end
 
-    # Create a new tunisia_mapping_grid projection
-    # 
-    # @see https://proj.org/operations/projections/index.html
-    # 
-    # @param context [Context] Proj Context
-    # @param center_latitude [Float] Latitude of natural origin/Center Latitude
-    # @param center_longitude [Float] Longitude of natural origin/Central Meridian
-    # @param false_easting [Float] False Easting. Default is 0.
-    # @param false_northing [Float] False Northing. Default is 0.
-    # @param angular_unit_name [String] Name of the angular units. Default is Degree.
-    # @param angular_unit_conversion_factor [Float] Conversion factor from angular unit to radians. Default is 0.0174532925199433.
-    # @param linear_unit_name [String] Name of the linear units. Default is Metre
-    # @param linear_unit_conversion_factor [Float] Conversion factor from linear unit to meters. Default is 1.
-    # 
-    # @return [Crs]
-    def self.tunisia_mapping_grid(context, center_latitude:, center_longitude:, false_easting: 0, false_northing: 0, angular_unit_name: "Degree", angular_unit_conversion_factor: 0.0174532925199433, linear_unit_name: "Metre", linear_unit_conversion_factor: 1)
-      ptr = Api.proj_create_conversion_tunisia_mapping_grid(context, center_latitude, center_longitude, false_easting, false_northing, angular_unit_name, angular_unit_conversion_factor, linear_unit_name, linear_unit_conversion_factor)
-
-      if ptr.null?
-        Error.check_context(context)
-      end
-
-      Conversion.create_object(ptr, context)
-    end
-
     # Create a new tunisia_mining_grid projection
     # 
     # @see https://proj.org/operations/projections/index.html
@@ -232,6 +207,33 @@ module Proj
       Conversion.create_object(ptr, context)
     end
 
+    # Create a new lambert_conic_conformal_1sp_variant_b projection
+    #
+    # @see https://proj.org/operations/projections/index.html
+    #
+    # @param context [Context] Proj Context
+    # @param latitude_nat_origin [Float] Latitude of natural origin
+    # @param scale [Float] Scale factor
+    # @param latitude_false_origin [Float] Latitude of false origin
+    # @param longitude_false_origin [Float] Longitude of false origin
+    # @param easting_false_origin [Float] Easting of false origin
+    # @param northing_false_origin [Float] Northing of false origin
+    # @param angular_unit_name [String] Name of the angular units. Default is Degree.
+    # @param angular_unit_conversion_factor [Float] Conversion factor from angular unit to radians. Default is 0.0174532925199433.
+    # @param linear_unit_name [String] Name of the linear units. Default is Metre
+    # @param linear_unit_conversion_factor [Float] Conversion factor from linear unit to meters. Default is 1.
+    #
+    # @return [Crs]
+    def self.lambert_conic_conformal_1sp_variant_b(context, latitude_nat_origin:, scale:, latitude_false_origin:, longitude_false_origin:, easting_false_origin:, northing_false_origin:, angular_unit_name: "Degree", angular_unit_conversion_factor: 0.0174532925199433, linear_unit_name: "Metre", linear_unit_conversion_factor: 1)
+      ptr = Api.proj_create_conversion_lambert_conic_conformal_1sp_variant_b(context, latitude_nat_origin, scale, latitude_false_origin, longitude_false_origin, easting_false_origin, northing_false_origin, angular_unit_name, angular_unit_conversion_factor, linear_unit_name, linear_unit_conversion_factor)
+
+      if ptr.null?
+        Error.check_context(context)
+      end
+
+      Conversion.create_object(ptr, context)
+    end
+
     # Create a new lambert_conic_conformal_2sp projection
     # 
     # @see https://proj.org/operations/projections/index.html
@@ -1738,5 +1740,32 @@ module Proj
 
       Conversion.create_object(ptr, context)
     end
+
+    # Create a new local_orthographic projection
+    #
+    # @see https://proj.org/operations/projections/index.html
+    #
+    # @param context [Context] Proj Context
+    # @param latitude_nat_origin [Float] Latitude of natural origin
+    # @param longitude_nat_origin [Float] Longitude of natural origin
+    # @param ellipsoidal_height [Float] Ellipsoidal height
+    # @param geocentric_x_origin [Float] Geocentric X origin
+    # @param geocentric_y_origin [Float] Geocentric Y origin
+    # @param geocentric_z_origin [Float] Geocentric Z origin
+    # @param angular_unit_name [String] Name of the angular units. Default is Degree.
+    # @param angular_unit_conversion_factor [Float] Conversion factor from angular unit to radians. Default is 0.0174532925199433.
+    # @param linear_unit_name [String] Name of the linear units. Default is Metre
+    # @param linear_unit_conversion_factor [Float] Conversion factor from linear unit to meters. Default is 1.
+    #
+    # @return [Crs]
+    def self.local_orthographic(context, latitude_nat_origin:, longitude_nat_origin:, ellipsoidal_height:, geocentric_x_origin:, geocentric_y_origin:, geocentric_z_origin:, angular_unit_name: "Degree", angular_unit_conversion_factor: 0.0174532925199433, linear_unit_name: "Metre", linear_unit_conversion_factor: 1)
+      ptr = Api.proj_create_conversion_local_orthographic(context, latitude_nat_origin, longitude_nat_origin, ellipsoidal_height, geocentric_x_origin, geocentric_y_origin, geocentric_z_origin, angular_unit_name, angular_unit_conversion_factor, linear_unit_name, linear_unit_conversion_factor)
+
+      if ptr.null?
+        Error.check_context(context)
+      end
+
+      Conversion.create_object(ptr, context)
+    end
   end
 end

data/lib/proj/session.rb

@@ -4,7 +4,9 @@ module Proj
 
     # @!visibility private
     def self.finalize(context, pointer)
+      life_span = context.life_span
       proc do
+        next unless life_span.alive?
         Api.proj_insert_object_session_destroy(context, pointer)
       end
     end

data/lib/proj/transformation.rb

@@ -1,102 +1,102 @@
-module Proj
-  # Transformations are {CoordinateOperationMixin coordinate operations} that
-  # convert {Coordinate coordinates} from one {Crs} to another.
-  # In Proj they are defined as operations that exert a change in reference frame
-  # while {Conversion conversions } do not.
-  class Transformation < PjObject
-    include CoordinateOperationMixin
-
-    # Create a Transformation
-    #
-    # @param context [Context] Context
-    # @param name [String] Name of the transformation. Default is nil.
-    # @param auth_name [String] Transformation authority name. Default is nil.
-    # @param code [String] Transformation code. Default is nil.
-    # @param source_crs [CoordinateSystem] Source CRS
-    # @param target_crs [CoordinateSystem] Target CRS
-    # @param interpolation_crs [CoordinateSystem] Interpolation. Default is nil
-    # @param method_name [String] Method name. Default is nil.
-    # @param method_auth_name [String] Method authority name. Default is nil.
-    # @param method_code [String] Method code. Default is nil.
-    # @param params [Array<Parameter>] Parameter descriptions
-    # @param accuracy [Float] Accuracy of the transformation in meters. A negative value means unknown.
-    #
-    # @return [Transformation]
-    def self.create(context, name: nil, auth_name: nil, code: nil,
-                    source_crs:, target_crs:, interpolation_crs: nil,
-                    method_name: nil, method_auth_name: nil, method_code: nil,
-                    params:, accuracy:)
-
-      params_ptr = FFI::MemoryPointer.new(Api::PJ_PARAM_DESCRIPTION, params.size)
-      params.each_with_index do |param, i|
-        param_description_target = Api::PJ_PARAM_DESCRIPTION.new(params_ptr[i])
-        param_description_source = param.to_description
-        param_description_target.to_ptr.__copy_from__(param_description_source.to_ptr, Api::PJ_PARAM_DESCRIPTION.size)
-      end
-
-      ptr = Api.proj_create_transformation(context, name, auth_name, code,
-                                           source_crs, target_crs, interpolation_crs,
-                                           method_name, method_auth_name, method_code,
-                                           params.count, params_ptr, accuracy)
-      self.create_object(ptr, context)
-    end
-
-    # Transforms a {Coordinate} from the source {Crs} to the target {Crs}. Coordinates should be expressed in
-    # the units and axis order of the definition of the source CRS. The returned transformed coordinate will
-    # be in the units and axis order of the definition of the target CRS.
-    #
-    # For most geographic Crses, the units will be in degrees. For geographic CRS defined by the EPSG authority,
-    # the order of coordinates is latitude first, longitude second. When using a PROJ initialization string,
-    # on contrary, the order will be longitude first, latitude second.
-    #
-    # For projected CRS, the units may vary (metre, us-foot, etc..).
-    #
-    # For projected CRS defined by the EPSG authority, and with EAST / NORTH directions, the axis order might be
-    # easting first, northing second, or the reverse. When using a PROJ string, the order will be
-    # easting first, northing second, except if the +axis parameter modifies it.
-    #
-    # @see https://proj.org/development/reference/functions.html#c.proj_create_crs_to_crs_from_pj
-    # @see  https://proj.org/development/reference/functions.html#c.proj_create_crs_to_crs proj_create_crs_to_crs
-    #
-    # @param source [Crs, String] The source Crs. See the Crs documentation for the string format
-    # @param target [Crs, String] The target Crs. See the Crs documentation for the string format
-    # @param area [Area] If an area is specified a more accurate transformation between two given systems can be chosen
-    # @param context [Context]
-    # @param authority [String] Restricts the authority of coordinate operations looked up in the database
-    # @param accuracy [Float] Sets the minimum desired accuracy (in metres) of the candidate coordinate operations
-    # @param allow_ballpark [Boolean] Set to false to disallow the use of Ballpark transformation in the candidate coordinate operations.
-    # @param only_best [Boolean] Set to true to cause PROJ to error out if the best transformation cannot be used. Requires Proj 9.2 and higher
-    #
-    # @return [Transformation] A new transformation
-    def initialize(source, target, context=nil,
-                   area: nil, authority: nil, accuracy: nil, allow_ballpark: nil, only_best: nil, force_over: nil)
-
-      context ||= Context.current
-
-      options = {"AUTHORITY": authority,
-                 "ACCURACY": accuracy.nil? ? nil : accuracy.to_s,
-                 "ALLOW_BALLPARK": allow_ballpark.nil? ? nil : (allow_ballpark ? "YES" : "NO"),
-                 "ONLY_BEST": only_best.nil? ? nil : (only_best ? "YES" : "NO"),
-                 "FORCE_OVER": force_over.nil? ? nil : (force_over ? "YES" : "NO")}
-      options_ptr = create_options_pointer(options)
-
-      ptr = if source.is_a?(Crs) && target.is_a?(Crs)
-              if Api.method_defined?(:proj_create_crs_to_crs_from_pj)
-                Api.proj_create_crs_to_crs_from_pj(context, source, target, area, options_ptr)
-              else
-                Api.proj_create_crs_to_crs(context, source.definition, target.definition, area)
-              end
-            else
-              Api.proj_create_crs_to_crs(context, source, target, nil)
-            end
-
-      if ptr.null?
-        Error.check_context(context)
-        # If that does not raise an error then no operation was found
-        raise(Error, "No operation found matching criteria")
-      end
-
-      super(ptr, context)
-    end
-  end
-end
+module Proj
+  # Transformations are {CoordinateOperationMixin coordinate operations} that
+  # convert {Coordinate coordinates} from one {Crs} to another.
+  # In Proj they are defined as operations that exert a change in reference frame
+  # while {Conversion conversions } do not.
+  class Transformation < PjObject
+    include CoordinateOperationMixin
+
+    # Create a Transformation
+    #
+    # @param context [Context] Context
+    # @param name [String] Name of the transformation. Default is nil.
+    # @param auth_name [String] Transformation authority name. Default is nil.
+    # @param code [String] Transformation code. Default is nil.
+    # @param source_crs [CoordinateSystem] Source CRS
+    # @param target_crs [CoordinateSystem] Target CRS
+    # @param interpolation_crs [CoordinateSystem] Interpolation. Default is nil
+    # @param method_name [String] Method name. Default is nil.
+    # @param method_auth_name [String] Method authority name. Default is nil.
+    # @param method_code [String] Method code. Default is nil.
+    # @param params [Array<Parameter>] Parameter descriptions
+    # @param accuracy [Float] Accuracy of the transformation in meters. A negative value means unknown.
+    #
+    # @return [Transformation]
+    def self.create(context, name: nil, auth_name: nil, code: nil,
+                    source_crs:, target_crs:, interpolation_crs: nil,
+                    method_name: nil, method_auth_name: nil, method_code: nil,
+                    params:, accuracy:)
+      Error.validate_context!(context)
+
+      params_ptr = FFI::MemoryPointer.new(Api::PjParamDescription, params.size)
+      params.each_with_index do |param, i|
+        param_description_target = Api::PjParamDescription.new(params_ptr[i])
+        param_description_source = param.to_description
+        param_description_target.to_ptr.__copy_from__(param_description_source.to_ptr, Api::PjParamDescription.size)
+      end
+
+      ptr = Api.proj_create_transformation(context, name, auth_name, code,
+                                           source_crs, target_crs, interpolation_crs,
+                                           method_name, method_auth_name, method_code,
+                                           params.count, params_ptr, accuracy)
+      self.create_object(ptr, context)
+    end
+
+    # Transforms a {Coordinate} from the source {Crs} to the target {Crs}. Coordinates should be expressed in
+    # the units and axis order of the definition of the source CRS. The returned transformed coordinate will
+    # be in the units and axis order of the definition of the target CRS.
+    #
+    # For most geographic Crses, the units will be in degrees. For geographic CRS defined by the EPSG authority,
+    # the order of coordinates is latitude first, longitude second. When using a PROJ initialization string,
+    # on contrary, the order will be longitude first, latitude second.
+    #
+    # For projected CRS, the units may vary (metre, us-foot, etc..).
+    #
+    # For projected CRS defined by the EPSG authority, and with EAST / NORTH directions, the axis order might be
+    # easting first, northing second, or the reverse. When using a PROJ string, the order will be
+    # easting first, northing second, except if the +axis parameter modifies it.
+    #
+    # @see https://proj.org/development/reference/functions.html#c.proj_create_crs_to_crs_from_pj
+    # @see  https://proj.org/development/reference/functions.html#c.proj_create_crs_to_crs proj_create_crs_to_crs
+    #
+    # @param source [Crs, String] The source Crs. See the Crs documentation for the string format
+    # @param target [Crs, String] The target Crs. See the Crs documentation for the string format
+    # @param area [Area] If an area is specified a more accurate transformation between two given systems can be chosen
+    # @param context [Context]
+    # @param authority [String] Restricts the authority of coordinate operations looked up in the database
+    # @param accuracy [Float] Sets the minimum desired accuracy (in metres) of the candidate coordinate operations
+    # @param allow_ballpark [Boolean] Set to false to disallow the use of Ballpark transformation in the candidate coordinate operations.
+    # @param only_best [Boolean] Set to true to cause PROJ to error out if the best transformation cannot be used. Requires Proj 9.2 and higher
+    #
+    # @return [Transformation] A new transformation
+    def initialize(source, target, context=nil,
+                   area: nil, authority: nil, accuracy: nil, allow_ballpark: nil, only_best: nil, force_over: nil)
+
+      context ||= Context.current
+
+      options = Options.new("AUTHORITY": authority,
+                            "ACCURACY": accuracy.nil? ? nil : accuracy.to_s,
+                            "ALLOW_BALLPARK": allow_ballpark.nil? ? nil : (allow_ballpark ? "YES" : "NO"),
+                            "ONLY_BEST": only_best.nil? ? nil : (only_best ? "YES" : "NO"),
+                            "FORCE_OVER": force_over.nil? ? nil : (force_over ? "YES" : "NO"))
+
+      ptr = if source.is_a?(Crs) && target.is_a?(Crs)
+              if Api.method_defined?(:proj_create_crs_to_crs_from_pj)
+                Api.proj_create_crs_to_crs_from_pj(context, source, target, area, options)
+              else
+                Api.proj_create_crs_to_crs(context, source.definition, target.definition, area)
+              end
+            else
+              Api.proj_create_crs_to_crs(context, source, target, nil)
+            end
+
+      if ptr.null?
+        Error.check_context(context)
+        # If that does not raise an error then no operation was found
+        raise(Error, "No operation found matching criteria")
+      end
+
+      super(ptr, context)
+    end
+  end
+end