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

//! Template storage and planning utilities.

use crate::bank::{CompileConfig, CompiledTemplate};
use crate::image::{ImageView, OwnedImage};
use crate::util::CorrMatchResult;

mod plan;
pub mod rotate;

pub use plan::ValidCoord;
pub use plan::{MaskedSsdTemplatePlan, MaskedTemplatePlan, SsdTemplatePlan, TemplatePlan};

/// Owned template image in contiguous grayscale format.
///
/// Use `Template::compile` to build reusable assets for matching.
pub struct Template {
    img: OwnedImage,
}

impl Template {
    /// Creates a template from a contiguous grayscale buffer.
    pub fn new(data: Vec<u8>, width: usize, height: usize) -> CorrMatchResult<Self> {
        let img = OwnedImage::new(data, width, height)?;
        Ok(Self { img })
    }

    /// Returns the template width.
    pub fn width(&self) -> usize {
        self.img.width()
    }

    /// Returns the template height.
    pub fn height(&self) -> usize {
        self.img.height()
    }

    /// Returns a borrowed view of the template data.
    pub fn view(&self) -> ImageView<'_, u8> {
        self.img.view()
    }

    /// Compiles template assets for matching with rotation support.
    ///
    /// For translation-only matching, use `CompiledTemplate::compile_unrotated`.
    pub fn compile(&self, cfg: CompileConfig) -> CorrMatchResult<CompiledTemplate> {
        CompiledTemplate::compile_rotated(self, cfg)
    }
}