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
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
use gdal::Dataset;
use gdal::Metadata;
use serde_json;
use std::collections::HashMap;
use std::path::Path;
use tracing::info;

use crate::io::sentinel1::SafeMetadata;

/// Metadata format for different output types
#[derive(Debug, Clone, Copy)]
pub enum MetadataFormat {
    /// TIFF metadata (embedded in file)
    Tiff,
    /// JSON metadata (sidecar file)
    Json,
}

/// Extract all metadata fields from SafeMetadata into a HashMap
pub fn extract_metadata_fields(
    meta: &SafeMetadata,
    operation: Option<&str>,
) -> HashMap<String, String> {
    let mut metadata = HashMap::new();

    // Basic product information
    metadata.insert("INSTRUMENT".to_string(), meta.instrument.clone());
    metadata.insert("PLATFORM".to_string(), meta.platform.clone());
    metadata.insert(
        "ACQUISITION_START".to_string(),
        meta.acquisition_start.clone(),
    );
    metadata.insert(
        "ACQUISITION_STOP".to_string(),
        meta.acquisition_stop.clone(),
    );
    metadata.insert("ORBIT_NUMBER".to_string(), meta.orbit_number.to_string());

    // Handle polarization field based on operation
    let polarization_field = if let Some(op) = operation {
        match op {
            "sum" => {
                if meta.polarizations.contains(&"VV".to_string())
                    && meta.polarizations.contains(&"VH".to_string())
                {
                    "SUM(VV, VH)".to_string()
                } else if meta.polarizations.contains(&"HH".to_string())
                    && meta.polarizations.contains(&"HV".to_string())
                {
                    "SUM(HH, HV)".to_string()
                } else {
                    meta.polarizations.join(",")
                }
            }
            "difference" => {
                if meta.polarizations.contains(&"VV".to_string())
                    && meta.polarizations.contains(&"VH".to_string())
                {
                    "DIFF(VV, VH)".to_string()
                } else if meta.polarizations.contains(&"HH".to_string())
                    && meta.polarizations.contains(&"HV".to_string())
                {
                    "DIFF(HH, HV)".to_string()
                } else {
                    meta.polarizations.join(",")
                }
            }
            "ratio" => {
                if meta.polarizations.contains(&"VV".to_string())
                    && meta.polarizations.contains(&"VH".to_string())
                {
                    "RATIO(VV, VH)".to_string()
                } else if meta.polarizations.contains(&"HH".to_string())
                    && meta.polarizations.contains(&"HV".to_string())
                {
                    "RATIO(HH, HV)".to_string()
                } else {
                    meta.polarizations.join(",")
                }
            }
            "normalized_diff" => {
                if meta.polarizations.contains(&"VV".to_string())
                    && meta.polarizations.contains(&"VH".to_string())
                {
                    "NORM_DIFF(VV, VH)".to_string()
                } else if meta.polarizations.contains(&"HH".to_string())
                    && meta.polarizations.contains(&"HV".to_string())
                {
                    "NORM_DIFF(HH, HV)".to_string()
                } else {
                    meta.polarizations.join(",")
                }
            }
            "log_ratio" => {
                if meta.polarizations.contains(&"VV".to_string())
                    && meta.polarizations.contains(&"VH".to_string())
                {
                    "LOG_RATIO(VV, VH)".to_string()
                } else if meta.polarizations.contains(&"HH".to_string())
                    && meta.polarizations.contains(&"HV".to_string())
                {
                    "LOG_RATIO(HH, HV)".to_string()
                } else {
                    meta.polarizations.join(",")
                }
            }
            "multiband_vv_vh" => "MULTIBAND(VV, VH)".to_string(),
            "multiband_hh_hv" => "MULTIBAND(HH, HV)".to_string(),
            _ => meta.polarizations.join(","),
        }
    } else {
        meta.polarizations.join(",")
    };
    metadata.insert("POLARIZATIONS".to_string(), polarization_field);

    metadata.insert("PRODUCT_TYPE".to_string(), meta.product_type.clone());

    // SAR parameters
    if let Some(rate) = meta.range_sampling_rate {
        metadata.insert("RANGE_SAMPLING_RATE".to_string(), rate.to_string());
    }
    if let Some(freq) = meta.radar_frequency {
        metadata.insert("RADAR_FREQUENCY".to_string(), freq.to_string());
    }
    if let Some(prf) = meta.prf {
        metadata.insert("PRF".to_string(), prf.to_string());
    }
    if let Some(pulse_len) = meta.tx_pulse_length {
        metadata.insert("TX_PULSE_LENGTH".to_string(), pulse_len.to_string());
    }
    if let Some(ramp_rate) = meta.tx_pulse_ramp_rate {
        metadata.insert("TX_PULSE_RAMP_RATE".to_string(), ramp_rate.to_string());
    }
    if let Some(vel) = meta.velocity {
        metadata.insert("VELOCITY".to_string(), vel.to_string());
    }
    if let Some(slant_range) = meta.slant_range_near {
        metadata.insert("SLANT_RANGE_NEAR".to_string(), slant_range.to_string());
    }

    // Georeferencing information
    if let Some(pixel_spacing_range) = meta.pixel_spacing_range {
        metadata.insert(
            "PIXEL_SPACING_RANGE".to_string(),
            pixel_spacing_range.to_string(),
        );
    }
    if let Some(pixel_spacing_azimuth) = meta.pixel_spacing_azimuth {
        metadata.insert(
            "PIXEL_SPACING_AZIMUTH".to_string(),
            pixel_spacing_azimuth.to_string(),
        );
    }

    // Acquisition details
    if let Some(mode) = &meta.instrument_mode {
        metadata.insert("INSTRUMENT_MODE".to_string(), mode.clone());
    }
    if let Some(pass_dir) = &meta.pass_direction {
        metadata.insert("PASS_DIRECTION".to_string(), pass_dir.clone());
    }
    if let Some(data_take_id) = &meta.data_take_id {
        metadata.insert("DATA_TAKE_ID".to_string(), data_take_id.clone());
    }
    if let Some(product_id) = &meta.product_id {
        metadata.insert("PRODUCT_ID".to_string(), product_id.clone());
    }

    // Processing parameters
    if let Some(level) = &meta.processing_level {
        metadata.insert("PROCESSING_LEVEL".to_string(), level.clone());
    }
    if let Some(multilook) = meta.multilook_factor {
        metadata.insert("MULTILOOK_FACTOR".to_string(), multilook.to_string());
    }
    if let Some(cal_type) = &meta.calibration_type {
        metadata.insert("CALIBRATION_TYPE".to_string(), cal_type.clone());
    }
    if let Some(noise) = meta.noise_estimate {
        metadata.insert("NOISE_ESTIMATE".to_string(), noise.to_string());
    }
    if let Some(center) = &meta.processing_center {
        metadata.insert("PROCESSING_CENTER".to_string(), center.clone());
    }
    if let Some(version) = &meta.software_version {
        metadata.insert("SOFTWARE_VERSION".to_string(), version.clone());
    }

    // Image characteristics
    if let Some(data_type) = &meta.pixel_data_type {
        metadata.insert("PIXEL_DATA_TYPE".to_string(), data_type.clone());
    }
    if let Some(bits) = meta.bits_per_sample {
        metadata.insert("BITS_PER_SAMPLE".to_string(), bits.to_string());
    }
    if let Some(sample_format) = &meta.sample_format {
        metadata.insert("SAMPLE_FORMAT".to_string(), sample_format.clone());
    }

    // Additional SAR-specific metadata
    if let Some(incidence) = meta.incidence_angle {
        metadata.insert("INCIDENCE_ANGLE".to_string(), incidence.to_string());
    }
    if let Some(look_angle) = meta.look_angle {
        metadata.insert("LOOK_ANGLE".to_string(), look_angle.to_string());
    }
    if let Some(doppler) = meta.doppler_centroid {
        metadata.insert("DOPPLER_CENTROID".to_string(), doppler.to_string());
    }
    if let Some(radiometric) = &meta.radiometric_calibration {
        metadata.insert("RADIOMETRIC_CALIBRATION".to_string(), radiometric.clone());
    }
    if let Some(geometric) = &meta.geometric_calibration {
        metadata.insert("GEOMETRIC_CALIBRATION".to_string(), geometric.clone());
    }

    // Conversion provenance
    metadata.insert("CONVERSION_TOOL".to_string(), meta.conversion_tool.clone());
    metadata.insert(
        "CONVERSION_VERSION".to_string(),
        meta.conversion_version.clone(),
    );
    metadata.insert(
        "CONVERSION_TIMESTAMP".to_string(),
        meta.conversion_timestamp.clone(),
    );

    metadata
}

/// Convert metadata HashMap to JSON format
pub fn convert_metadata_to_json(
    metadata: &HashMap<String, String>,
) -> HashMap<String, serde_json::Value> {
    let mut json_metadata = HashMap::new();

    for (key, value) in metadata {
        // Convert key to lowercase for JSON format
        let json_key = key.to_lowercase();

        // Try to parse as number first, then fall back to string
        if let Ok(num) = value.parse::<f64>() {
            if let Some(json_num) = serde_json::Number::from_f64(num) {
                json_metadata.insert(json_key, serde_json::Value::Number(json_num));
            } else {
                json_metadata.insert(json_key, serde_json::Value::String(value.clone()));
            }
        } else if let Ok(num) = value.parse::<u64>() {
            json_metadata.insert(
                json_key,
                serde_json::Value::Number(serde_json::Number::from(num)),
            );
        } else {
            json_metadata.insert(json_key, serde_json::Value::String(value.clone()));
        }
    }

    json_metadata
}

/// Handle special JSON fields that need array conversion
pub fn add_special_json_fields(
    json_metadata: &mut HashMap<String, serde_json::Value>,
    meta: &SafeMetadata,
    geotransform_override: Option<[f64; 6]>,
    projection_override: Option<&str>,
) {
    // Note: The processed polarization field (e.g., "SUM(VV, VH)") is preserved as "polarizations"
    // We don't add any additional polarization fields to avoid conflicts
    // That might or might not change in the future.

    // Handle geotransform as array
    if let Some(geotransform) = geotransform_override.or(meta.geotransform) {
        json_metadata.insert(
            "geotransform".to_string(),
            serde_json::Value::Array(
                geotransform
                    .iter()
                    .map(|&v| serde_json::Value::Number(serde_json::Number::from_f64(v).unwrap()))
                    .collect(),
            ),
        );
    }

    // Handle CRS field
    if let Some(crs) = projection_override.or(meta.crs.as_deref()) {
        if !crs.is_empty() {
            json_metadata.insert(
                "crs".to_string(),
                serde_json::Value::String(crs.to_string()),
            );
        }
    }
}

/// Embed comprehensive metadata into a GeoTIFF dataset
pub fn embed_tiff_metadata(
    ds: &mut Dataset,
    meta: &SafeMetadata,
    operation: Option<&str>,
    geotransform_override: Option<[f64; 6]>,
    projection_override: Option<&str>,
) -> Result<(), Box<dyn std::error::Error>> {
    // Set georeferencing information
    let is_identity = |gt: [f64; 6]| {
        gt[0] == 0.0 && gt[1] == 1.0 && gt[2] == 0.0 && gt[3] == 0.0 && gt[4] == 0.0 && gt[5] == 1.0
    };

    // Determine which geotransform to use and whether it's valid
    let mut set_gt = false;
    if let Some(gt) = geotransform_override {
        if !is_identity(gt) {
            ds.set_geo_transform(&gt)?;
            set_gt = true;
        }
    } else if let Some(gt) = meta.geotransform {
        if !is_identity(gt) {
            ds.set_geo_transform(&gt)?;
            set_gt = true;
        }
    }

    // Only set projection if we also set a non-identity geotransform
    if set_gt {
        if let Some(projection) = projection_override.or(meta.projection.as_deref()) {
            if !projection.is_empty() {
                ds.set_projection(projection)?;
            }
        }
    }

    // Extract all metadata fields
    let metadata = extract_metadata_fields(meta, operation);

    // Set metadata on the dataset
    for (key, value) in metadata {
        ds.set_metadata_item(&key, &value, "")?;
    }

    Ok(())
}

/// Create a sidecar metadata file for JPEG images
pub fn create_jpeg_metadata_sidecar(
    output_path: &Path,
    meta: &SafeMetadata,
    operation: Option<&str>,
) -> Result<(), Box<dyn std::error::Error>> {
    // Extract all metadata fields
    let metadata = extract_metadata_fields(meta, operation);

    // Convert to JSON format
    let mut json_metadata = convert_metadata_to_json(&metadata);

    // Add special JSON fields
    add_special_json_fields(&mut json_metadata, meta, None, None);

    // Create sidecar file path
    let sidecar_path = output_path.with_extension("json");

    // Write metadata to JSON file
    let json_string = serde_json::to_string_pretty(&json_metadata)?;
    std::fs::write(&sidecar_path, json_string)?;

    info!("Created JPEG metadata sidecar: {:?}", sidecar_path);
    Ok(())
}

/// Create a sidecar metadata file with optional overrides for geotransform/projection
pub fn create_jpeg_metadata_sidecar_with_overrides(
    output_path: &Path,
    meta: &SafeMetadata,
    operation: Option<&str>,
    geotransform_override: Option<[f64; 6]>,
    projection_override: Option<&str>,
) -> Result<(), Box<dyn std::error::Error>> {
    let metadata = extract_metadata_fields(meta, operation);
    let mut json_metadata = convert_metadata_to_json(&metadata);
    add_special_json_fields(
        &mut json_metadata,
        meta,
        geotransform_override,
        projection_override,
    );
    let sidecar_path = output_path.with_extension("json");
    let json_string = serde_json::to_string_pretty(&json_metadata)?;
    std::fs::write(&sidecar_path, json_string)?;
    info!("Created JPEG metadata sidecar: {:?}", sidecar_path);
    Ok(())
}

/// Create a sidecar metadata file with overrides and extra key/value fields
pub fn create_jpeg_metadata_sidecar_with_overrides_and_extras(
    output_path: &Path,
    meta: &SafeMetadata,
    operation: Option<&str>,
    geotransform_override: Option<[f64; 6]>,
    projection_override: Option<&str>,
    extras: Option<&[(&str, String)]>,
) -> Result<(), Box<dyn std::error::Error>> {
    let metadata = extract_metadata_fields(meta, operation);
    let mut json_metadata = convert_metadata_to_json(&metadata);
    add_special_json_fields(
        &mut json_metadata,
        meta,
        geotransform_override,
        projection_override,
    );
    if let Some(extra_fields) = extras {
        for (k, v) in extra_fields {
            // Keep keys lowercase for consistency with JSON fields
            json_metadata.insert(k.to_lowercase(), serde_json::Value::String(v.clone()));
        }
    }
    let sidecar_path = output_path.with_extension("json");
    let json_string = serde_json::to_string_pretty(&json_metadata)?;
    std::fs::write(&sidecar_path, json_string)?;
    info!("Created JPEG metadata sidecar: {:?}", sidecar_path);
    Ok(())
}

/// Generic metadata handler that can work with any format
pub fn handle_metadata(
    meta: &SafeMetadata,
    format: MetadataFormat,
    output_path: &Path,
    dataset: Option<&mut Dataset>,
) -> Result<(), Box<dyn std::error::Error>> {
    match format {
        MetadataFormat::Tiff => {
            let ds = dataset.ok_or("Dataset required for TIFF metadata")?;
            embed_tiff_metadata(ds, meta, None, None, None)
        }
        MetadataFormat::Json => create_jpeg_metadata_sidecar(output_path, meta, None),
    }
}