Skip to main content

PinholeCamera

Struct PinholeCamera 

Source
pub struct PinholeCamera {
    pub fx: f64,
    pub fy: f64,
    pub cx: f64,
    pub cy: f64,
    pub k1: f64,
    pub k2: f64,
    pub p1: f64,
    pub p2: f64,
}
Expand description

Pinhole camera with radial and tangential (Brown–Conrady) distortion.

Coordinate convention: X right, Y down, Z forward (optical axis). Projection (ideal): u = fx * X/Z + cx, v = fy * Y/Z + cy.

Distortion model (normalised coordinates xn = X/Z, yn = Y/Z):

r² = xn² + yn²
xd = xn*(1 + k1*r² + k2*r⁴) + 2*p1*xn*yn + p2*(r² + 2*xn²)
yd = yn*(1 + k1*r² + k2*r⁴) + p1*(r² + 2*yn²) + 2*p2*xn*yn
u = fx*xd + cx,  v = fy*yd + cy

Fields§

§fx: f64

Focal length in pixels along X.

§fy: f64

Focal length in pixels along Y.

§cx: f64

Principal point X (pixels).

§cy: f64

Principal point Y (pixels).

§k1: f64

Radial distortion coefficient k1.

§k2: f64

Radial distortion coefficient k2.

§p1: f64

Tangential distortion coefficient p1.

§p2: f64

Tangential distortion coefficient p2.

Implementations§

Source§

impl PinholeCamera

Source

pub fn new( fx: f64, fy: f64, cx: f64, cy: f64, k1: f64, k2: f64, p1: f64, p2: f64, ) -> Self

Create a new camera with all parameters explicit.

Source

pub fn ideal(fx: f64, fy: f64, cx: f64, cy: f64) -> Self

Create a camera with no distortion (k1=k2=p1=p2=0).

Source

pub fn project(&self, point_3d: &[f64; 3]) -> Result<[f64; 2]>

Project a 3-D point to a 2-D pixel using the ideal pinhole model (distortion coefficients are ignored).

Returns Err if Z ≤ 0.

§Example
use scirs2_vision::camera::PinholeCamera;

let cam = PinholeCamera::ideal(800.0, 800.0, 320.0, 240.0);
let px = cam.project(&[0.0, 0.0, 1.0]).unwrap();
assert!((px[0] - 320.0).abs() < 1e-9);
assert!((px[1] - 240.0).abs() < 1e-9);
Source

pub fn project_distorted(&self, point_3d: &[f64; 3]) -> Result<[f64; 2]>

Project a 3-D point to a 2-D pixel applying radial and tangential distortion.

Returns Err if Z ≤ 0.

§Example
use scirs2_vision::camera::PinholeCamera;

let cam = PinholeCamera::new(800.0, 800.0, 320.0, 240.0, 0.1, 0.0, 0.0, 0.0);
let px = cam.project_distorted(&[0.0, 0.0, 1.0]).unwrap();
// On the principal axis distortion has no effect.
assert!((px[0] - 320.0).abs() < 1e-9);
assert!((px[1] - 240.0).abs() < 1e-9);
Source

pub fn backproject(&self, pixel: &[f64; 2], depth: f64) -> [f64; 3]

Back-project a 2-D pixel plus a known depth into a 3-D point (inverse of the ideal projection, distortion not reversed here).

§Arguments
  • pixel[u, v] pixel coordinates.
  • depth – depth along the optical axis (Z), must be positive.
§Example
use scirs2_vision::camera::PinholeCamera;

let cam = PinholeCamera::ideal(800.0, 800.0, 320.0, 240.0);
let pt = cam.backproject(&[320.0, 240.0], 5.0);
assert!((pt[2] - 5.0).abs() < 1e-9);
Source

pub fn undistort_point(&self, pixel: &[f64; 2]) -> [f64; 2]

Iteratively undistort a distorted pixel coordinate.

Uses Newton-style fixed-point iteration (max 20 steps) to invert the Brown–Conrady distortion model.

§Example
use scirs2_vision::camera::PinholeCamera;

let cam = PinholeCamera::new(800.0, 800.0, 320.0, 240.0, 0.1, 0.0, 0.0, 0.0);
// A point on the principal axis is unaffected by distortion.
let undist = cam.undistort_point(&[320.0, 240.0]);
assert!((undist[0] - 320.0).abs() < 1e-9);
assert!((undist[1] - 240.0).abs() < 1e-9);
Source

pub fn intrinsic_matrix(&self) -> Array2<f64>

Return the 3×3 intrinsic (calibration) matrix K as an Array2<f64>.

K = [[fx,  0, cx],
     [ 0, fy, cy],
     [ 0,  0,  1]]
§Example
use scirs2_vision::camera::PinholeCamera;

let cam = PinholeCamera::ideal(400.0, 400.0, 200.0, 150.0);
let k = cam.intrinsic_matrix();
assert_eq!(k.shape(), &[3, 3]);
assert!((k[[0, 0]] - 400.0).abs() < 1e-9);
Source

pub fn distortion_coeffs(&self) -> [f64; 4]

Distortion coefficient vector [k1, k2, p1, p2].

Trait Implementations§

Source§

impl Clone for PinholeCamera

Source§

fn clone(&self) -> PinholeCamera

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PinholeCamera

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for PinholeCamera

Source§

fn eq(&self, other: &PinholeCamera) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PinholeCamera

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more