DistortionCoefficients.cs

Go to the documentation of this file.

using System.Collections;
using System.Globalization;
using IDSImaging.Peak.ICV.Backend;
 
namespace IDSImaging.Peak.ICV.Algorithms.Calibration;
 
public class DistortionCoefficients : IEquatable<DistortionCoefficients>
{
    public const int RadialDistortionMaxElements = 6;
 
    public const int TangentialDistortionMaxElements = 2;
 
    public const int PrismDistortionMaxElements = 4;
 
    public const int TiltDistortionMaxElements = 2;
 
    public DistortionCoefficients(double[] radialDistortion, double[] tangentialDistortion)
    {
        RadialDistortion = radialDistortion;
        TangentialDistortion = tangentialDistortion;
        PrismDistortion = Array.Empty<double>();
        TiltDistortion = Array.Empty<double>();
 
        ValidateArraySizes(RadialDistortion, TangentialDistortion, PrismDistortion, TiltDistortion);
    }
 
    public DistortionCoefficients(
        double[] radialDistortion,
        double[] tangentialDistortion,
        double[] prismDistortion)
    {
        RadialDistortion = radialDistortion;
        TangentialDistortion = tangentialDistortion;
        PrismDistortion = prismDistortion;
        TiltDistortion = Array.Empty<double>();
 
        ValidateArraySizes(RadialDistortion, TangentialDistortion, PrismDistortion, TiltDistortion);
    }
 
    public DistortionCoefficients(
        double[] radialDistortion,
        double[] tangentialDistortion,
        double[] prismDistortion,
        double[] tiltDistortion)
    {
        RadialDistortion = radialDistortion;
        TangentialDistortion = tangentialDistortion;
        PrismDistortion = prismDistortion;
        TiltDistortion = tiltDistortion;
 
        ValidateArraySizes(RadialDistortion, TangentialDistortion, PrismDistortion, TiltDistortion);
    }
 
    internal DistortionCoefficients(Backend.Types.peak_icv_distortion_coefficients distortionCoefficients)
    {
        unsafe
        {
            RadialDistortion = Utils.FromFixedArray(distortionCoefficients.radial_distortion.coefficients,
                RadialDistortionMaxElements);
            TangentialDistortion = Utils.FromFixedArray(
                distortionCoefficients.tangential_distortion.coefficients,
                TangentialDistortionMaxElements);
            PrismDistortion = Utils.FromFixedArray(distortionCoefficients.prism_distortion.coefficients,
                PrismDistortionMaxElements);
            TiltDistortion = Utils.FromFixedArray(distortionCoefficients.tilt_distortion.coefficients,
                TiltDistortionMaxElements);
        }
    }
 
    public double[] PrismDistortion { get; }
 
    public double[] RadialDistortion { get; }
 
    public double[] TangentialDistortion { get; }
 
    public double[] TiltDistortion { get; }
 
    public bool Equals(DistortionCoefficients? other)
    {
        if (ReferenceEquals(other, null)) return false;
        return RadialDistortion.SequenceEqual(other.RadialDistortion) &&
               TangentialDistortion.SequenceEqual(other.TangentialDistortion) &&
               PrismDistortion.SequenceEqual(other.PrismDistortion) &&
               TiltDistortion.SequenceEqual(other.TiltDistortion);
    }
 
    public override bool Equals(object? other)
    {
        if (other is null) return false;
        if (ReferenceEquals(this, other)) return true;
        return Equals(other as DistortionCoefficients);
    }
 
    public override int GetHashCode()
    {
        return (
            StructuralComparisons.StructuralEqualityComparer.GetHashCode(RadialDistortion),
            StructuralComparisons.StructuralEqualityComparer.GetHashCode(TangentialDistortion),
            StructuralComparisons.StructuralEqualityComparer.GetHashCode(PrismDistortion),
            StructuralComparisons.StructuralEqualityComparer.GetHashCode(TiltDistortion)).GetHashCode();
    }
 
    public override string ToString()
    {
        return "Radial: " + FormatDistortion(RadialDistortion) + ", " +
               "Tangential: " + FormatDistortion(TangentialDistortion) + ", " +
               "Prism: " + FormatDistortion(PrismDistortion) + ", " +
               "Tilt: " + FormatDistortion(TiltDistortion);
 
        string FormatDistortion(double[] distortionArray)
        {
            return "(" + string.Join(", ",
                distortionArray.Select(d => d.ToString("0.0", CultureInfo.InvariantCulture))) + ")";
        }
    }
 
    internal Backend.Types.peak_icv_distortion_coefficients ToCType()
    {
        unsafe
        {
            var result = new Backend.Types.peak_icv_distortion_coefficients();
 
            Utils.ToFixedArray(RadialDistortion, result.radial_distortion.coefficients);
            Utils.ToFixedArray(TangentialDistortion, result.tangential_distortion.coefficients);
            Utils.ToFixedArray(PrismDistortion, result.prism_distortion.coefficients);
            Utils.ToFixedArray(TiltDistortion, result.tilt_distortion.coefficients);
 
            return result;
        }
    }
 
    private static void ValidateArraySizes(
        double[] radialDistortion,
        double[] tangentialDistortion,
        double[] prismDistortion,
        double[] tiltDistortion)
    {
        ValidateSize(radialDistortion, RadialDistortionMaxElements, "radial distortion");
        ValidateSize(tangentialDistortion, TangentialDistortionMaxElements, " tangential distortion");
        ValidateSize(prismDistortion, PrismDistortionMaxElements, "prism distortion");
        ValidateSize(tiltDistortion, TiltDistortionMaxElements, "tilt distortion");
        return;
 
        void ValidateSize(double[] distortionArray, int maxSize, string name)
        {
            if (distortionArray.Length > maxSize)
            {
                throw new IcvNotPossibleException(
                    $"The given {name} array size is incorrect. Expected to be smaller than or equal to size: {maxSize}, but got: {distortionArray.Length}.");
            }
        }
    }
}