aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/SideChains/Colourful/Implementation/Conversion/RGB/XYZToLinearRGBConverter.cs
blob: 9f3a548d24c96ad34a395acbdaf32dbbc52b0995 (plain)
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
using Matrix = System.Collections.Generic.IReadOnlyList<System.Collections.Generic.IReadOnlyList<double>>;

namespace Colourful.Implementation.Conversion
{
    /// <summary>
    /// Converts from <see cref="XYZColor" /> to <see cref="LinearRGBColor" />.
    /// </summary>
    /// <remarks>
    /// The target RGB working space is <see cref="RGBColor.DefaultWorkingSpace" /> when not set.
    /// </remarks>
    public sealed class XYZToLinearRGBConverter : LinearRGBAndXYZConverterBase, IColorConversion<XYZColor, LinearRGBColor>
    {
        private readonly Matrix _conversionMatrix;

        /// <summary>
        /// Constructs with <see cref="RGBColor.DefaultWorkingSpace" />.
        /// </summary>
        public XYZToLinearRGBConverter() : this(null)
        {
        }

        /// <summary>
        /// Constructs with arbitrary working space.
        /// </summary>
        public XYZToLinearRGBConverter(IRGBWorkingSpace targetRGBWorkingSpace)
        {
            TargetRGBWorkingSpace = targetRGBWorkingSpace ?? RGBColor.DefaultWorkingSpace;
            _conversionMatrix = GetXYZToRGBMatrix(TargetRGBWorkingSpace);
        }

        /// <summary>
        /// Target RGB working space. When not set, target RGB working space is <see cref="RGBColor.DefaultWorkingSpace" />.
        /// </summary>
        public IRGBWorkingSpace TargetRGBWorkingSpace { get; }

        /// <summary>
        /// Converts from <see cref="XYZColor" /> to <see cref="LinearRGBColor" />.
        /// </summary>
        public LinearRGBColor Convert(in XYZColor input)
        {
            var inputVector = input.Vector;
            var uncompandedVector = _conversionMatrix.MultiplyBy(inputVector).CropRange(0, 1);
            var result = new LinearRGBColor(uncompandedVector, TargetRGBWorkingSpace);
            return result;
        }

        #region Overrides

        /// <inheritdoc cref="object" />
        public bool Equals(XYZToLinearRGBConverter other)
        {
            if (other == null)
                return false;

            return ReferenceEquals(this, other) || TargetRGBWorkingSpace.Equals(other.TargetRGBWorkingSpace);
        }

        /// <inheritdoc cref="object" />
        public override bool Equals(object obj) => obj is XYZToLinearRGBConverter other && Equals(other);

        /// <inheritdoc cref="object" />
        public override int GetHashCode() => TargetRGBWorkingSpace?.GetHashCode() ?? 0;

        /// <inheritdoc cref="object" />
        public static bool operator ==(XYZToLinearRGBConverter left, XYZToLinearRGBConverter right) => Equals(left, right);

        /// <inheritdoc cref="object" />
        public static bool operator !=(XYZToLinearRGBConverter left, XYZToLinearRGBConverter right) => !Equals(left, right);

        #endregion
    }
}