lensfunpy

Lens distortion correction for Python, a wrapper for lensfun

These details have been verified by PyPI

Project links

Homepage

GitHub Statistics

Maintainers

letmaik

These details have not been verified by PyPI

Development Status
- 4 - Beta
Intended Audience
- Developers
License
- OSI Approved :: MIT License
Natural Language
- English
Operating System
- MacOS
- Microsoft :: Windows
- POSIX
- Unix
Programming Language
Topic
- Multimedia :: Graphics
- Software Development :: Libraries

Project description

lensfunpy is an easy-to-use Python wrapper for the lensfun library.

API Documentation

Sample code

How to find cameras and lenses

import lensfunpy

cam_maker = 'NIKON CORPORATION'
cam_model = 'NIKON D3S'
lens_maker = 'Nikon'
lens_model = 'Nikkor 28mm f/2.8D AF'

db = lensfunpy.Database()
cam = db.find_cameras(cam_maker, cam_model)[0]
lens = db.find_lenses(cam, lens_maker, lens_model)[0]

print(cam)
# Camera(Maker: NIKON CORPORATION; Model: NIKON D3S; Variant: ;
#        Mount: Nikon F AF; Crop Factor: 1.0; Score: 0)

print(lens)
# Lens(Maker: Nikon; Model: Nikkor 28mm f/2.8D AF; Type: RECTILINEAR;
#      Focal: 28.0-28.0; Aperture: 2.79999995232-2.79999995232;
#      Crop factor: 1.0; Score: 110)

How to correct lens distortion

import cv2 # OpenCV library

focal_length = 28.0
aperture = 1.4
distance = 10
image_path = '/path/to/image.tiff'
undistorted_image_path = '/path/to/image_undist.tiff'

img = cv2.imread(image_path)
height, width = img.shape[0], img.shape[1]

mod = lensfunpy.Modifier(lens, cam.crop_factor, width, height)
mod.initialize(focal_length, aperture, distance, pixel_format=img.dtype)

undist_coords = mod.apply_geometry_distortion()
img_undistorted = cv2.remap(img, undist_coords, None, cv2.INTER_LINEAR)
cv2.imwrite(undistorted_image_path, img_undistorted)

It is also possible to apply the correction via SciPy instead of OpenCV. The lensfunpy.util module contains convenience functions for RGB images which handle both OpenCV and SciPy.

How to correct lens vignetting

Note that the assumption is that the image is in a linear state, i.e., it is not gamma corrected.

import lensfunpy
import imageio

db = lensfun.Database()
cam = db.find_cameras('NIKON CORPORATION', 'NIKON D3S')[0]
lens = db.find_lenses(cam, 'Nikon', 'Nikkor AF 20mm f/2.8D')[0]

# The image is assumed to be in a linearly state.
img = imageio.imread('/path/to/image.tiff')

focal_length = 20
aperture = 4
distance = 10
width = img.shape[1]
height = img.shape[0]

mod = lensfunpy.Modifier(lens, cam.crop_factor, width, height)
mod.initialize(focal_length, aperture, distance, pixel_format=img.dtype)

did_apply = mod.apply_color_modification(img)
if did_apply:
    imageio.imwrite('/path/to/image_corrected.tiff', img)
else:
    print('vignetting not corrected, calibration data missing?')

How to correct lens vignetting and TCA

Note that the assumption is that the image is in a linear state, i.e., it is not gamma corrected. Vignetting should always be corrected first before applying the TCA correction.

import imageio
import cv2
import lensfunpy

db = lensfunpy.Database()
cam = db.find_cameras('Canon', 'Canon EOS 5D Mark IV')[0]
lens = db.find_lenses(cam, 'Sigma', 'Sigma 8mm f/3.5 EX DG circular fisheye')[0]

# The image is assumed to be in a linearly state.
img = imageio.imread('/path/to/image.tiff')

focal_length = 8.0
aperture = 11
distance = 10
width = img.shape[1]
height = img.shape[0]

mod = lensfunpy.Modifier(lens, cam.crop_factor, width, height)
mod.initialize(focal_length, aperture, distance, pixel_format=img.dtype, flags=lensfunpy.ModifyFlags.VIGNETTING | lensfunpy.ModifyFlags.TCA)

# Vignette Correction
mod.apply_color_modification(img)

# TCA Correction
undist_coords = mod.apply_subpixel_distortion()
img[..., 0] = cv2.remap(img[..., 0], undist_coords[..., 0, :], None, cv2.INTER_LINEAR)
img[..., 1] = cv2.remap(img[..., 1], undist_coords[..., 1, :], None, cv2.INTER_LINEAR)
img[..., 2] = cv2.remap(img[..., 2], undist_coords[..., 2, :], None, cv2.INTER_LINEAR)

imageio.imwrite('/path/to/image_corrected.tiff', img)

Installation

Install lensfunpy by running:

pip install lensfunpy

64-bit binary wheels are provided for Linux, macOS, and Windows.

Installation from source on Linux/macOS

If you have the need to use a specific lensfun version or you can’t use the provided binary wheels then follow the steps in this section to build lensfunpy from source.

First, install the lensfun library on your system.

On Ubuntu, you can get (an outdated) version with:

sudo apt-get install liblensfun-dev

Or install the latest developer version from the Git repository:

git clone https://github.com/lensfun/lensfun
cd lensfun
cmake .
sudo make install

After that, install lensfunpy using:

git clone https://github.com/letmaik/lensfunpy
cd lensfunpy
pip install numpy cython
pip install .

On Linux, if you get the error “ImportError: liblensfun.so.0: cannot open shared object file: No such file or directory” when trying to use lensfunpy, then do the following:

echo "/usr/local/lib" | sudo tee /etc/ld.so.conf.d/99local.conf
sudo ldconfig

The lensfun library is installed in /usr/local/lib when compiled from source, and apparently this folder is not searched for libraries by default in some Linux distributions. Note that on some systems the installation path may be slightly different, such as /usr/local/lib/x86_64-linux-gnu or /usr/local/lib64.

Installation from source on Windows

These instructions are experimental and support is not provided for them. Typically, there should be no need to build manually since wheels are hosted on PyPI.

You need to have Visual Studio installed to build lensfunpy.

In a PowerShell window:

$env:USE_CONDA = '1'
$env:PYTHON_VERSION = '3.10'
$env:PYTHON_ARCH = 'x86_64'
$env:NUMPY_VERSION = '2.0.*'
git clone https://github.com/letmaik/lensfunpy
cd lensfunpy
.github/scripts/build-windows.ps1

The above will download all build dependencies (including a Python installation) and is fully configured through the four environment variables. Set USE_CONDA = '0' to build within an existing Python environment.

Project details

These details have been verified by PyPI

Project links

Homepage

GitHub Statistics

Maintainers

letmaik

These details have not been verified by PyPI

Development Status
- 4 - Beta
Intended Audience
- Developers
License
- OSI Approved :: MIT License
Natural Language
- English
Operating System
- MacOS
- Microsoft :: Windows
- POSIX
- Unix
Programming Language
Topic
- Multimedia :: Graphics
- Software Development :: Libraries

Release history Release notifications | RSS feed

This version

1.18.0

Jan 26, 2026

1.17.0

May 13, 2025

1.16.0

Feb 1, 2025

1.15.0

Feb 10, 2024

1.14.0

Dec 10, 2023

1.13.1

Aug 8, 2023

1.12.0

Dec 9, 2022

1.11.1

Oct 30, 2022

1.11.0

Aug 22, 2022

1.10.0

Jan 12, 2022

1.9.0

Aug 25, 2021

1.8.0

Oct 24, 2020

1.7.0

Jan 27, 2020

1.7.0a2 pre-release

May 1, 2018

1.7.0a1 pre-release

Apr 27, 2018

1.6.1

Mar 31, 2019

1.6.0

Aug 19, 2017

1.6.0a1 pre-release

Aug 17, 2017

1.5.0

Apr 22, 2017

1.4.0

Dec 30, 2015

1.3.0

May 17, 2015

1.2.4

May 2, 2015

1.2.2

Dec 2, 2014

1.2.1

Dec 1, 2014

1.2.0

Nov 29, 2014

1.1.0

Oct 27, 2014

1.0.2

Sep 15, 2014

1.0.1

Sep 14, 2014

0.12.0

Jul 21, 2014

0.11.0

Mar 25, 2014

0.10.0

Mar 24, 2014

0.9.1

Mar 22, 2014

0.9.0

Mar 22, 2014

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

lensfunpy-1.18.0-cp314-cp314-win_amd64.whl (2.3 MB view details)

Uploaded Jan 26, 2026 CPython 3.14Windows x86-64

lensfunpy-1.18.0-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (1.6 MB view details)

Uploaded Jan 26, 2026 CPython 3.14manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

lensfunpy-1.18.0-cp314-cp314-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl (1.6 MB view details)

Uploaded Jan 26, 2026 CPython 3.14manylinux: glibc 2.27+ ARM64manylinux: glibc 2.28+ ARM64

lensfunpy-1.18.0-cp314-cp314-macosx_14_0_arm64.whl (1.6 MB view details)

Uploaded Jan 26, 2026 CPython 3.14macOS 14.0+ ARM64

lensfunpy-1.18.0-cp314-cp314-macosx_13_0_x86_64.whl (1.7 MB view details)

Uploaded Jan 26, 2026 CPython 3.14macOS 13.0+ x86-64

lensfunpy-1.18.0-cp313-cp313-win_amd64.whl (2.3 MB view details)

Uploaded Jan 26, 2026 CPython 3.13Windows x86-64

lensfunpy-1.18.0-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (1.6 MB view details)

Uploaded Jan 26, 2026 CPython 3.13manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

lensfunpy-1.18.0-cp313-cp313-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl (1.6 MB view details)

Uploaded Jan 26, 2026 CPython 3.13manylinux: glibc 2.27+ ARM64manylinux: glibc 2.28+ ARM64

lensfunpy-1.18.0-cp313-cp313-macosx_14_0_arm64.whl (1.6 MB view details)

Uploaded Jan 26, 2026 CPython 3.13macOS 14.0+ ARM64

lensfunpy-1.18.0-cp313-cp313-macosx_13_0_x86_64.whl (1.7 MB view details)

Uploaded Jan 26, 2026 CPython 3.13macOS 13.0+ x86-64

lensfunpy-1.18.0-cp312-cp312-win_amd64.whl (2.3 MB view details)

Uploaded Jan 26, 2026 CPython 3.12Windows x86-64

lensfunpy-1.18.0-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (1.6 MB view details)

Uploaded Jan 26, 2026 CPython 3.12manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

lensfunpy-1.18.0-cp312-cp312-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl (1.6 MB view details)

Uploaded Jan 26, 2026 CPython 3.12manylinux: glibc 2.27+ ARM64manylinux: glibc 2.28+ ARM64

lensfunpy-1.18.0-cp312-cp312-macosx_14_0_arm64.whl (1.6 MB view details)

Uploaded Jan 26, 2026 CPython 3.12macOS 14.0+ ARM64

lensfunpy-1.18.0-cp312-cp312-macosx_13_0_x86_64.whl (1.7 MB view details)

Uploaded Jan 26, 2026 CPython 3.12macOS 13.0+ x86-64

lensfunpy-1.18.0-cp311-cp311-win_amd64.whl (2.3 MB view details)

Uploaded Jan 26, 2026 CPython 3.11Windows x86-64

lensfunpy-1.18.0-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (1.6 MB view details)

Uploaded Jan 26, 2026 CPython 3.11manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

lensfunpy-1.18.0-cp311-cp311-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl (1.6 MB view details)

Uploaded Jan 26, 2026 CPython 3.11manylinux: glibc 2.27+ ARM64manylinux: glibc 2.28+ ARM64

lensfunpy-1.18.0-cp311-cp311-macosx_14_0_arm64.whl (1.5 MB view details)

Uploaded Jan 26, 2026 CPython 3.11macOS 14.0+ ARM64

lensfunpy-1.18.0-cp311-cp311-macosx_13_0_x86_64.whl (1.6 MB view details)

Uploaded Jan 26, 2026 CPython 3.11macOS 13.0+ x86-64

lensfunpy-1.18.0-cp310-cp310-win_amd64.whl (2.3 MB view details)

Uploaded Jan 26, 2026 CPython 3.10Windows x86-64

lensfunpy-1.18.0-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (1.5 MB view details)

Uploaded Jan 26, 2026 CPython 3.10manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

lensfunpy-1.18.0-cp310-cp310-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl (1.5 MB view details)

Uploaded Jan 26, 2026 CPython 3.10manylinux: glibc 2.27+ ARM64manylinux: glibc 2.28+ ARM64

lensfunpy-1.18.0-cp310-cp310-macosx_14_0_arm64.whl (1.5 MB view details)

Uploaded Jan 26, 2026 CPython 3.10macOS 14.0+ ARM64

lensfunpy-1.18.0-cp310-cp310-macosx_13_0_x86_64.whl (1.7 MB view details)

Uploaded Jan 26, 2026 CPython 3.10macOS 13.0+ x86-64

File details

Details for the file lensfunpy-1.18.0-cp314-cp314-win_amd64.whl.

File metadata

Download URL: lensfunpy-1.18.0-cp314-cp314-win_amd64.whl
Upload date: Jan 26, 2026
Size: 2.3 MB
Tags: CPython 3.14, Windows x86-64
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for lensfunpy-1.18.0-cp314-cp314-win_amd64.whl
Algorithm	Hash digest
SHA256	`f7cea9548e5d78d346ab8e3a004e485a1bcabb5ab99b6936d34f1247268d6fc9`
MD5	`4ca156d749aa373c0b4de2cdc963abe5`
BLAKE2b-256	`7e855083fa63b528411ac7b14fd8e7c242877723c793c1ad1c64f8675bd3ceab`

Algorithm	Hash digest
SHA256	`a929ae4366d25b9cc760ea7daf84d8a066c0a778cd02783e8dcae97819ec748b`
MD5	`2bed1659666d88aee3a592fdfc06b043`
BLAKE2b-256	`13619ba55b21010198949411aff5445bd882ade7197dbe205ce321d9dabe5ee1`

Algorithm	Hash digest
SHA256	`0e741a19a07eedb3f32f9afe06261f9717a3d8045e6fd2562f41d70cda661fc0`
MD5	`b1345938acfde399cd827a9add39a567`
BLAKE2b-256	`b176d778b67b76c8361200da9a571922ec895da949b90d6312ffea7a53c5c27b`

Algorithm	Hash digest
SHA256	`fec6751b1fb8d63a36a3fbb428e882b0dccaa256b8771c42360a5350541bb324`
MD5	`90c4dab5db46236eeada6457b9c3410d`
BLAKE2b-256	`9977f905b50227f25047c1ed617886df763cf26d0848fe85aeaa1e910958a4a1`

Algorithm	Hash digest
SHA256	`ab161ea6b4a1b2fcd4d8b7dc52c24bd4146a716b4c69bae9d16cfc18e0b5fc74`
MD5	`c6e909c7b75f80c7f3b598e2c3c796d2`
BLAKE2b-256	`aac2583381e83da51193a8dd955f23305569b1f5a53ae1dbef792690478f0948`

Algorithm	Hash digest
SHA256	`09ade2b1c91407cba31a88b05f9050c286906057b085e590990f01fa7b90968a`
MD5	`71bc148809d075d707f44466ea4f2c0e`
BLAKE2b-256	`53a96d8b9ce87881c3e1b28256bb5c0aa82311c323c84a068ce16b0dce0e2959`

Algorithm	Hash digest
SHA256	`018b0cca46028ff7f6509a25f2bbb5a11032dc1ed91cb4c55be7a45bb89a7c7c`
MD5	`d2e850080d72176eae1fb28547ae1d21`
BLAKE2b-256	`ea02b51eb9f3b0ab905043dc4c60e9526b838db9469690805a912fbf24cbc893`

Algorithm	Hash digest
SHA256	`7e8257ebe95dca1a5f417078bd729e6ea7e798cd7db949a0d920d56eea884ba0`
MD5	`6f707c09eaa23fbf44f6b585aacd8b44`
BLAKE2b-256	`7b0d181f7dcda2c2eadb4e3a11dcd4c4b3926355f76c39fb12ac4f5cb44b1e14`

Algorithm	Hash digest
SHA256	`cc68439b423232611c023aca4a7036ddea1f9988975f773bec170ba7ab8d13b5`
MD5	`2c92b36e9b3783442f133abe3dfd2302`
BLAKE2b-256	`1a42ed4ef4bbe9fa78ef6a90ab8eabe7ddc887e4fab6421a25f01a8ce81fcb64`

Algorithm	Hash digest
SHA256	`56cc28d9f361c71e20179137d9bb65a0127f8860f9b0492c90b8c4c46a990fb5`
MD5	`c887900ea7debffc6e5ee8d19480c703`
BLAKE2b-256	`2abac0794e12e13aaa181b761ecf5bdacafb5cfa1a600666799f681c22a4d75e`

Algorithm	Hash digest
SHA256	`8d81a1813bfa272dba1bfe89535151a37fe7faff73e6323509db136a2f66f727`
MD5	`5626b8e064ce4be02b7a4f8a351831f0`
BLAKE2b-256	`24f17180bb0138166a0730954d7bb4a15158362f3fb6fc0e3b11c6d80ad64390`

Algorithm	Hash digest
SHA256	`f8975097cb3cfa645bcbfb64070a261c082a64c333f8cb96172ee6d7e349c419`
MD5	`ace212dff78250f08170b5377ba6f2cf`
BLAKE2b-256	`048cb7fca55a2751fdf57581b0d3b019fb44b8aaa9d990e2166c92a22dd0941e`

Algorithm	Hash digest
SHA256	`83eaee5b805a069a2081a5beae7ca62dce781f2199785ccf064560207f6255cf`
MD5	`83db8ccb4affcd2602ca27ffe281a7d6`
BLAKE2b-256	`113e2121fcf2c142950c52036f231230c5268fcc2a0f25fed8ca3515e3cd2875`

Algorithm	Hash digest
SHA256	`63ce75611e7d2c7a4703b24b245f4a459f65558b8fec9dd53948bcefbfe90c8f`
MD5	`392ca63136a894c57827824373ae8892`
BLAKE2b-256	`3613634dc9f608b1e5e8f9b479d430c64c2b10143e9308e2bdd9d03498ffb524`

Algorithm	Hash digest
SHA256	`568243e44a55c9a30517a81294c72e6f929e4ec269856edaf884513a8e1378e4`
MD5	`9d9f3d54d637702ff10e94aaca1e2b18`
BLAKE2b-256	`cdd834979caba2e4058500f4c27b24428f305da8619b0c37a89ec5a5480b5b00`

Algorithm	Hash digest
SHA256	`e821b8d89b8f22bc28216acf104d2f47efbed126b2d2384db69ea065db56efbf`
MD5	`3e93ec0a61d42389e2cc60eaef7d1e39`
BLAKE2b-256	`ce44e95ca86b248187e6661d7e5e1fc7c23d44edf39efdda78ac8dccc83354f6`

Algorithm	Hash digest
SHA256	`fdc64f0d111d66408bff3dfeb35ed73227bf93ad5d6d3faeecdc19dbb72d0ae8`
MD5	`9ed4a4f9de7071178d35e9fea6e3dd95`
BLAKE2b-256	`8e3935f0de28f805aefb5e74213adb7fe0d7197e748f0c24b85b7d3fd1727a61`

Algorithm	Hash digest
SHA256	`41bef0ce5c31f80b543079a37779580102dba1fd34479abdb623e29fcefa15f2`
MD5	`8ee0bf69a6f647a16495fbdc964fff74`
BLAKE2b-256	`e99adaa0003c73e7fc94006989595867be197a29d0b13fbf6ac18baa2120bdaa`

Algorithm	Hash digest
SHA256	`1f879a8fb5a5566b225c7e0187911c8e5f0e9865d98e56c942ae339abb120551`
MD5	`20a65d8484e73089a34e29b32d68ffaa`
BLAKE2b-256	`4028ae665dae767acdd8c69d690a758d6abc3f74fa935fad7bbf53732c114702`

Algorithm	Hash digest
SHA256	`be571910cce193dbd98cdbc4ca3f96c42e590c526f4820cbe9ec018989b95e71`
MD5	`cbd8aa7f318e21ee2e5a0cf2e9cd882c`
BLAKE2b-256	`2051674d24a7eccf33597ba575c0edda82ce789e24eee6bd20befade635072d9`

Algorithm	Hash digest
SHA256	`90761bb3663f7132b6158819466393c1014db3023a9ad70fec50fd14fb5bcb9b`
MD5	`d22a91d6a44555c03b65191d82bbb43e`
BLAKE2b-256	`91ae7d82d43c33bfae641443792eeae18f730c2e79426e79cc6e50c53fb539e4`

lensfunpy 1.18.0

Navigation

Verified details

Project links

GitHub Statistics

Maintainers

Unverified details

Meta

Classifiers

Project description

Sample code

How to find cameras and lenses

How to correct lens distortion

How to correct lens vignetting

How to correct lens vignetting and TCA

Installation

Installation from source on Linux/macOS

Installation from source on Windows

Project details

Verified details

Project links

GitHub Statistics

Maintainers

Unverified details

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distributions

Built Distributions

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

Algorithm	Hash digest
SHA256	`3c5f0abd2e18f61fa83468bedb2980c74eada2359febbac44471100e34378395`
MD5	`7318227c4f2a24d1455be2f235c992ed`
BLAKE2b-256	`7f79abd18d45a0f78342f664e78f62d74d1619e099833a3fd7232be54b0212d6`

Algorithm	Hash digest
SHA256	`fd927ec24be8386a357661a880a4b963859069a415d30083130f4ff3665ada1e`
MD5	`35f3ae01f1ff54110b3f38c5b22da089`
BLAKE2b-256	`1bd527b503cd0677603323169f8f080e2e50a003ebf799c4eb19d9ca90ac20b5`

Algorithm	Hash digest
SHA256	`84cda75d717df3fcd29b3d945454bbc2ef50fec47b0106c6edaa917ee6ee3e53`
MD5	`62b82ceaa789a74e7e9b484659355dc3`
BLAKE2b-256	`54b7747e64687c909616450dc416514028855d84f72a0c9fa12b568a53550688`

Algorithm	Hash digest
SHA256	`ad470ae6171ef2344e1627e7b8bd6809723bfef3da5f2cdcdb4c48bd6df3710f`
MD5	`fe786248b1e5858774ad995f7fd2bbb7`
BLAKE2b-256	`16772b2d5cb929f2fda19a19636c18248bc0ddbab70d45e2f9d0a1c1059c60b4`