[−][src]Struct sounding_analysis::Sounding

pub struct Sounding { /* fields omitted */ }

All the variables stored in the sounding.

The upper air profile variables are stored in parallel vectors. If a profile lacks a certain variable, e.g. cloud fraction, that whole vector has length 0 instead of being full of missing values.

Methods

`impl Sounding`[src]

`pub fn new() -> Self`[src]

Create a new sounding with default values. This is a proxy for default with a clearer name.

Examples

use sounding_analysis::Sounding;

let snd = Sounding::new();
println!("{:?}", snd);

`pub fn with_source_description<S>(self, desc: S) -> Self where Option<String>: From<S>,` [src]

Add a source description to this sounding.

Examples

use sounding_analysis::Sounding;

let snd = Sounding::new().with_source_description("An empty sounding.".to_owned());
let snd = snd.with_source_description(
    Some("Still empty, just added a description.".to_owned()),
);
let _snd = snd.with_source_description(None);

`pub fn source_description(&self) -> Option<&str>`[src]

Retrieve a source description for this sounding.

Examples

use sounding_analysis::Sounding;

let snd = Sounding::new().with_source_description("An empty sounding.".to_owned());
assert_eq!(snd.source_description().unwrap(), "An empty sounding.");

let snd = snd.with_source_description(None);
assert!(snd.source_description().is_none());

`pub fn with_station_info(self, new_value: StationInfo) -> Self`[src]

Builder function for setting the station info.

Examples

use sounding_analysis::{Sounding, StationInfo};

let stn = StationInfo::new();
let _snd = Sounding::new().with_station_info(stn);

`pub fn station_info(&self) -> StationInfo`[src]

Get the station info

Examples

use sounding_analysis::StationInfo;

let snd = make_test_sounding();
let stn: StationInfo = snd.station_info();

println!("{:?}", stn);

`pub fn with_pressure_profile(self, profile: Vec<Optioned<HectoPascal>>) -> Self`[src]

Builder method for the pressure profile.

Examples

use sounding_analysis::Sounding;
use metfor::HectoPascal;
use optional::{some, Optioned};

let data = vec![1000.0, 925.0, 850.0, 700.0, 500.0, 300.0, 250.0, 200.0, 150.0, 100.0];
let pressure_data: Vec<Optioned<HectoPascal>> = data.into_iter()
    .map(HectoPascal)
    .map(some)
    .collect();

let _snd = Sounding::new()
    .with_pressure_profile(pressure_data);

`pub fn pressure_profile(&self) -> &[Optioned<HectoPascal>]`[src]

Get the pressure profile

Examples

use sounding_analysis::Sounding;

let snd = make_test_sounding();
let data = snd.pressure_profile();

for p in data {
    if let Some(p) = p.into_option() {
        println!("{:?}", p);
    } else {
        println!("missing value!");
    }
}

// Uninitialized profiles just return an empty vector.
let snd = Sounding::new();
let data = snd.pressure_profile();
assert!(data.is_empty());

`pub fn with_temperature_profile(self, profile: Vec<Optioned<Celsius>>) -> Self`[src]

Builder method for the temperature profile.

See with_pressure_profile for an example of usage, keeping in mind the units type may be different.