imgal 0.2.0

A fast and open-source scientific image processing and algorithm 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

use std::error;
use std::fmt;

#[derive(Debug, Clone, PartialEq)]
pub enum ImgalError {
    InvalidAxis {
        axis_idx: usize,
        dim_len: usize,
    },
    InvalidAxisValueGreaterEqual {
        arr_name: &'static str,
        axis_idx: usize,
        value: usize,
    },
    InvalidGeneric {
        msg: &'static str,
    },
    InvalidParameterEmptyArray {
        param_name: &'static str,
    },
    InvalidParameterValueEqual {
        param_name: &'static str,
        value: usize,
    },
    InvalidParameterValueGreater {
        param_name: &'static str,
        value: usize,
    },
    InvalidParameterValueLess {
        param_name: &'static str,
        value: usize,
    },
    InvalidParameterValueOutsideRange {
        param_name: &'static str,
        value: f64,
        min: f64,
        max: f64,
    },
    InvalidSum {
        expected: f64,
        got: f64,
    },
    MismatchedArrayLengths {
        a_arr_name: &'static str,
        a_arr_len: usize,
        b_arr_name: &'static str,
        b_arr_len: usize,
    },
    MismatchedArrayShapes {
        shape_a: Vec<usize>,
        shape_b: Vec<usize>,
    },
}

impl fmt::Display for ImgalError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ImgalError::InvalidAxis { axis_idx, dim_len } => {
                write!(
                    f,
                    "Invalid axis, axis {} is out of bounds for dimension length {}.",
                    axis_idx, dim_len
                )
            }
            ImgalError::InvalidAxisValueGreaterEqual {
                arr_name,
                axis_idx,
                value,
            } => {
                write!(
                    f,
                    "Invalid axis value, axis {} of \"{}\" can not be greater than or equal to {}.",
                    axis_idx, arr_name, value
                )
            }
            ImgalError::InvalidGeneric { msg } => {
                write!(f, "{}", msg)
            }
            ImgalError::InvalidParameterEmptyArray { param_name } => {
                write!(
                    f,
                    "Invalid array parameter, the array \"{}\" can not be empty.",
                    param_name
                )
            }
            ImgalError::InvalidParameterValueEqual { param_name, value } => {
                write!(
                    f,
                    "Invalid parameter value, the parameter {} can not equal {}.",
                    param_name, value
                )
            }
            ImgalError::InvalidParameterValueGreater { param_name, value } => {
                write!(
                    f,
                    "Invalid parameter value, the parameter {} can not be greater than {}.",
                    param_name, value
                )
            }
            ImgalError::InvalidParameterValueLess { param_name, value } => {
                write!(
                    f,
                    "Invalid parameter value, the parameter {} can not be less than {}.",
                    param_name, value
                )
            }
            ImgalError::InvalidParameterValueOutsideRange {
                param_name,
                value,
                min,
                max,
            } => {
                write!(
                    f,
                    "Invalid parameter value, the parameter {} must be a value between {} and {} but got {}.",
                    param_name, min, max, value
                )
            }
            ImgalError::InvalidSum { expected, got } => {
                write!(f, "Invalid sum, expected {} but got {}.", expected, got)
            }
            ImgalError::MismatchedArrayLengths {
                a_arr_name,
                a_arr_len,
                b_arr_name,
                b_arr_len,
            } => {
                write!(
                    f,
                    "Mismatched array lengths, \"{}\" of length {} and \"{}\" of length {} do not match.",
                    a_arr_name, a_arr_len, b_arr_name, b_arr_len
                )
            }
            ImgalError::MismatchedArrayShapes { shape_a, shape_b } => {
                write!(
                    f,
                    "Mismatched array shapes, {:?} and {:?}, do not match.",
                    shape_a, shape_b
                )
            }
        }
    }
}

impl error::Error for ImgalError {}