pix 0.15.0

Pixel / raster image library
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232

// xyz.rs        XYZ color model.
//
// Copyright (c) 2023-2024  Douglas P Lau
//
//! CIE 1931 [XYZ] color model and types.
//!
//! [XYZ]: https://en.wikipedia.org/wiki/CIE_1931_color_space#Definition_of_the_CIE_XYZ_color_space
#![allow(clippy::excessive_precision)]

use crate::ColorModel;
use crate::chan::{Ch8, Ch16, Ch32, Channel, Linear, Premultiplied, Straight};
use crate::el::{Pix, PixRgba, Pixel};
use std::ops::Range;

/// [Xyz] [color model] with D65 white point.
///
/// The components are *[X]*, *[Y]*, *[Z]* and optional *[alpha]*.
///
/// [alpha]: ../el/trait.Pixel.html#method.alpha
/// [color model]: ../trait.ColorModel.html
/// [x]: #method.x
/// [y]: #method.y
/// [z]: #method.z
/// [XYZ]: https://en.wikipedia.org/wiki/CIE_1931_color_space#Definition_of_the_CIE_XYZ_color_space
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub struct Xyz {}

impl Xyz {
    /// Get the *X* component.
    ///
    /// # Example: Xyz *X*
    /// ```
    /// use pix::chan::Ch32;
    /// use pix::xyz::{Xyz, Xyz32};
    ///
    /// let p = Xyz32::new(0.25, 0.5, 1.0);
    /// assert_eq!(Xyz::x(p), Ch32::new(0.25));
    /// ```
    pub fn x<P>(p: P) -> P::Chan
    where
        P: Pixel<Model = Self>,
    {
        p.get::<0>()
    }

    /// Get a mutable reference to the *X* component.
    ///
    /// # Example: Modify Xyz *X*
    /// ```
    /// use pix::chan::Ch32;
    /// use pix::xyz::{Xyz, Xyz32};
    ///
    /// let mut p = Xyz32::new(0.25, 0.5, 1.0);
    /// *Xyz::x_mut(&mut p) = Ch32::new(0.75);
    /// assert_eq!(Xyz::x(p), Ch32::new(0.75));
    /// ```
    pub fn x_mut<P>(p: &mut P) -> &mut P::Chan
    where
        P: Pixel<Model = Self>,
    {
        p.get_mut::<0>()
    }

    /// Get the *Y* component.
    ///
    /// # Example: Xyz *Y*
    /// ```
    /// use pix::chan::Ch16;
    /// use pix::xyz::{Xyz, Xyz16};
    ///
    /// let p = Xyz16::new(0x2000, 0x1234, 0x8000);
    /// assert_eq!(Xyz::y(p), Ch16::new(0x1234));
    /// ```
    pub fn y<P>(p: P) -> P::Chan
    where
        P: Pixel<Model = Self>,
    {
        p.get::<1>()
    }

    /// Get a mutable reference to the *Y* component.
    ///
    /// # Example: Modify Xyz *Y*
    /// ```
    /// use pix::chan::Ch16;
    /// use pix::xyz::{Xyz, Xyz16};
    ///
    /// let mut p = Xyz16::new(0x2000, 0x1234, 0x8000);
    /// *Xyz::y_mut(&mut p) = 0x4321.into();
    /// assert_eq!(Xyz::y(p), Ch16::new(0x4321));
    /// ```
    pub fn y_mut<P>(p: &mut P) -> &mut P::Chan
    where
        P: Pixel<Model = Self>,
    {
        p.get_mut::<1>()
    }

    /// Get the *Z* component.
    ///
    /// # Example: Xyz *Z*
    /// ```
    /// use pix::chan::Ch8;
    /// use pix::xyz::{Xyz, Xyz8};
    ///
    /// let p = Xyz8::new(0x93, 0x80, 0xA0);
    /// assert_eq!(Xyz::z(p), Ch8::new(0xA0));
    /// ```
    pub fn z<P>(p: P) -> P::Chan
    where
        P: Pixel<Model = Self>,
    {
        p.get::<2>()
    }

    /// Get a mutable reference to the *Z* component.
    ///
    /// # Example: Modify Xyz *Z*
    /// ```
    /// use pix::chan::Ch8;
    /// use pix::xyz::{Xyz, Xyz8};
    ///
    /// let mut p = Xyz8::new(0x88, 0x77, 0x66);
    /// *Xyz::z_mut(&mut p) = 0x55.into();
    /// assert_eq!(Xyz::z(p), Ch8::new(0x55));
    /// ```
    pub fn z_mut<P>(p: &mut P) -> &mut P::Chan
    where
        P: Pixel<Model = Self>,
    {
        p.get_mut::<2>()
    }
}

impl ColorModel for Xyz {
    const CIRCULAR: Range<usize> = 0..0;
    const LINEAR: Range<usize> = 0..3;
    const ALPHA: usize = 3;

    /// Convert into *red*, *green*, *blue* and *alpha* components
    fn into_rgba<P>(p: P) -> PixRgba<P>
    where
        P: Pixel<Model = Self>,
    {
        let px = Self::x(p).to_f32();
        let py = Self::y(p).to_f32();
        let pz = Self::z(p).to_f32();

        let red = px * 3.2406 + py * -1.5372 + pz * -0.4986;
        let green = px * -0.9689 + py * 1.8758 + pz * 0.0415;
        let blue = px * 0.0557 + py * -0.2040 + pz * 1.0570;

        PixRgba::<P>::new(red, green, blue, p.alpha().to_f32())
    }

    /// Convert from *red*, *green*, *blue* and *alpha* components
    fn from_rgba<P>(rgba: PixRgba<P>) -> P
    where
        P: Pixel<Model = Self>,
    {
        let chan = rgba.channels();
        let red = chan[0].to_f32();
        let green = chan[1].to_f32();
        let blue = chan[2].to_f32();
        let alpha = chan[3];

        let x = red * 0.4124 + green * 0.3576 + blue * 0.1805;
        let y = red * 0.2126 + green * 0.7152 + blue * 0.0722;
        let z = red * 0.0193 + green * 0.1192 + blue * 0.9505;

        P::from_channels(&[x.into(), y.into(), z.into(), alpha])
    }
}

/// [Xyz](struct.Xyz.html) 8-bit opaque (no *alpha* channel)
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Xyz8 = Pix<3, Ch8, Xyz, Straight, Linear>;

/// [Xyz](struct.Xyz.html) 16-bit opaque (no *alpha* channel)
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Xyz16 = Pix<3, Ch16, Xyz, Straight, Linear>;

/// [Xyz](struct.Xyz.html) 32-bit opaque (no *alpha* channel)
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Xyz32 = Pix<3, Ch32, Xyz, Straight, Linear>;

/// [Xyz](struct.Xyz.html) 8-bit
/// [straight](../chan/struct.Straight.html) alpha
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Xyza8 = Pix<4, Ch8, Xyz, Straight, Linear>;

/// [Xyz](struct.Xyz.html) 16-bit
/// [straight](../chan/struct.Straight.html) alpha
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Xyza16 = Pix<4, Ch16, Xyz, Straight, Linear>;

/// [Xyz](struct.Xyz.html) 32-bit
/// [straight](../chan/struct.Straight.html) alpha
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Xyza32 = Pix<4, Ch32, Xyz, Straight, Linear>;

/// [Xyz](struct.Xyz.html) 8-bit
/// [premultiplied](../chan/struct.Premultiplied.html) alpha
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Xyza8p = Pix<4, Ch8, Xyz, Premultiplied, Linear>;

/// [Xyz](struct.Xyz.html) 16-bit
/// [premultiplied](../chan/struct.Premultiplied.html) alpha
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Xyza16p = Pix<4, Ch16, Xyz, Premultiplied, Linear>;

/// [Xyz](struct.Xyz.html) 32-bit
/// [premultiplied](../chan/struct.Premultiplied.html) alpha
/// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html)
/// format.
pub type Xyza32p = Pix<4, Ch32, Xyz, Premultiplied, Linear>;

#[cfg(test)]
mod test {
    #[test]
    fn xyz_to_rgb() {
        // TODO
    }
}