lensfunpy

https://letmaik.github.io/lensfunpy/
Admin
lensfunpy is a Python library for correcting optical aberrations in images, including distortion,...
Tokens:5,668
Snippets:47
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Mount Class Properties

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.Mount.html

Access properties of the Mount class to get information about lens mount compatibility and names.

```APIDOC
## Mount Class

### Description
Represents a camera lens mount.

### Properties

#### compat

The mounts that are compatible to this one.

- **Return type**: list of str

#### name

The mount name.

- **Return type**: str
```

--------------------------------

### initialize

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.Modifier.html

Initializes the modifier with specific imaging parameters.

```APIDOC
## initialize

### Description
Initializes the modifier with specific imaging parameters.

### Method
`initialize(self, focal, aperture, distance=1000.0, scale=0.0, targeom=LensType.RECTILINEAR_, pixel_format=np.uint8, flags=ModifyFlags.ALL, reverse=0)`

### Parameters
- **focal** (float) - The focal length in mm at which the image was taken.
- **aperture** (float) - The aperture (f-number) at which the image was taken.
- **distance** (float) - The approximative focus distance in meters (distance > 0) (default: 1000.0).
- **scale** (float) - An additional scale factor to be applied onto the image (1.0 - no scaling; 0.0 - automatic scaling) (default: 0.0).
- **targeom** (lensfunpy.LensType) - Target geometry. If LF_MODIFY_GEOMETRY is set in flags and targeom is different from lens.type, a geometry conversion will be applied on the image (default: LensType.RECTILINEAR_).
- **pixel_format** - Pixel format of the image (default: np.uint8).
- **flags** (int) - A set of flags (see `lensfunpy.ModifyFlags`) telling which distortions you want corrected. A value of ModifyFlags.ALL orders correction of everything possible (will enable all correction models present in lens description) (default: ModifyFlags.ALL).
- **reverse** (bool) - If this parameter is true, a reverse transform will be prepared. That is, you take an undistorted image as input and convert it so that it will look as if it would be a shot made with lens (default: 0).
```

--------------------------------

### Database Initialization

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.Database.html

Initializes the Database class, which serves as the main entry point for lensfunpy's functionality. It can load data from specified XML files, XML strings, and optionally load common and bundled database files.

```APIDOC
## Database

_class _lensfunpy.Database(_paths =None_, _xml =None_, _load_common =True_, _load_bundled =True_)

### Description
The main entry point to use lensfunpy’s functionality.

### Parameters
* **paths** (_iterable_ _of_ _str_) – XML files to load
* **xml** (_str_) – load data from XML string
* **load_common** (_bool_) – whether to load the system/user database files
* **load_bundled** (_bool_) – whether to load the bundled database files
```

--------------------------------

### mounts

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.Database.html

Provides access to all loaded mounts.

```APIDOC
## mounts

mounts

### Description
All loaded mounts.

### Return Type
list of `lensfunpy.Mount` instances
```

--------------------------------

### Database Class Methods

Source: https://letmaik.github.io/lensfunpy/_sources/api/lensfunpy.Database.rst.txt

The Database class provides methods for managing and querying lens information. The `:members:` directive indicates that all public members of the class are documented.

```APIDOC
## Database Class

Provides methods for interacting with the lens database.

### Methods

This class exposes various methods for database operations. The full list of members is documented below.

* `__init__`
* `__enter__`
* `__exit__`
* `__len__`
* `__getitem__`
* `__setitem__`
* `__delitem__`
* `__iter__`
* `__contains__`
* `add_lens`
* `find_lens`
* `get_lens`
* `get_lens_by_id`
* `get_lens_by_make_model`
* `get_lens_by_uid`
* `get_lens_list`
* `get_make_list`
* `get_model_list`
* `load_file`
* `load_from_directory`
* `remove_lens`
* `save_file`
* `save_to_directory`
* `update_lens`
```

--------------------------------

### cameras

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.Database.html

Provides access to all loaded cameras.

```APIDOC
## cameras

cameras

### Description
All loaded cameras.

### Return Type
list of `lensfunpy.Camera` instances
```

--------------------------------

### find_mount

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.Database.html

Finds a camera mount by its name.

```APIDOC
## find_mount

find_mount(_self_ , _name_)

### Description
Finds a camera mount by its name.

### Parameters
* **name** (_str_)

### Return Type
`lensfunpy.Mount` instance
```

--------------------------------

### lenses

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.Database.html

Provides access to all loaded lenses.

```APIDOC
## lenses

lenses

### Description
All loaded lenses.

### Return Type
list of `lensfunpy.Lens` instances
```

--------------------------------

### Mount Class Members

Source: https://letmaik.github.io/lensfunpy/_sources/api/lensfunpy.Mount.rst.txt

The Mount class in lensfunpy provides an interface to camera lens mount information. The `:members:` directive includes all public methods and attributes, `:undoc-members:` includes members without docstrings, and `:member-order: groupwise` organizes them by group.

```APIDOC
class lensfunpy.Mount
    :members:
    :undoc-members:
    :member-order: groupwise
```

--------------------------------

### Modifier Class Initialization

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.Modifier.html

Initializes a Modifier object with lens information and image parameters. This is a constructor for the Modifier class.

```APIDOC
## Modifier Class Constructor

### Description
Initializes a Modifier object with lens information and image parameters.

### Parameters
- **lens** (lensfunpy.Lens) - The lens object containing calibration data.
- **crop** (float) - The crop factor of the image.
- **width** (int) - The width of the image in pixels.
- **height** (int) - The height of the image in pixels.
```

--------------------------------

### lensfunpy.util.remapScipy

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.util.html

Remaps an image using the SciPy backend. This function is a specialized version of `remap()` that exclusively uses SciPy.

```APIDOC
## remapScipy()

### Description
Remap an image using SciPy. See `remap()` for parameters.

### Parameters
#### Path Parameters
- **im** (ndarray of shape (h,w,3)) – Required - RGB image to be remapped
- **coords** (ndarray of shape (h,w,2)) – Required - target coordinates in x,y order for each pixel

### Returns
remapped RGB image

### Return Type
ndarray of shape (h,w,3)
```

--------------------------------

### find_cameras

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.Database.html

Finds cameras based on maker and model, with an option for loose searching.

```APIDOC
## find_cameras

find_cameras(_self_ , _maker =None_, _model =None_, _loose_search =False_)

### Description
Finds cameras based on maker and model, with an option for loose searching.

### Parameters
* **maker** (_str_) – return cameras from the given manufacturer
* **model** (_str_) – return cameras matching the given model
* **loose_search** (_bool_)

### Return Type
list of `lensfunpy.Camera` instances
```

--------------------------------

### lensfunpy.util.remap

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.util.html

Remaps an RGB image using a target coordinate array. It prioritizes OpenCV for performance if available, otherwise falls back to SciPy.

```APIDOC
## remap()

### Description
Remap an RGB image using the given target coordinate array. If available, OpenCV is used (faster), otherwise SciPy.

### Parameters
#### Path Parameters
- **im** (ndarray of shape (h,w,3)) – Required - RGB image to be remapped
- **coords** (ndarray of shape (h,w,2)) – Required - target coordinates in x,y order for each pixel

### Returns
remapped RGB image

### Return Type
ndarray of shape (h,w,3)
```

--------------------------------

### lensfunpy.util.remapOpenCv

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.util.html

Remaps an image using the OpenCV backend. This function is a specialized version of `remap()` that exclusively uses OpenCV.

```APIDOC
## remapOpenCv()

### Description
Remap an image using OpenCV. See `remap()` for parameters.

### Parameters
#### Path Parameters
- **im** (ndarray of shape (h,w,3)) – Required - RGB image to be remapped
- **coords** (ndarray of shape (h,w,2)) – Required - target coordinates in x,y order for each pixel

### Returns
remapped RGB image

### Return Type
ndarray of shape (h,w,3)
```

--------------------------------

### Lens Class Methods

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.Lens.html

Methods available on the Lens class for interpolating calibration data.

```APIDOC
## interpolate_distortion

### Description
Interpolates the distortion coefficients for a given focal length.

### Signature
`interpolate_distortion(_self_, _float focal_)`

### Returns
`lensfunpy.LensCalibDistortion` - The interpolated distortion calibration data.
```

```APIDOC
## interpolate_tca

### Description
Interpolates the TCA (transverse chromatic aberration) coefficients for a given focal length.

### Signature
`interpolate_tca(_self_, _float focal_)`

### Returns
`lensfunpy.LensCalibTCA` - The interpolated TCA calibration data.
```

```APIDOC
## interpolate_vignetting

### Description
Interpolates the vignetting coefficients for a given focal length, aperture, and distance.

### Signature
`interpolate_vignetting(_self_, _float focal_, _float aperture_, _float distance_)`

### Returns
`lensfunpy.LensCalibVignetting` - The interpolated vignetting calibration data.
```

--------------------------------

### Camera Attributes

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.Camera.html

The Camera class provides access to various attributes of a camera, including its sensor crop factor, manufacturer, model, mount, search score, and variant.

```APIDOC
## Camera Class Attributes

### Description
Provides access to camera properties.

### Attributes
- **crop_factor** (float) - The crop factor of the camera sensor.
- **maker** (str) - The camera manufacturer.
- **model** (str) - The camera model.
- **mount** (str|None) - The camera mount.
- **score** (int) - Search score.
- **variant** (str|None) - The camera variant.
```

--------------------------------

### apply_subpixel_distortion

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.Modifier.html

Applies subpixel distortion correction to the image coordinates.

```APIDOC
## apply_subpixel_distortion

### Description
Applies subpixel distortion correction to the image coordinates.

### Method
`apply_subpixel_distortion(self, xu=0, yu=0, width=-1, height=-1)`

### Parameters
- **xu** (float) - The x-coordinate of the center of distortion (default: 0).
- **yu** (float) - The y-coordinate of the center of distortion (default: 0).
- **width** (int) - The width of the image (default: -1, uses image width).
- **height** (int) - The height of the image (default: -1, uses image height).

### Returns
- ndarray of shape (height, width, 3, 2) or None: Per-channel coordinates for subpixel distortion correction, or None if calibration data is missing.
```

--------------------------------

### apply_color_modification

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.Modifier.html

Applies vignetting correction to an image.

```APIDOC
## apply_color_modification

### Description
Applies vignetting correction to an image.

### Method
`apply_color_modification(self, img)`

### Parameters
- **img** (ndarray) - Image (h,w,3) for which to apply the vignetting correction, in place.

### Returns
- bool: true if vignetting correction was applied, otherwise false.
```

--------------------------------

### TCAModel

Source: https://letmaik.github.io/lensfunpy/api/enums.html

Defines the chromatic aberration (TCA) model. Options include no TCA, linear TCA, and polynomial TCA of degree 3.

```APIDOC
## TCAModel

### Description
An enumeration defining the chromatic aberration (TCA) model. Options include no TCA, linear TCA, and polynomial TCA of degree 3.

### Enum Values
- **LINEAR** (_ = 1_)
- **NONE** (_ = 0_)
- **POLY3** (_ = 2_)
```

--------------------------------

### VignettingModel Enumeration

Source: https://letmaik.github.io/lensfunpy/_sources/api/enums.rst.txt

The VignettingModel enumeration specifies the type of vignetting model used.

```APIDOC
## VignettingModel

This enumeration defines the types of vignetting models.

### Members

- **`NONE`**: No vignetting correction.
- **`CIRCULAR`**: Circular vignetting model.
- **`RECTANGULAR`**: Rectangular vignetting model.
```

--------------------------------

### Lens Class Attributes

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.Lens.html

Attributes of the Lens class providing lens properties and calibration data.

```APIDOC
## calib_distortion

### Description
Provides access to the list of distortion calibration instances.

### Type
`list` of `lensfunpy.LensCalibDistortion` instances
```

```APIDOC
## calib_tca

### Description
Provides access to the list of TCA calibration instances.

### Type
`list` of `lensfunpy.LensCalibTCA` instances
```

```APIDOC
## calib_vignetting

### Description
Provides access to the list of vignetting calibration instances.

### Type
`list` of `lensfunpy.LensCalibTCA` instances
```

```APIDOC
## center_x

### Description
The x-coordinate of the lens center.

### Type
`float`
```

```APIDOC
## center_y

### Description
The y-coordinate of the lens center.

### Type
`float`
```

```APIDOC
## crop_factor

### Description
The crop factor of the lens.

### Type
`float`
```

```APIDOC
## maker

### Description
The lens manufacturer.

### Type
`str`
```

```APIDOC
## max_aperture

### Description
Maximum aperture of the lens. Returns None if unknown.

### Type
`float` or `None`
```

```APIDOC
## max_focal

### Description
Maximum focal length of the lens.

### Type
`float`
```

```APIDOC
## min_aperture

### Description
Minimum aperture of the lens. Returns None if unknown.

### Type
`float` or `None`
```

```APIDOC
## min_focal

### Description
Minimum focal length of the lens.

### Type
`float`
```

```APIDOC
## model

### Description
The lens model.

### Type
`str`
```

```APIDOC
## mounts

### Description
Compatible mounts for the lens.

### Type
`list` of `lensfunpy.Mount` instances
```

```APIDOC
## score

### Description
The search score for the lens.

### Type
`int`
```

```APIDOC
## type

### Description
The type of the lens.

### Type
`lensfunpy.LensType` instance
```

--------------------------------

### VignettingModel

Source: https://letmaik.github.io/lensfunpy/api/enums.html

Specifies the vignetting model for lens correction. Options include no vignetting and the polynomial approximation (PA) model.

```APIDOC
## VignettingModel

### Description
An enumeration specifying the vignetting model for lens correction. Options include no vignetting and the polynomial approximation (PA) model.

### Enum Values
- **NONE** (_ = 0_)
- **PA** (_ = 1_)
```

--------------------------------

### DistortionModel

Source: https://letmaik.github.io/lensfunpy/api/enums.html

Specifies the distortion model used for lens correction. Options include no distortion, polynomial of degree 3, polynomial of degree 5, and PTLens model.

```APIDOC
## DistortionModel

### Description
An enumeration specifying the distortion model used for lens correction. Options include no distortion, polynomial of degree 3, polynomial of degree 5, and PTLens model.

### Enum Values
- **NONE** (_ = 0_)
- **POLY3** (_ = 1_)
- **POLY5** (_ = 2_)
- **PTLENS** (_ = 3_)
```

--------------------------------

### TCAModel Enumeration

Source: https://letmaik.github.io/lensfunpy/_sources/api/enums.rst.txt

The TCAModel enumeration specifies the type of TCA (Chromatic Aberration) model used.

```APIDOC
## TCAModel

This enumeration defines the types of chromatic aberration models.

### Members

- **`NONE`**: No chromatic aberration correction.
- **`SIMPLE`**: Simple chromatic aberration model.
- **`COMPLEX`**: Complex chromatic aberration model.
```

--------------------------------

### apply_subpixel_geometry_distortion

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.Modifier.html

Applies combined geometry and subpixel distortion correction to the image coordinates.

```APIDOC
## apply_subpixel_geometry_distortion

### Description
Applies combined geometry and subpixel distortion correction to the image coordinates.

### Method
`apply_subpixel_geometry_distortion(self, xu=0, yu=0, width=-1, height=-1)`

### Parameters
- **xu** (float) - The x-coordinate of the center of distortion (default: 0).
- **yu** (float) - The y-coordinate of the center of distortion (default: 0).
- **width** (int) - The width of the image (default: -1, uses image width).
- **height** (int) - The height of the image (default: -1, uses image height).

### Returns
- ndarray of shape (height, width, 3, 2) or None: Per-channel coordinates for combined distortion and subpixel distortion correction, or None if calibration data is missing.
```

--------------------------------

### find_lenses

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.Database.html

Finds lenses associated with a given camera, optionally filtered by lens maker and model, with support for loose searching.

```APIDOC
## find_lenses

find_lenses(_self_ , _Camera camera_, _maker=None_ , _lens=None_ , _loose_search=False_)

### Description
Finds lenses associated with a given camera, optionally filtered by lens maker and model, with support for loose searching.

### Parameters
* **camera** (_lensfunpy.Camera_)
* **maker** (_str_)
* **lens** (_str_)
* **loose_search** (_bool_)

### Return Type
list of `lensfunpy.Lens` instances
```

--------------------------------

### LensType Enumeration

Source: https://letmaik.github.io/lensfunpy/_sources/api/enums.rst.txt

The LensType enumeration categorizes different types of lenses.

```APIDOC
## LensType

This enumeration defines the types of lenses supported.

### Members

- **`NORMAL`**: A standard lens.
- **`FISHEYE`**: A fisheye lens.
- **`PANORAMA`**: A panorama lens.
```

--------------------------------

### LensCalibVignetting

Source: https://letmaik.github.io/lensfunpy/api/namedtuples.html

Represents lens vignetting calibration data. It includes the vignetting model, focal length, aperture, distance, and vignetting terms.

```APIDOC
## LensCalibVignetting

### Description
Represents lens vignetting calibration data.

### Parameters
- **model** (string) - The vignetting model used.
- **focal** (float) - The focal length of the lens.
- **aperture** (float) - The aperture value.
- **distance** (float) - The focus distance.
- **terms** (list) - A list of vignetting coefficients.
```

--------------------------------

### LensCalibVignetting

Source: https://letmaik.github.io/lensfunpy/_sources/api/namedtuples.rst.txt

Represents vignetting calibration data for a lens.

```APIDOC
## LensCalibVignetting

### Description
Represents vignetting calibration data for a lens.

This named tuple holds the parameters necessary for vignetting correction.
```

--------------------------------

### apply_geometry_distortion

Source: https://letmaik.github.io/lensfunpy/api/lensfunpy.Modifier.html

Applies geometry distortion correction to the image coordinates.

```APIDOC
## apply_geometry_distortion

### Description
Applies geometry distortion correction to the image coordinates.

### Method
`apply_geometry_distortion(self, xu=0, yu=0, width=-1, height=-1)`

### Parameters
- **xu** (float) - The x-coordinate of the center of distortion (default: 0).
- **yu** (float) - The y-coordinate of the center of distortion (default: 0).
- **width** (int) - The width of the image (default: -1, uses image width).
- **height** (int) - The height of the image (default: -1, uses image height).

### Returns
- ndarray of shape (height, width, 2) or None: Coordinates for geometry distortion correction, or None if calibration data is missing.
```

--------------------------------

### ModifyFlags

Source: https://letmaik.github.io/lensfunpy/api/enums.html

Represents flags for modifying lens data. It includes options for all modifications, distortion, geometry, scale, and chromatic aberration.

```APIDOC
## ModifyFlags

### Description
An enumeration representing flags for modifying lens data. It includes options for all modifications, distortion, geometry, scale, and chromatic aberration.

### Enum Values
- **ALL** (_ = -1_)
- **DISTORTION** (_ = 8_)
- **GEOMETRY** (_ = 16_)
- **SCALE** (_ = 32_)
- **TCA** (_ = 1_)
- **VIGNETTING** (_ = 2_)
```

--------------------------------

### LensCalibDistortion

Source: https://letmaik.github.io/lensfunpy/api/namedtuples.html

Represents lens distortion calibration data. It includes the distortion model, focal length, and distortion terms.

```APIDOC
## LensCalibDistortion

### Description
Represents lens distortion calibration data.

### Parameters
- **model** (string) - The distortion model used.
- **focal** (float) - The focal length of the lens.
- **terms** (list) - A list of distortion coefficients.
```

--------------------------------

### LensType

Source: https://letmaik.github.io/lensfunpy/api/enums.html

Defines the type of lens. Supported types include Rectilinear, Fisheye, Panoramic, Equirectangular, and various Fisheye projections.

```APIDOC
## LensType

### Description
An enumeration defining the type of lens. Supported types include Rectilinear, Fisheye, Panoramic, Equirectangular, and various Fisheye projections.

### Enum Values
- **EQUIRECTANGULAR** (_ = 4_)
- **FISHEYE** (_ = 2_)
- **FISHEYE_EQUISOLID** (_ = 7_)
- **FISHEYE_ORTHOGRAPHIC** (_ = 5_)
- **FISHEYE_STEREOGRAPHIC** (_ = 6_)
- **FISHEYE_THOBY** (_ = 8_)
- **PANORAMIC** (_ = 3_)
- **RECTILINEAR** (_ = 1_)
- **UNKNOWN** (_ = 0_)
```

--------------------------------

### ModifyFlags Enumeration

Source: https://letmaik.github.io/lensfunpy/_sources/api/enums.rst.txt

The ModifyFlags enumeration represents different modification flags that can be applied.

```APIDOC
## ModifyFlags

This enumeration defines flags for modifying lens data.

### Members

- **`NONE`**: No flags set.
- **`REVERSE`**: Indicates a reverse operation.
- **`PRESERVE_ASPECT`**: Preserves the aspect ratio during modification.
- **`USE_MAX_FOV`**: Uses the maximum field of view.
- **`USE_MAX_LENSCORR`**: Uses the maximum lens correction.
- **`USE_MAX_LENSCORR_FOV`**: Uses the maximum lens correction field of view.
- **`USE_MAX_LENSCORR_FOV_REVERSE`**: Uses the maximum lens correction field of view in reverse.
- **`USE_MAX_LENSCORR_FOV_PRESERVE_ASPECT`**: Uses the maximum lens correction field of view while preserving aspect ratio.
- **`USE_MAX_LENSCORR_FOV_REVERSE_PRESERVE_ASPECT`**: Uses the maximum lens correction field of view in reverse while preserving aspect ratio.
```

--------------------------------

### DistortionModel Enumeration

Source: https://letmaik.github.io/lensfunpy/_sources/api/enums.rst.txt

The DistortionModel enumeration specifies the type of distortion model used for lens correction.

```APIDOC
## DistortionModel

This enumeration defines the distortion models available for lens correction.

### Members

- **`RADIAL`**: Radial distortion model.
- **`TILT`**: Tilt distortion model.
- **`EQUIDISTANT`**: Equidistant distortion model.
- **`THETA`**: Theta distortion model.
- **`STEREOGRAPHIC`**: Stereographic distortion model.
- **`RECTILINEAR`**: Rectilinear distortion model.
- **`FISHEYE`**: Fisheye distortion model.
```

--------------------------------

### LensCalibTCA

Source: https://letmaik.github.io/lensfunpy/api/namedtuples.html

Represents lens TCA (transverse chromatic aberration) calibration data. It includes the TCA model, focal length, and TCA terms.

```APIDOC
## LensCalibTCA

### Description
Represents lens TCA (transverse chromatic aberration) calibration data.

### Parameters
- **model** (string) - The TCA model used.
- **focal** (float) - The focal length of the lens.
- **terms** (list) - A list of TCA coefficients.
```
Tokens:
Raw