eccodes 0.13.1

Unofficial high-level Rust bindings of the latest ecCodes release
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

#![cfg_attr(docsrs, doc(cfg(feature = "message_ndarray")))]
//! Definitions for converting a `KeyedMessage` to ndarray

use ndarray::{s, Array2, Array3};

use crate::{errors::MessageNdarrayError, CodesError, KeyRead, KeyedMessage};

/// Struct returned by [`KeyedMessage::to_lons_lats_values()`] method.
/// The arrays are collocated, meaning that `longitudes[i, j]` and `latitudes[i, j]` are the coordinates of `values[i, j]`.
#[derive(Clone, PartialEq, Debug, Default)]
#[cfg_attr(docsrs, doc(cfg(feature = "message_ndarray")))]
pub struct RustyCodesMessage {
    /// Longitudes in degrees
    pub longitudes: Array2<f64>,
    /// Latitudes in degrees
    pub latitudes: Array2<f64>,
    /// Values in native GRIB units
    pub values: Array2<f64>,
}

impl KeyedMessage {
    /// Converts the message to a 2D ndarray.
    ///
    /// Returns ndarray where first dimension represents y coordinates and second dimension represents x coordinates,
    /// ie. `[lat, lon]`.
    ///
    /// Common convention for grib files on regular lon-lat grid assumes that:
    /// index `[0, 0]` is the top-left corner of the grid:
    /// x coordinates are increasing with the i index,
    /// y coordinates are decreasing with the j index.
    ///
    /// This convention can be checked with `iScansNegatively` and `jScansPositively` keys -
    /// if both are false, the above convention is used.
    ///
    /// Requires the keys `Ni`, `Nj` and `values` to be present in the message.
    ///
    /// Tested only with simple lat-lon grids.
    ///
    /// # Errors
    ///
    /// - When the required keys are not present or if their values are not of the expected type
    /// - When the number of values mismatch with the `Ni` and `Nj` keys
    #[cfg_attr(docsrs, doc(cfg(feature = "message_ndarray")))]
    pub fn to_ndarray(&self) -> Result<Array2<f64>, CodesError> {
        let ni: i64 = self.read_key("Ni")?;
        let ni = usize::try_from(ni).map_err(MessageNdarrayError::from)?;

        let nj: i64 = self.read_key("Nj")?;
        let nj = usize::try_from(nj).map_err(MessageNdarrayError::from)?;

        let vals: Vec<f64> = self.read_key("values")?;
        if vals.len() != (ni * nj) {
            return Err(MessageNdarrayError::UnexpectedValuesLength(vals.len(), ni * nj).into());
        }

        let j_scanning: i64 = self.read_key("jPointsAreConsecutive")?;

        if ![0, 1].contains(&j_scanning) {
            return Err(MessageNdarrayError::UnexpectedKeyValue(
                "jPointsAreConsecutive".to_owned(),
            )
            .into());
        }

        let j_scanning = j_scanning != 0;

        let shape = if j_scanning { (ni, nj) } else { (nj, ni) };
        let vals = Array2::from_shape_vec(shape, vals).map_err(MessageNdarrayError::from)?;

        if j_scanning {
            Ok(vals.reversed_axes())
        } else {
            Ok(vals)
        }
    }

    /// Same as [`KeyedMessage::to_ndarray()`] but returns the longitudes and latitudes alongside values.
    /// Fields are returned as separate arrays in [`RustyCodesMessage`].
    ///
    /// Compared to `to_ndarray` this method has performance overhead as returned arrays may be cloned.
    ///
    /// This method requires the `latLonValues`, `Ni` and `Nj` keys to be present in the message.
    ///
    /// # Errors
    ///
    /// - When the required keys are not present or if their values are not of the expected type
    /// - When the number of values mismatch with the `Ni` and `Nj` keys
    #[cfg_attr(docsrs, doc(cfg(feature = "message_ndarray")))]
    pub fn to_lons_lats_values(&self) -> Result<RustyCodesMessage, CodesError> {
        let ni: i64 = self.read_key("Ni")?;
        let ni = usize::try_from(ni).map_err(MessageNdarrayError::from)?;

        let nj: i64 = self.read_key("Nj")?;
        let nj = usize::try_from(nj).map_err(MessageNdarrayError::from)?;

        let latlonvals: Vec<f64> = self.read_key("latLonValues")?;

        if latlonvals.len() != (ni * nj * 3) {
            return Err(
                MessageNdarrayError::UnexpectedValuesLength(latlonvals.len(), ni * nj * 3).into(),
            );
        }

        let j_scanning: i64 = self.read_key("jPointsAreConsecutive")?;

        if ![0, 1].contains(&j_scanning) {
            return Err(MessageNdarrayError::UnexpectedKeyValue(
                "jPointsAreConsecutive".to_owned(),
            )
            .into());
        }

        let j_scanning = j_scanning != 0;

        let shape = if j_scanning {
            (ni, nj, 3_usize)
        } else {
            (nj, ni, 3_usize)
        };

        let mut latlonvals =
            Array3::from_shape_vec(shape, latlonvals).map_err(MessageNdarrayError::from)?;

        if j_scanning {
            latlonvals.swap_axes(0, 1);
        }

        let (lats, lons, vals) =
            latlonvals
                .view_mut()
                .multi_slice_move((s![.., .., 0], s![.., .., 1], s![.., .., 2]));

        Ok(RustyCodesMessage {
            longitudes: lons.into_owned(),
            latitudes: lats.into_owned(),
            values: vals.into_owned(),
        })
    }
}

#[cfg(test)]
mod tests {
    use float_cmp::assert_approx_eq;

    use super::*;
    use crate::codes_handle::CodesHandle;
    use crate::DynamicKeyType;
    use crate::FallibleStreamingIterator;
    use crate::ProductKind;
    use std::path::Path;

    #[test]
    fn test_to_ndarray() -> Result<(), CodesError> {
        let file_path = Path::new("./data/iceland-surface.grib");
        let mut handle = CodesHandle::new_from_file(file_path, ProductKind::GRIB)?;

        while let Some(msg) = handle.next()? {
            if msg.read_key_dynamic("shortName")? == DynamicKeyType::Str("2d".to_string()) {
                let ndarray = msg.to_ndarray()?;

                // values from xarray
                assert_approx_eq!(f64, ndarray[[0, 0]], 276.37793, epsilon = 0.000_1);
                assert_approx_eq!(f64, ndarray[[0, 48]], 276.65723, epsilon = 0.000_1);
                assert_approx_eq!(f64, ndarray[[16, 0]], 277.91113, epsilon = 0.000_1);
                assert_approx_eq!(f64, ndarray[[16, 48]], 280.34277, epsilon = 0.000_1);
                assert_approx_eq!(f64, ndarray[[5, 5]], 276.03418, epsilon = 0.000_1);
                assert_approx_eq!(f64, ndarray[[10, 10]], 277.59082, epsilon = 0.000_1);
                assert_approx_eq!(f64, ndarray[[15, 15]], 277.68652, epsilon = 0.000_1);
                assert_approx_eq!(f64, ndarray[[8, 37]], 273.2744, epsilon = 0.000_1);

                break;
            }
        }

        Ok(())
    }

    #[test]
    fn test_lons_lats() -> Result<(), CodesError> {
        let file_path = Path::new("./data/iceland-surface.grib");
        let mut handle = CodesHandle::new_from_file(file_path, ProductKind::GRIB)?;

        while let Some(msg) = handle.next()? {
            if msg.read_key_dynamic("shortName")? == DynamicKeyType::Str("2d".to_string()) {
                let rmsg = msg.to_lons_lats_values()?;

                let vals = rmsg.values;
                let lons = rmsg.longitudes;
                let lats = rmsg.latitudes;

                // values from cfgrib
                assert_approx_eq!(f64, vals[[0, 0]], 276.37793, epsilon = 0.000_1);
                assert_approx_eq!(f64, vals[[0, 48]], 276.65723, epsilon = 0.000_1);
                assert_approx_eq!(f64, vals[[16, 0]], 277.91113, epsilon = 0.000_1);
                assert_approx_eq!(f64, vals[[16, 48]], 280.34277, epsilon = 0.000_1);
                assert_approx_eq!(f64, vals[[5, 5]], 276.03418, epsilon = 0.000_1);
                assert_approx_eq!(f64, vals[[10, 10]], 277.59082, epsilon = 0.000_1);
                assert_approx_eq!(f64, vals[[15, 15]], 277.68652, epsilon = 0.000_1);
                assert_approx_eq!(f64, vals[[8, 37]], 273.2744, epsilon = 0.000_1);

                assert_approx_eq!(f64, lons[[0, 0]], -25.0);
                assert_approx_eq!(f64, lons[[0, 48]], -13.0);
                assert_approx_eq!(f64, lons[[16, 0]], -25.0);
                assert_approx_eq!(f64, lons[[16, 48]], -13.0);
                assert_approx_eq!(f64, lons[[5, 5]], -23.75);
                assert_approx_eq!(f64, lons[[10, 10]], -22.5);
                assert_approx_eq!(f64, lons[[15, 15]], -21.25);
                assert_approx_eq!(f64, lons[[8, 37]], -15.75);

                assert_approx_eq!(f64, lats[[0, 0]], 67.0);
                assert_approx_eq!(f64, lats[[0, 48]], 67.0);
                assert_approx_eq!(f64, lats[[16, 0]], 63.0);
                assert_approx_eq!(f64, lats[[16, 48]], 63.0);
                assert_approx_eq!(f64, lats[[5, 5]], 65.75);
                assert_approx_eq!(f64, lats[[10, 10]], 64.5);
                assert_approx_eq!(f64, lats[[15, 15]], 63.25);
                assert_approx_eq!(f64, lats[[8, 37]], 65.0);

                break;
            }
        }

        Ok(())
    }
}