refimage 1.0.0-pre5

Imaging library. Provides image storage using CoW-like structures to avoid re-allocation in image-aquisition scenarios. Supports rich metadata and serdes.
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

use crate::{BayerPattern, ColorSpace, PixelType};

/// A trait for shifting Bayer patterns.
pub trait BayerShift {
    /// Shift the Bayer pattern by `x` and `y` pixels.
    fn shift(&self, x: usize, y: usize) -> Self;
    /// Flip the Bayer pattern horizontally.
    fn flip_horizontal(&self) -> Self;
    /// Flip the Bayer pattern vertically.
    fn flip_vertical(&self) -> Self;
}

impl BayerShift for BayerPattern {
    fn shift(&self, x: usize, y: usize) -> Self {
        match self {
            BayerPattern::Rggb => match (x % 2, y % 2) {
                (0, 0) => BayerPattern::Rggb,
                (1, 0) => BayerPattern::Gbrg,
                (0, 1) => BayerPattern::Grbg,
                (1, 1) => BayerPattern::Bggr,
                _ => unreachable!(),
            },
            BayerPattern::Gbrg => match (x % 2, y % 2) {
                (0, 0) => BayerPattern::Gbrg,
                (1, 0) => BayerPattern::Rggb,
                (0, 1) => BayerPattern::Bggr,
                (1, 1) => BayerPattern::Grbg,
                _ => unreachable!(),
            },
            BayerPattern::Grbg => match (x % 2, y % 2) {
                (0, 0) => BayerPattern::Grbg,
                (1, 0) => BayerPattern::Bggr,
                (0, 1) => BayerPattern::Rggb,
                (1, 1) => BayerPattern::Gbrg,
                _ => unreachable!(),
            },
            BayerPattern::Bggr => match (x % 2, y % 2) {
                (0, 0) => BayerPattern::Bggr,
                (1, 0) => BayerPattern::Grbg,
                (0, 1) => BayerPattern::Gbrg,
                (1, 1) => BayerPattern::Rggb,
                _ => unreachable!(),
            },
        }
    }
    fn flip_horizontal(&self) -> Self {
        match self {
            BayerPattern::Rggb => BayerPattern::Grbg,
            BayerPattern::Gbrg => BayerPattern::Bggr,
            BayerPattern::Grbg => BayerPattern::Rggb,
            BayerPattern::Bggr => BayerPattern::Gbrg,
        }
    }
    fn flip_vertical(&self) -> Self {
        match self {
            BayerPattern::Rggb => BayerPattern::Gbrg,
            BayerPattern::Gbrg => BayerPattern::Rggb,
            BayerPattern::Grbg => BayerPattern::Bggr,
            BayerPattern::Bggr => BayerPattern::Grbg,
        }
    }
}

/// Type-erased access to an image's raw sample buffer.
///
/// Implemented by [`DynamicImageRef`](crate::DynamicImageRef),
/// [`DynamicImageOwned`](crate::DynamicImageOwned),
/// [`GenericImageRef`](crate::GenericImageRef),
/// [`GenericImageOwned`](crate::GenericImageOwned) and
/// [`GenericImage`](crate::GenericImage), so the same accessors work whatever
/// concrete type a value has.
///
/// The typed accessors ([`as_slice_u16`](Self::as_slice_u16) etc.) return `None`
/// unless the image's element type matches exactly — a `u16` buffer tagged
/// 10-/12-/14-bit still reads back through [`as_slice_u16`](Self::as_slice_u16).
/// A returned slice holds [`len`](ImageProps::len) samples, which can be shorter
/// than the backing allocation.
pub trait PixelData {
    /// The whole sample buffer reinterpreted as bytes (native endianness).
    fn as_raw_u8(&self) -> &[u8];

    /// [`as_raw_u8`](Self::as_raw_u8), but `None` on a reinterpret-cast failure
    /// instead of panicking.
    fn as_raw_u8_checked(&self) -> Option<&[u8]>;

    /// The samples as `&[u8]`, or `None` unless the element type is `u8`.
    fn as_slice_u8(&self) -> Option<&[u8]>;

    /// The samples as `&[u16]`, or `None` unless the element type is `u16`.
    fn as_slice_u16(&self) -> Option<&[u16]>;

    /// The samples as `&[f32]`, or `None` unless the element type is `f32`.
    fn as_slice_f32(&self) -> Option<&[f32]>;

    /// The samples as `&mut [u8]`, or `None` unless the element type is `u8`.
    fn as_mut_slice_u8(&mut self) -> Option<&mut [u8]>;

    /// The samples as `&mut [u16]`, or `None` unless the element type is `u16`.
    fn as_mut_slice_u16(&mut self) -> Option<&mut [u16]>;

    /// The samples as `&mut [f32]`, or `None` unless the element type is `f32`.
    fn as_mut_slice_f32(&mut self) -> Option<&mut [f32]>;
}

/// A trait for accessing the properties of an image.
pub trait ImageProps {
    /// Get the width of the image.
    fn width(&self) -> usize;

    /// Get the height of the image.
    fn height(&self) -> usize;

    /// Get the number of channels in the image.
    fn channels(&self) -> u8;

    /// Get the color space of the image.
    fn color_space(&self) -> ColorSpace;

    /// Get the pixel type of the image.
    fn pixel_type(&self) -> PixelType;

    /// Get the length of the image data.
    fn len(&self) -> usize;

    /// Check if the data is empty.
    fn is_empty(&self) -> bool;
}