sarpro 0.3.2

A high-performance Sentinel-1 Synthetic Aperture Radar (SAR) GRD product to image processor.
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

use ndarray::Array2;
use tracing::info;

use super::errors::SafeError;
use super::types::SafeMetadata;
use super::reader::SafeReader;

impl SafeReader {
    /// Access parsed metadata
    pub fn metadata(&self) -> &SafeMetadata {
        &self.metadata
    }

    /// Retrieve the image data as a borrowed array (returns VV data if available, otherwise VH)
    pub fn data(&self) -> Result<&Array2<f32>, SafeError> {
        if let Some(ref arr) = self.vv_data {
            Ok(arr)
        } else if let Some(ref arr) = self.vh_data {
            Ok(arr)
        } else {
            Err(SafeError::MissingField("no polarization data available"))
        }
    }

    /// Get VV data (borrowed reference)
    pub fn vv_data(&self) -> Result<&Array2<f32>, SafeError> {
        let arr = self
            .vv_data
            .as_ref()
            .ok_or(SafeError::MissingField("vv_data"))?;
        Ok(arr)
    }

    /// Get VH data (borrowed reference)
    pub fn vh_data(&self) -> Result<&Array2<f32>, SafeError> {
        let arr = self
            .vh_data
            .as_ref()
            .ok_or(SafeError::MissingField("vh_data"))?;
        Ok(arr)
    }

    /// Get HH data (borrowed reference)
    pub fn hh_data(&self) -> Result<&Array2<f32>, SafeError> {
        let arr = self
            .hh_data
            .as_ref()
            .ok_or(SafeError::MissingField("hh_data"))?;
        Ok(arr)
    }

    /// Get HV data (borrowed reference)
    pub fn hv_data(&self) -> Result<&Array2<f32>, SafeError> {
        let arr = self
            .hv_data
            .as_ref()
            .ok_or(SafeError::MissingField("hv_data"))?;
        Ok(arr)
    }

    /// Get sum of VV and VH data (vv + vh)
    pub fn sum_data(&self) -> Result<Array2<f32>, SafeError> {
        info!("Summing VV and VH data");
        let vv = self.vv_data()?;
        let vh = self.vh_data()?;
        Ok(crate::core::processing::ops::sum_arrays(vv, vh))
    }

    /// Get difference of VV and VH data (vv - vh)
    pub fn difference_data(&self) -> Result<Array2<f32>, SafeError> {
        info!("Differencing VV and VH data");
        let vv = self.vv_data()?;
        let vh = self.vh_data()?;
        Ok(crate::core::processing::ops::difference_arrays(vv, vh))
    }

    /// Get ratio of VV and VH data (vv / vh, with zero handling)
    pub fn ratio_data(&self) -> Result<Array2<f32>, SafeError> {
        info!("Calculating ratio of VV and VH data");
        let vv = self.vv_data()?;
        let vh = self.vh_data()?;
        Ok(crate::core::processing::ops::ratio_arrays(vv, vh))
    }

    /// Get normalized difference of VV and VH data ((vv - vh) / (vv + vh))
    pub fn normalized_diff_data(&self) -> Result<Array2<f32>, SafeError> {
        info!("Calculating normalized difference of VV and VH data");
        let vv = self.vv_data()?;
        let vh = self.vh_data()?;
        Ok(crate::core::processing::ops::normalized_diff_arrays(
            vv, vh,
        ))
    }

    /// Get log ratio of VV and VH data (10 * log10(vv / vh))
    pub fn log_ratio_data(&self) -> Result<Array2<f32>, SafeError> {
        info!("Calculating log ratio of VV and VH data");
        let vv = self.vv_data()?;
        let vh = self.vh_data()?;
        Ok(crate::core::processing::ops::log_ratio_arrays(vv, vh))
    }

    // HH/HV pair operations
    /// Get sum of HH and HV data (hh + hv)
    pub fn sum_hh_hv_data(&self) -> Result<Array2<f32>, SafeError> {
        info!("Summing HH and HV data");
        let hh = self.hh_data()?;
        let hv = self.hv_data()?;
        Ok(crate::core::processing::ops::sum_arrays(hh, hv))
    }

    /// Get difference of HH and HV data (hh - hv)
    pub fn difference_hh_hv_data(&self) -> Result<Array2<f32>, SafeError> {
        info!("Differencing HH and HV data");
        let hh = self.hh_data()?;
        let hv = self.hv_data()?;
        Ok(crate::core::processing::ops::difference_arrays(hh, hv))
    }

    /// Get ratio of HH and HV data (hh / hv, with zero handling)
    pub fn ratio_hh_hv_data(&self) -> Result<Array2<f32>, SafeError> {
        info!("Calculating ratio of HH and HV data");
        let hh = self.hh_data()?;
        let hv = self.hv_data()?;
        Ok(crate::core::processing::ops::ratio_arrays(hh, hv))
    }

    /// Get normalized difference of HH and HV data ((hh - hv) / (hh + hv))
    pub fn normalized_diff_hh_hv_data(&self) -> Result<Array2<f32>, SafeError> {
        info!("Calculating normalized difference of HH and HV data");
        let hh = self.hh_data()?;
        let hv = self.hv_data()?;
        Ok(crate::core::processing::ops::normalized_diff_arrays(
            hh, hv,
        ))
    }

    /// Get log ratio of HH and HV data (10 * log10(hh / hv))
    pub fn log_ratio_hh_hv_data(&self) -> Result<Array2<f32>, SafeError> {
        info!("Calculating log ratio of HH and HV data");
        let hh = self.hh_data()?;
        let hv = self.hv_data()?;
        Ok(crate::core::processing::ops::log_ratio_arrays(hh, hv))
    }

    /// Get a string representation of available polarizations for error reporting
    pub fn get_available_polarizations(&self) -> String {
        let mut available = Vec::new();

        if self.vv_data.is_some() {
            available.push("VV");
        }
        if self.vh_data.is_some() {
            available.push("VH");
        }
        if self.hh_data.is_some() {
            available.push("HH");
        }
        if self.hv_data.is_some() {
            available.push("HV");
        }

        if available.is_empty() {
            "none".to_string()
        } else {
            available.join(", ")
        }
    }
}