nexrad-model 0.1.0

Common model for NEXRAD weather radar data.
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

//!
//! This module contains models containing metadata about the radar data collected by the NEXRAD
//! weather network. This data may not change between radials, sweeps, or even scans, and thus it
//! is represented separately to avoid duplication in storage.
//!

use std::fmt::Debug;

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

#[cfg(feature = "uom")]
use uom::si::{f32::Length, length::meter};

/// A radar site's metadata including a variety of infrequently-changing properties.
#[derive(Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Site {
    identifier: [u8; 4],
    latitude: f32,
    longitude: f32,
    height_meters: i16,
    feedhorn_height_meters: u16,
}

impl Site {
    /// Create new radar site metadata with the given properties.
    pub fn new(
        identifier: [u8; 4],
        latitude: f32,
        longitude: f32,
        height_meters: i16,
        feedhorn_height_meters: u16,
    ) -> Self {
        Self {
            identifier,
            latitude,
            longitude,
            height_meters,
            feedhorn_height_meters,
        }
    }

    /// The four-letter ICAO identifier for the radar site.
    pub fn identifier(&self) -> &[u8; 4] {
        &self.identifier
    }

    /// The four-letter ICAO identifier for the radar site as a string.
    pub fn identifier_string(&self) -> String {
        String::from_utf8_lossy(&self.identifier).to_string()
    }

    /// The latitude of the radar site in degrees.
    pub fn latitude(&self) -> f32 {
        self.latitude
    }

    /// The longitude of the radar site in degrees.
    pub fn longitude(&self) -> f32 {
        self.longitude
    }

    /// The height of the radar site above sea level in meters.
    pub fn height_meters(&self) -> i16 {
        self.height_meters
    }

    /// The height of the radar site above sea level.
    #[cfg(feature = "uom")]
    pub fn height(&self) -> Length {
        Length::new::<meter>(self.height_meters as f32)
    }

    /// The height of the radar site's feedhorn above sea level in meters.
    pub fn feedhorn_height_meters(&self) -> u16 {
        self.feedhorn_height_meters
    }

    /// The height of the radar site's feedhorn above sea level.
    #[cfg(feature = "uom")]
    pub fn feedhorn_height(&self) -> Length {
        Length::new::<meter>(self.feedhorn_height_meters as f32)
    }
}

impl Debug for Site {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let mut debug = f.debug_struct("Site");

        debug.field("identifier", &self.identifier_string());

        debug.field("latitude_degrees", &self.latitude());

        debug.field("longitude_degrees", &self.longitude());

        debug.field("height_meters", &self.height_meters());

        #[cfg(feature = "uom")]
        debug.field("height", &self.height());

        debug.field("feedhorn_height_meters", &self.feedhorn_height_meters());

        #[cfg(feature = "uom")]
        debug.field("feedhorn_height", &self.feedhorn_height());

        debug.finish()
    }
}