projective-grid 0.10.1

Image-free, target-agnostic projective grid recovery: label 2D feature points with (i, j) lattice coordinates under perspective
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

//! Error types for grid tasks.

use thiserror::Error;

use crate::lattice::LatticeKind;

/// Grid task that reported an error.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum GridTask {
    /// Recover lattice labels from features.
    Detection,
    /// Check caller-supplied coordinate hypotheses.
    Consistency,
}

/// Evidence kind supplied to a grid task.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum EvidenceKind {
    /// Position-only point features.
    Positions,
    /// Features with one local axis.
    Oriented1,
    /// Features with two local axes.
    Oriented2,
    /// Features with three local axes.
    Oriented3,
    /// Caller-supplied coordinate hypotheses.
    CoordinateHypotheses,
}

/// User-facing failure modes for projective-grid tasks.
#[derive(Clone, Debug, Error, PartialEq, Eq)]
#[non_exhaustive]
pub enum GridError {
    /// The requested task/lattice/evidence combination is intentionally not
    /// implemented yet.
    #[error("unsupported combination: task={task:?}, lattice={lattice:?}, evidence={evidence:?}")]
    UnsupportedCombination {
        /// Requested task.
        task: GridTask,
        /// Requested lattice family.
        lattice: LatticeKind,
        /// Supplied evidence kind.
        evidence: EvidenceKind,
    },
    /// There is not enough evidence to run the requested task.
    #[error("insufficient evidence")]
    InsufficientEvidence,
    /// Input slices disagree or contain duplicate/conflicting identifiers.
    #[error("inconsistent input: {0}")]
    InconsistentInput(String),
    /// Geometry is degenerate, for example all model or image points are
    /// collinear.
    #[error("degenerate geometry")]
    DegenerateGeometry,
}

/// Convenience result alias for this crate.
pub type Result<T> = std::result::Result<T, GridError>;