eorst 1.0.1

Earth Observation and Remote Sensing Toolkit - library for raster processing pipelines
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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
//! Selection and aggregation traits for raster data.
//!
//! This module provides traits for selecting layers and time slices from raster data,
//! stacking shapes, and computing aggregations along dimensions.

use crate::core_types::{RasterData, RasterType};
use crate::data_sources::DateType;
use crate::metadata::{RasterDataBlock, RasterMetadata};
use crate::types::{Dimension, RasterDataShape};
use anyhow::Result;
use gdal::raster::GdalType;
use ndarray::{Array2, Array3, Axis};
use num_traits::{FromPrimitive, ToPrimitive};
use std::fmt::{self, Debug};
use std::ops::{Add, Div, Index, IndexMut};

/// Trait for stacking RasterDataShapes.
pub trait Stack {
    /// Stacks another shape along a dimension.
    fn stack(&mut self, other: RasterDataShape, dim_to_stack: Dimension) -> &mut RasterDataShape;
    /// Extends the time dimension.
    fn extend(&mut self, other: RasterDataShape) -> &mut RasterDataShape;
}

impl Stack for RasterDataShape {
    fn extend(&mut self, other: RasterDataShape) -> &mut RasterDataShape {
        let mut extendable = true;

        for dim_loc in 1..4 {
            if self[dim_loc] != other[dim_loc] {
                extendable = false
            }
        }

        if extendable {
            self[0] += other[0];
            self
        } else {
            panic!("Unable to extend layers");
        }
    }

    fn stack(&mut self, other: RasterDataShape, dim_to_stack: Dimension) -> &mut RasterDataShape {
        let dimension_axis = dim_to_stack.get_axis();
        let mut stackable = true;
        for dim_loc in 0..4 {
            if dim_loc != dimension_axis && self[dim_loc] != other[dim_loc] {
                stackable = false;
            }
        }

        if stackable {
            self[dimension_axis] += other[dimension_axis];
            self
        } else {
            panic!("Unable to stack layers");
        }
    }
}

impl Dimension {
    /// Returns the axis index for this dimension.
    pub fn get_axis(&self) -> usize {
        match self {
            Dimension::Layer => 1,
            Dimension::Time => 0,
        }
    }
}

impl Index<usize> for RasterDataShape {
    type Output = usize;

    fn index(&self, index: usize) -> &usize {
        match index {
            0 => &self.times,
            1 => &self.layers,
            2 => &self.rows,
            3 => &self.cols,
            n => panic!("Invalid index: {}", n),
        }
    }
}

impl IndexMut<usize> for RasterDataShape {
    fn index_mut(&mut self, index: usize) -> &mut usize {
        match index {
            0 => &mut self.times,
            1 => &mut self.layers,
            2 => &mut self.rows,
            3 => &mut self.cols,
            n => panic!("Invalid index: {}", n),
        }
    }
}

/// Trait for summing values along a specific dimension.
pub trait SumDimension<T>
where
    T: GdalType + num_traits::identities::Zero + Copy + FromPrimitive + Add<Output = T> + Div<Output = T>,
{
    /// Sums all values along the given dimension.
    fn sum_dimension(&self, dimension: Dimension) -> Array3<T>;
}

impl<T> SumDimension<T> for RasterData<T>
where
    T: RasterType + FromPrimitive + Add<Output = T> + Div<Output = T>,
{
    fn sum_dimension(&self, dimension: Dimension) -> Array3<T> {
        match dimension {
            Dimension::Layer => self.sum_axis(Axis(1)),
            Dimension::Time => self.sum_axis(Axis(0)),
        }
    }
}

#[allow(dead_code)]
pub(crate) trait MeanDimension<T>
where
    T: RasterType + FromPrimitive + Add<Output = T> + Div<Output = T>,
{
    fn mean_dimension(&self, dimension: Dimension) -> Array3<T>;
}

impl<T> MeanDimension<T> for RasterData<T>
where
    T: RasterType + FromPrimitive + Add<Output = T> + Div<Output = T>,
{
    fn mean_dimension(&self, dimension: Dimension) -> Array3<T> {
        let mean = match dimension {
            Dimension::Layer => self.mean_axis(Axis(1)),
            Dimension::Time => self.mean_axis(Axis(0)),
        };
        mean.unwrap()
    }
}

/// Trait for computing variance along a specific dimension.
pub trait VarDimension<T>
where
    T: RasterType + FromPrimitive + Add<Output = T> + Div<Output = T> + num_traits::Float,
{
    /// Computes variance along the given dimension.
    /// `ddof` is the delta degrees of freedom (0 for population, 1 for sample).
    fn var_dimension(&self, ddof: T, dimension: Dimension) -> Array3<T>;
}

impl<T> VarDimension<T> for RasterData<T>
where
    T: RasterType + FromPrimitive + Add<Output = T> + Div<Output = T> + num_traits::Float,
{
    fn var_dimension(&self, ddof: T, dimension: Dimension) -> Array3<T> {
        match dimension {
            Dimension::Layer => self.var_axis(Axis(1), ddof),
            Dimension::Time => self.var_axis(Axis(0), ddof),
        }
    }
}

#[allow(dead_code)]
pub(crate) trait StdDimension<T>
where
    T: RasterType + FromPrimitive + Add<Output = T> + Div<Output = T> + num_traits::Float,
{
    fn std_dimension(&self, ddof: T, dimension: Dimension) -> Array3<T>;
}

impl<T> StdDimension<T> for RasterData<T>
where
    T: RasterType + FromPrimitive + Add<Output = T> + Div<Output = T> + num_traits::Float,
{
    fn std_dimension(&self, ddof: T, dimension: Dimension) -> Array3<T> {
        match dimension {
            Dimension::Layer => self.std_axis(Axis(1), ddof),
            Dimension::Time => self.std_axis(Axis(0), ddof),
        }
    }
}

/// Error type for layer/time selection operations.
#[derive(Debug)]
pub enum SelectError {
    /// Requested layer name was not found.
    LayerNotFound {
        /// The layer name that was requested.
        requested: String,
        /// Available layer names.
        available: Vec<String>,
    },
    /// Requested time index was not found.
    TimeNotFound {
        /// The date type that was requested.
        requested: DateType,
        /// Available date indices.
        available: Vec<DateType>,
    },
    /// An empty selection was requested.
    EmptySelection,
    /// Array concatenation/stacking failed.
    ConcatenationError(String),
}

impl fmt::Display for SelectError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            SelectError::LayerNotFound { requested, available } => {
                write!(f, "Layer '{}' not found. Available: {:?}", requested, available)
            }
            SelectError::TimeNotFound { requested, available } => {
                write!(f, "Time {:?} not found. Available: {:?}", requested, available)
            }
            SelectError::EmptySelection => {
                write!(f, "Empty selection requested")
            }
            SelectError::ConcatenationError(msg) => {
                write!(f, "Array concatenation failed: {}", msg)
            }
        }
    }
}

impl std::error::Error for SelectError {}

/// Trait for selecting layers and time slices from raster data by name.
pub trait Select<T>
where
    T: RasterType + FromPrimitive + Add<Output = T> + Div<Output = T>,
{
    /// Select multiple layers by name.
    fn select_layers(&self, layer_names: &[&str]) -> Result<RasterDataBlock<T>, SelectError>;

    /// Select multiple time slices by date index.
    fn select_times(&self, dates: &[DateType]) -> Result<RasterDataBlock<T>, SelectError>;

    /// Find the index of a layer by name.
    fn find_layer_index(&self, name: &str) -> Result<usize, SelectError>;

    /// Find the index of a time slice by date type.
    fn find_time_index(&self, date: &DateType) -> Result<usize, SelectError>;
}

impl<T> Select<T> for RasterDataBlock<T>
where
    T: RasterType + FromPrimitive + Add<Output = T> + Div<Output = T>,
{
    fn find_layer_index(&self, name: &str) -> Result<usize, SelectError> {
        self.metadata
            .layer_indices
            .iter()
            .position(|s| s.as_str() == name)
            .ok_or(SelectError::LayerNotFound {
                requested: name.to_string(),
                available: self.metadata.layer_indices.clone(),
            })
    }

    fn find_time_index(&self, date: &DateType) -> Result<usize, SelectError> {
        self.metadata
            .date_indices
            .iter()
            .position(|d| d == date)
            .ok_or(SelectError::TimeNotFound {
                requested: date.clone(),
                available: self.metadata.date_indices.clone(),
            })
    }

    fn select_layers(&self, layer_names: &[&str]) -> Result<RasterDataBlock<T>, SelectError> {
        if layer_names.is_empty() {
            return Err(SelectError::EmptySelection);
        }

        let indices: Vec<usize> = layer_names
            .iter()
            .map(|name| self.find_layer_index(name))
            .collect::<Result<_, _>>()?;

        let views: Vec<_> = indices
            .iter()
            .map(|&idx| self.data.index_axis(Axis(1), idx))
            .collect();

        let data = ndarray::stack(Axis(1), &views)
            .map_err(|e| SelectError::ConcatenationError(e.to_string()))?;

        let new_metadata = RasterMetadata {
            layer_indices: layer_names.iter().map(|s| s.to_string()).collect(),
            shape: RasterDataShape {
                layers: layer_names.len(),
                ..self.metadata.shape
            },
            ..self.metadata.clone()
        };

        Ok(RasterDataBlock {
            data,
            metadata: new_metadata,
            no_data: self.no_data,
        })
    }

    fn select_times(&self, dates: &[DateType]) -> Result<RasterDataBlock<T>, SelectError> {
        if dates.is_empty() {
            return Err(SelectError::EmptySelection);
        }

        let indices: Vec<usize> = dates
            .iter()
            .map(|d| self.find_time_index(d))
            .collect::<Result<_, _>>()?;

        let views: Vec<_> = indices
            .iter()
            .map(|&idx| self.data.index_axis(Axis(0), idx))
            .collect();

        let data = ndarray::stack(Axis(0), &views)
            .map_err(|e| SelectError::ConcatenationError(e.to_string()))?;

        let new_metadata = RasterMetadata {
            date_indices: dates.to_vec(),
            shape: RasterDataShape {
                times: dates.len(),
                ..self.metadata.shape
            },
            ..self.metadata.clone()
        };

        Ok(RasterDataBlock {
            data,
            metadata: new_metadata,
            no_data: self.no_data,
        })
    }
}

/// Convenience methods for `RasterDataBlock`.
impl<T> RasterDataBlock<T>
where
    T: RasterType,
{
    /// Returns the available layer names for this block.
    pub fn available_layer_names(&self) -> &[String] {
        &self.metadata.layer_indices
    }

    /// Returns the available time indices for this block.
    pub fn available_time_indices(&self) -> &[DateType] {
        &self.metadata.date_indices
    }
}

/// RasterBlock trait for block-level operations.
pub trait RasterBlockTrait<U>
where
    U: RasterType,
{
    /// Converts feature-request-count data to full resolution count.
    fn into_frc(&self, data: &Array2<U>) -> Array3<U>;

    /// Writes samples for a feature.
    fn write_samples_feature<T>(&self, data: &Array2<T>, file_name: &std::path::PathBuf, na: T)
    where
        T: RasterType + ToPrimitive;

    /// Writes 3D data.
    fn write3<T>(&self, data: Array3<T>, out_fn: &std::path::PathBuf)
    where
        T: RasterType + ToPrimitive;
}

#[cfg(test)]
mod tests {
    use crate::data_sources::DateType;
    use crate::metadata::{RasterDataBlock, RasterMetadata};
    use crate::types::RasterDataShape;
    use ndarray::Array4;
    use num_traits::NumCast;

    use super::{Select, SelectError};

    fn make_test_block() -> RasterDataBlock<f32> {
        // shape: (3 times, 4 layers, 2 rows, 2 cols)
        let data = Array4::<f32>::zeros((3, 4, 2, 2));
        let metadata = RasterMetadata {
            layer_indices: vec!["red".into(), "green".into(), "nir".into(), "swir".into()],
            date_indices: vec![
                DateType::Index(0),
                DateType::Index(1),
                DateType::Index(2),
            ],
            shape: RasterDataShape {
                times: 3,
                layers: 4,
                rows: 2,
                cols: 2,
            },
            ..RasterMetadata::new()
        };
        RasterDataBlock {
            data,
            metadata,
            no_data: NumCast::from(0.0f32).unwrap(),
        }
    }

    #[test]
    fn test_select_layers_basic() {
        let block = make_test_block();
        let result = block.select_layers(&["red", "nir"]).unwrap();
        assert_eq!(result.metadata.shape.layers, 2);
        assert_eq!(result.data.shape(), &[3, 2, 2, 2]);
        assert_eq!(result.metadata.layer_indices, vec!["red", "nir"]);
        assert_eq!(result.metadata.shape.times, 3);
        assert_eq!(result.metadata.shape.rows, 2);
        assert_eq!(result.metadata.shape.cols, 2);
    }

    #[test]
    fn test_select_layers_single() {
        let block = make_test_block();
        let result = block.select_layers(&["nir"]).unwrap();
        assert_eq!(result.metadata.shape.layers, 1);
        assert_eq!(result.data.shape(), &[3, 1, 2, 2]);
        assert_eq!(result.metadata.layer_indices, vec!["nir"]);
    }

    #[test]
    fn test_select_layers_all() {
        let block = make_test_block();
        let result = block
            .select_layers(&["red", "green", "nir", "swir"])
            .unwrap();
        assert_eq!(result.metadata.shape.layers, 4);
        assert_eq!(result.data.shape(), &[3, 4, 2, 2]);
    }

    #[test]
    fn test_select_layers_not_found() {
        let block = make_test_block();
        let err = block.select_layers(&["red", "blue"]).unwrap_err();
        assert!(matches!(err, SelectError::LayerNotFound { .. }));
        if let SelectError::LayerNotFound { requested, available } = err {
            assert_eq!(requested, "blue");
            assert_eq!(available.len(), 4);
        }
    }

    #[test]
    fn test_select_layers_empty() {
        let block = make_test_block();
        let err = block.select_layers(&[]).unwrap_err();
        assert!(matches!(err, SelectError::EmptySelection));
    }

    #[test]
    fn test_select_times_basic() {
        let block = make_test_block();
        let dates = vec![DateType::Index(0), DateType::Index(2)];
        let result = block.select_times(&dates).unwrap();
        assert_eq!(result.metadata.shape.times, 2);
        assert_eq!(result.data.shape(), &[2, 4, 2, 2]);
        assert_eq!(result.metadata.shape.layers, 4);
    }

    #[test]
    fn test_select_times_single() {
        let block = make_test_block();
        let result = block.select_times(&[DateType::Index(1)]).unwrap();
        assert_eq!(result.metadata.shape.times, 1);
        assert_eq!(result.data.shape(), &[1, 4, 2, 2]);
    }

    #[test]
    fn test_select_times_not_found() {
        let block = make_test_block();
        let err = block
            .select_times(&[DateType::Index(99)])
            .unwrap_err();
        assert!(matches!(err, SelectError::TimeNotFound { .. }));
    }

    #[test]
    fn test_select_times_empty() {
        let block = make_test_block();
        let err = block.select_times(&[]).unwrap_err();
        assert!(matches!(err, SelectError::EmptySelection));
    }

    #[test]
    fn test_select_chaining_layers_then_times() {
        let block = make_test_block();
        let result = block
            .select_layers(&["red", "nir"])
            .unwrap()
            .select_times(&[DateType::Index(0)])
            .unwrap();
        assert_eq!(result.data.shape(), &[1, 2, 2, 2]);
        assert_eq!(result.metadata.layer_indices, vec!["red", "nir"]);
        assert_eq!(result.metadata.date_indices.len(), 1);
    }

    #[test]
    fn test_select_chaining_times_then_layers() {
        let block = make_test_block();
        let result = block
            .select_times(&[DateType::Index(1), DateType::Index(2)])
            .unwrap()
            .select_layers(&["swir"])
            .unwrap();
        assert_eq!(result.data.shape(), &[2, 1, 2, 2]);
        assert_eq!(result.metadata.date_indices.len(), 2);
        assert_eq!(result.metadata.layer_indices, vec!["swir"]);
    }

    #[test]
    fn test_available_layer_names() {
        let block = make_test_block();
        assert_eq!(
            block.available_layer_names(),
            &["red", "green", "nir", "swir"]
        );
    }

    #[test]
    fn test_available_time_indices() {
        let block = make_test_block();
        let times = block.available_time_indices();
        assert_eq!(times.len(), 3);
        assert_eq!(times[0], DateType::Index(0));
        assert_eq!(times[1], DateType::Index(1));
        assert_eq!(times[2], DateType::Index(2));
    }

    #[test]
    fn test_select_preserves_no_data() {
        let block = make_test_block();
        let result = block.select_layers(&["red"]).unwrap();
        assert_eq!(result.no_data, block.no_data);
    }

    #[test]
    fn test_select_error_display() {
        let block = make_test_block();
        let err = block.select_layers(&["missing"]).unwrap_err();
        let msg = format!("{}", err);
        assert!(msg.contains("missing"));
        assert!(msg.contains("not found"));
    }

    #[test]
    fn test_select_layers_order_preserved() {
        let block = make_test_block();
        let result = block.select_layers(&["swir", "red"]).unwrap();
        assert_eq!(result.metadata.layer_indices, vec!["swir", "red"]);
    }
}