Struct sounding_analysis::Analysis

pub struct Analysis { /* fields omitted */ }

Convenient package for commonly requested analysis values.

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

Methods

impl Analysis

pub fn new(snd: Sounding) -> Self

Create a new Analysis.

pub fn with_swet<T>(self, value: T) -> Self where
    Optioned<f64>: From<T>, 

Builder method to set the SWeT

pub fn with_k_index<T>(self, value: T) -> Self where
    Optioned<Celsius>: From<T>, 

Builder method to set the K index

pub fn with_total_totals<T>(self, value: T) -> Self where
    Optioned<f64>: From<T>, 

Builder method to set the Total Totals

pub fn with_pwat<T, U>(self, value: T) -> Self where
    Optioned<U>: From<T>,
    U: Length + Noned,
    Mm: From<U>, 

Builder method to set the precipitable water

pub fn with_convective_t<T>(self, value: T) -> Self where
    Optioned<Celsius>: From<T>, 

Builder method to set the convective temperature

pub fn with_right_mover<T>(self, value: T) -> Self where
    Optioned<WindUV<MetersPSec>>: From<T>, 

Builder method to add right mover storm motion

pub fn with_left_mover<T>(self, value: T) -> Self where
    Optioned<WindUV<MetersPSec>>: From<T>, 

Builder method to add left mover storm motion

pub fn with_mean_wind<T>(self, value: T) -> Self where
    Optioned<WindUV<MetersPSec>>: From<T>, 

Builder method to add the mean wind

pub fn with_sr_helicity_3k_rm<T>(self, value: T) -> Self where
    Optioned<IntHelicityM2pS2>: From<T>, 

Builder method to add the storm relative helicity

pub fn with_sr_helicity_3k_lm<T>(self, value: T) -> Self where
    Optioned<IntHelicityM2pS2>: From<T>, 

Builder method to add the storm relative helicity

pub fn with_effiective_inflow_layer<T>(self, value: T) -> Self where
    Option<Layer>: From<T>, 

Builder method to add an effective inflow layer

pub fn with_sr_helicity_eff_rm<T>(self, value: T) -> Self where
    Optioned<IntHelicityM2pS2>: From<T>, 

Builder method to add the effective storm relative helicity

pub fn with_sr_helicity_eff_lm<T>(self, value: T) -> Self where
    Optioned<IntHelicityM2pS2>: From<T>, 

Builder method to add the effective storm relative helicity

pub fn with_haines<T>(self, value: T) -> Self where
    Optioned<u8>: From<T>, 

Builder method to set the haines index. High, mid, or low Haines should be based on the station elevation of the sounding.

pub fn with_haines_low<T>(self, value: T) -> Self where
    Optioned<u8>: From<T>, 

Builder method to set the low level haines index.

pub fn with_haines_mid<T>(self, value: T) -> Self where
    Optioned<u8>: From<T>, 

Builder method to set the mid level haines index.

pub fn with_haines_high<T>(self, value: T) -> Self where
    Optioned<u8>: From<T>, 

Builder method to set the high level haines index.

pub fn with_hdw<T>(self, value: T) -> Self where
    Optioned<f64>: From<T>, 

Builder method to set the hot-dry-windy index.

pub fn with_cape_ratio<T>(self, value: T) -> Self where
    Optioned<f64>: From<T>, 

Builder method to set the wet/dry cape ratio. EXPERIMENTAL

pub fn with_convective_deficit<T>(self, value: T) -> Self where
    Optioned<CelsiusDiff>: From<T>, 

Builder method to set the convective temperature deficit. EXPERIMENTAL

pub fn with_dcape<T>(self, value: T) -> Self where
    Optioned<JpKg>: From<T>, 

Builder method to set the DCAPE.

pub fn with_downrush_t<T>(self, value: T) -> Self where
    Optioned<Celsius>: From<T>, 

Builder method to set the downrush temperature of a wet micro-burst.

pub fn swet(&self) -> Optioned<f64>

Get the Swet

pub fn k_index(&self) -> Optioned<Celsius>

Get the K index

pub fn total_totals(&self) -> Optioned<f64>

Get the Total Totals index

pub fn pwat(&self) -> Optioned<Mm>

Get the precipitable water.

pub fn convective_t(&self) -> Optioned<Celsius>

Get the convective temperature.

pub fn right_mover(&self) -> Optioned<WindUV<MetersPSec>>

Get the right mover.

pub fn left_mover(&self) -> Optioned<WindUV<MetersPSec>>

Get the left mover.

pub fn mean_wind(&self) -> Optioned<WindUV<MetersPSec>>

Get the mean wind.

pub fn sr_helicity_3k_rm(&self) -> Optioned<IntHelicityM2pS2>

Get the storm relative helicity for a right mover storm

pub fn sr_helicity_3k_lm(&self) -> Optioned<IntHelicityM2pS2>

Get the storm relative helicity for a left mover storm

pub fn effective_inflow_layer(&self) -> Option<Layer>

Get the effective inflow layer

pub fn sr_helicity_eff_rm(&self) -> Optioned<IntHelicityM2pS2>

Get the effective storm relative helicity for a right mover storm

pub fn sr_helicity_eff_lm(&self) -> Optioned<IntHelicityM2pS2>

Get the effective storm relative helicity for a left mover storm

pub fn downrush_t(&self) -> Optioned<Celsius>

Get the downrush temperature from a microburst.

pub fn haines(&self) -> Optioned<u8>

Get the Haines Index.

pub fn haines_low(&self) -> Optioned<u8>

Get the low level Haines Index.

pub fn haines_mid(&self) -> Optioned<u8>

Get the mid level Haines Index.

pub fn haines_high(&self) -> Optioned<u8>

Get the high level Haines Index.

pub fn hdw(&self) -> Optioned<f64>

Get the hot-dry-windy index.

pub fn cape_ratio(&self) -> Optioned<f64>

Get the wet/dry CAPE ratio. EXPERIMENTAL.

pub fn convective_deficit(&self) -> Optioned<CelsiusDiff>

Get the convective temperature deficit.

pub fn dcape(&self) -> Optioned<JpKg>

Get the DCAPE.

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

Set the mixed layer parcel analysis.

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

Get the mixed layer parcel analysis

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

Set the surface parcel analysis.

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

Get the surface parcel analysis

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

Set the most unstable parcel analysis.

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

Get the most unstable parcel analysis

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

Set the convective parcel analysis.

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

Get the convective parcel analysis

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

Set the downburst profile

pub fn 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_mut(&mut self)

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

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.