Struct sounding_analysis::Analysis

pub struct Analysis { /* private fields */ }

Convenient package for commonly requested analysis values.

All parcel related values are assumed to be for the 100hPa mixed layer at the surface.

Implementations

impl Analysis

pub fn new(snd: Sounding) -> Self

Create a new Analysis.

pub fn with_profile_index<T>(self, var: ProfileIndex, value: T) -> Selfwhere
    Option<f64>: From<T>,

Set a value in the analysis

pub fn get_profile_index(&self, var: ProfileIndex) -> Option<f64>

Method to retrieve value from analysis.

pub fn with_mixed_layer_parcel_analysis<T>(self, anal: T) -> Selfwhere
    Option<ParcelAnalysis>: From<T>,

Set the mixed layer parcel analysis.

pub fn get_mixed_layer_parcel_analysis(&self) -> Option<&ParcelAnalysis>

Get the mixed layer parcel analysis

pub fn with_surface_parcel_analysis<T>(self, anal: T) -> Selfwhere
    Option<ParcelAnalysis>: From<T>,

Set the surface parcel analysis.

pub fn get_surface_parcel_analysis(&self) -> Option<&ParcelAnalysis>

Get the surface parcel analysis

pub fn with_most_unstable_parcel_analysis<T>(self, anal: T) -> Selfwhere
    Option<ParcelAnalysis>: From<T>,

Set the most unstable parcel analysis.

pub fn get_most_unstable_parcel_analysis(&self) -> Option<&ParcelAnalysis>

Get the most unstable parcel analysis

pub fn with_convective_parcel_analysis<T>(self, anal: T) -> Selfwhere
    Option<ParcelAnalysis>: From<T>,

Set the convective parcel analysis.

pub fn get_convective_parcel_analysis(&self) -> Option<&ParcelAnalysis>

Get the convective parcel analysis

pub fn with_downburst_profile<T>(self, parcel_profile: T) -> Selfwhere
    Option<ParcelProfile>: From<T>,

Set the downburst profile

pub fn get_downburst_profile(&self) -> Option<&ParcelProfile>

Get the downburst profile

pub fn with_provider_analysis(
    self,
    provider_analysis: HashMap<&'static str, f64>
) -> Self

Set the provider analysis.

This is just a table of what ever values you want to store, it may be empty.

pub fn provider_analysis(&self) -> &HashMap<&'static str, f64>

Get a reference to the provider analysis so you can query it.

pub fn provider_analysis_mut(&mut self) -> &mut HashMap<&'static str, f64>

Get a mutable reference to the provider analysis so you can modify it.

pub fn sounding(&self) -> &Sounding

Get a reference to the sounding.

pub fn fill_in_missing_analysis(self) -> Self

Analyze the sounding to get as much information as you can.

Trait Implementations

impl Clone for Analysis

fn clone(&self) -> Analysis

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Analysis

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.