Merge branch 'lensfun'

Author: kipcole9

CHANGELOG.md

@@ -2,19 +2,17 @@
 
 ## Image 0.59.0
 
-This is the changelog for Image version 0.59.0 released on March 13th, 2025.  For older changelogs please consult the release tag on [GitHub](https://github.com/elixir-image/image/tags)
+This is the changelog for Image version 0.59.0 released on March 14th, 2025.  For older changelogs please consult the release tag on [GitHub](https://github.com/elixir-image/image/tags)
 
 ### Breaking Change
 
-* Rename `Image.barrel_correction/5` to `Image.radial_distortion_correction/5` since it applies to both barrel and pincushion distortion.
+* `Image.radial_distortion_correction/5` and `Image.vignette_correction/4` have moved to a new library [image_lens_correction](https://github.com/elixir-image/image_lens_correction).
 
 ### Enhancements
 
 * Tolerate non-compliant null-terminated datatime strings in Exif. Thanks to @hansihe for the PR. Closes #181.
 
-* Add `Image.vignette_correct/4` to apply a vignette correction to an image - typically a digital photograph.
-
-* Add `Image.Math.max/1`, `Image.Math.min/1`, `Image.Math.max!/1` and `Image.Math.min!/1`
+* Add `Image.Math.max/1`, `Image.Math.min/1`, `Image.Math.max!/1`, `Image.Math.min!/1` and `Image.Complex.polar/1`.
 
 ## Image 0.58.0
 

lib/image.ex

@@ -9690,173 +9690,6 @@ defmodule Image do
       Vix.Vips.Operation.mapim(image, index, interpolate: bicubic_interpolator)
     end
 
-    @doc """
-    Applies a correction for [barrel distortion](https://www.iphotography.com/blog/what-is-lens-barrel-distortion/)
-    and pincushion distortion.
-
-    Barrel/pincushion distortion is present in all but the most optically
-    perfect camera lens. Some cameras will apply a correction
-    in-camera, many do not.
-
-    The parameters to the function, which are "a", "b", "c" and
-    optionally "d", are specific to each lens and focal distance.
-
-    The primary source of these parameters is the [lensfun database](https://github.com/lensfun/lensfun)
-    which lists the parameters for many lens.
-
-    In general these numbers are very small, typically less than
-    0.1, so when experimenting to find acceptable output start with
-    small numbers for `a` and `b` and `0.0` for `c`. Omit the `d`
-    parameter in most, if not all, cases.
-
-    A future release may incorporate the lensfun database to automatically
-    derive the correct parameters based upon image [exif](https://en.wikipedia.org/wiki/Exif) data.
-
-    ### Arguments
-
-    * `image` is any `t:Vimage.t/0`.
-
-    * `a`, `b`, `c` are parameters specific to each
-      camera lens and focal distance, typically found in the
-      [lensfun](https://github.com/lensfun/lensfun) database.
-
-    ### Returns
-
-    * `{:ok, undistorted_image}` or
-
-    * `{:error, reason}`
-
-    ### Example
-
-          iex> image = Image.open!("./test/support/images/gridlines_barrel.png")
-          iex> Image.radial_distortion_correction(image, -0.007715, 0.086731, 0.0)
-
-    """
-    @doc subject: "Distortion", since: "0.58.0"
-
-    @spec radial_distortion_correction(
-            image :: Vimage.t(),
-            a :: number(),
-            b :: number(),
-            c :: number(),
-            d :: (number() | nil)
-          ) ::
-            {:ok, Vimage.t()} | {:error, error_message}
-
-    def radial_distortion_correction(%Vimage{} = image, a, b, c, d \\ nil)
-        when is_number(a) and is_number(b) and is_number(c) and (is_number(d) or is_nil(d)) do
-      use Image.Math
-
-      d = if is_nil(d), do: 1.0 - a - b - c, else: d
-
-      width = width(image)
-      height = height(image)
-
-      radius = min(width, height) / 2
-      centre_x = (width - 1) / 2
-      centre_y = (height - 1) / 2
-
-      # Cartesian coordinates of the destination point
-      # relative to the centre of the image.
-      index = Vix.Vips.Operation.xyz!(width, height)
-      delta = (index - [centre_x, centre_y]) / radius
-
-      # distance or radius of destination image
-      dstr = pow!(delta[0] ** 2 + delta[1] ** 2, 0.5)
-
-      # distance or radius of source image (with formula)
-      srcr = dstr * (a * dstr ** 3 + b * dstr ** 2 + c * dstr + d)
-
-      # comparing old and new distance to get factor
-      factor = Vix.Vips.Operation.abs!(dstr / srcr)
-
-      # coordinates in the source image
-      transform = [centre_x, centre_y] + delta * factor * radius
-
-      # Map new coordinates
-      Operation.mapim(image, transform)
-    end
-
-    @doc """
-    Applies a correction for [vignetting](https://en.wikipedia.org/wiki/Vignetting).
-
-    In photography and optics, vignetting is a reduction of an image's
-    brightness or saturation toward the periphery compared to the
-    image center.
-
-    Vignetting is often an unintended and undesired effect caused by
-    camera settings or lens limitations.
-
-    The parameters to the function, which are "k1", "k2" and "k3"
-    are specific to each lens, aperature and focal distance.
-
-    The primary source of these parameters is the [lensfun database](https://github.com/lensfun/lensfun)
-    which lists the parameters for many lens.
-
-    In general these numbers are very small, typically less than
-    0.1, so when experimenting to find acceptable output start with
-    small numbers for `k1` and `k2` and `0.0` for `k3`.
-
-    A future release may incorporate the lensfun database to automatically
-    derive the correct parameters based upon image [exif](https://en.wikipedia.org/wiki/Exif) data.
-
-    ### Arguments
-
-    * `image` is any `t:Vimage.t/0`.
-
-    * `k1`, `k2`, `k3` are parameters specific to each
-      camera lens and focal distance, typically found in the
-      [lensfun](https://github.com/lensfun/lensfun) database.
-
-    ### Returns
-
-    * `{:ok, unvignetted_image}` or
-
-    * `{:error, reason}`
-
-    ### Example
-
-          iex> image = Image.new!(200, 200, color: :green)
-          iex> Image.vignette_correction(image, -0.2764, -1.26031, 0.7727)
-
-    """
-
-    @doc subject: "Distortion", since: "0.59.0"
-
-    @spec vignette_correction(
-            image :: Vimage.t(),
-            k1 :: number(),
-            k2 :: number(),
-            k3 :: number()
-          ) ::
-            {:ok, Vimage.t()} | {:error, error_message}
-
-    def vignette_correction(%Vimage{} = image, k1, k2, k3) do
-      use Image.Math
-
-      format = Image.band_format(image)
-      width = Image.width(image)
-      height = Image.height(image)
-
-      centre_x = (width - 1) / 2
-      centre_y = (height - 1) / 2
-
-      # Cartesian coordinates of the destination point
-      # relative to the centre of the image.
-      index = Operation.xyz!(width, height)
-      index = (index - [centre_x, centre_y])
-      r = pow!(index[0]**2 + index[1]**2, 0.5)
-      r = r / max!(r)
-
-      # Correction function from https://lensfun.github.io/calibration-tutorial/lens-vignetting.html
-      # Also http://download.macromedia.com/pub/labs/lensprofile_creator/lensprofile_creator_cameramodel.pdf
-      # Cd = Cs * (1 + k1 * R^2 + k2 * R^4 + k3 * R^6)
-      # Inverting the formula to un-vignette (rather than calibrate the vignette)
-      d_dest = 1.0 - (k1 * r**2) + (k2 * r**4) + (k3 * r**6)
-
-      Image.cast(image / d_dest, format)
-    end
-
     @doc """
     Returns a transformation matrix for a given
     image, source quadrilateral and desintation quadrilateral.

lib/image/complex.ex

@@ -15,6 +15,15 @@ defmodule Image.Complex do
     complex(image, &Operation.complex(&1, :VIPS_OPERATION_COMPLEX_POLAR))
   end
 
+  @dialyzer {:nowarn_function, {:polar!, 1}}
+
+  def polar!(%Vimage{} = image) do
+    case polar(image) do
+     {:ok, polar} -> polar
+     {:error, reason} -> raise Image.Error, reason
+    end
+  end
+
   @dialyzer {:nowarn_function, {:rectangular, 1}}
 
   def rectangular(%Vimage{} = image) do

mix.exs

@@ -115,6 +115,7 @@ defmodule Image.MixProject do
         "lib",
         "priv/color",
         "priv/fonts",
+        "priv/lensfun",
         "mix.exs",
         "README*",
         "CHANGELOG*",