corrmatch 0.1.0

CPU-first template matching with ZNCC/SSD and coarse-to-fine pyramid search
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

//! Error types for corrmatch.

use thiserror::Error;

/// Result alias for corrmatch operations.
pub type CorrMatchResult<T> = std::result::Result<T, CorrMatchError>;

/// Errors that can occur when running corrmatch operations.
#[derive(Error, Debug, Clone, PartialEq, Eq)]
pub enum CorrMatchError {
    /// The provided dimensions are invalid (must be non-zero).
    #[error("invalid dimensions: width={width} height={height}")]
    InvalidDimensions { width: usize, height: usize },
    /// The provided stride is smaller than the image width.
    #[error("invalid stride: width={width} stride={stride}")]
    InvalidStride { width: usize, stride: usize },
    /// The backing buffer is too small for the requested view.
    #[error("buffer too small: needed={needed} got={got}")]
    BufferTooSmall { needed: usize, got: usize },
    /// The requested ROI lies outside the image bounds.
    #[error(
        "roi out of bounds: x={x} y={y} width={width} height={height} img_width={img_width} img_height={img_height}"
    )]
    RoiOutOfBounds {
        x: usize,
        y: usize,
        width: usize,
        height: usize,
        img_width: usize,
        img_height: usize,
    },
    /// The template is degenerate and cannot be normalized.
    #[error("degenerate template: {reason}")]
    DegenerateTemplate { reason: &'static str },
    /// The requested angle grid parameters are invalid.
    #[error("invalid angle grid: {reason}")]
    InvalidAngleGrid { reason: &'static str },
    /// The requested index is out of bounds for a collection.
    #[error("index out of bounds: {context} index={index} len={len}")]
    IndexOutOfBounds {
        index: usize,
        len: usize,
        context: &'static str,
    },
    /// The search did not produce any valid candidates.
    #[error("no candidates: {reason}")]
    NoCandidates { reason: &'static str },
    /// The requested metric is not supported yet.
    #[error("unsupported metric: {metric}")]
    UnsupportedMetric { metric: &'static str },
    /// Rotation assets are unavailable for the requested operation.
    #[error("rotation unavailable: {reason}")]
    RotationUnavailable { reason: &'static str },
    /// Image I/O failed.
    #[error("image io error: {reason}")]
    ImageIo { reason: String },
    /// Parallel execution requested but rayon feature is not enabled.
    #[error("parallel execution requested but rayon feature is not enabled")]
    ParallelUnavailable,
    /// Invalid configuration parameter.
    #[error("invalid config: {reason}")]
    InvalidConfig { reason: &'static str },
}