[−][src]Struct sounding_analysis::Analysis
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
[src]
pub fn new(snd: Sounding) -> Self
[src]
Create a new Analysis
.
pub fn with_swet<T>(self, value: T) -> Self where
Optioned<f64>: From<T>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
Optioned<Celsius>: From<T>,
Builder method to set the downrush temperature of a wet micro-burst.
pub fn swet(&self) -> Optioned<f64>
[src]
Get the Swet
pub fn k_index(&self) -> Optioned<Celsius>
[src]
Get the K index
pub fn total_totals(&self) -> Optioned<f64>
[src]
Get the Total Totals index
pub fn pwat(&self) -> Optioned<Mm>
[src]
Get the precipitable water.
pub fn convective_t(&self) -> Optioned<Celsius>
[src]
Get the convective temperature.
pub fn right_mover(&self) -> Optioned<WindUV<MetersPSec>>
[src]
Get the right mover.
pub fn left_mover(&self) -> Optioned<WindUV<MetersPSec>>
[src]
Get the left mover.
pub fn mean_wind(&self) -> Optioned<WindUV<MetersPSec>>
[src]
Get the mean wind.
pub fn sr_helicity_3k_rm(&self) -> Optioned<IntHelicityM2pS2>
[src]
Get the storm relative helicity for a right mover storm
pub fn sr_helicity_3k_lm(&self) -> Optioned<IntHelicityM2pS2>
[src]
Get the storm relative helicity for a left mover storm
pub fn effective_inflow_layer(&self) -> Option<Layer>
[src]
Get the effective inflow layer
pub fn sr_helicity_eff_rm(&self) -> Optioned<IntHelicityM2pS2>
[src]
Get the effective storm relative helicity for a right mover storm
pub fn sr_helicity_eff_lm(&self) -> Optioned<IntHelicityM2pS2>
[src]
Get the effective storm relative helicity for a left mover storm
pub fn downrush_t(&self) -> Optioned<Celsius>
[src]
Get the downrush temperature from a microburst.
pub fn haines(&self) -> Optioned<u8>
[src]
Get the Haines Index.
pub fn haines_low(&self) -> Optioned<u8>
[src]
Get the low level Haines Index.
pub fn haines_mid(&self) -> Optioned<u8>
[src]
Get the mid level Haines Index.
pub fn haines_high(&self) -> Optioned<u8>
[src]
Get the high level Haines Index.
pub fn hdw(&self) -> Optioned<f64>
[src]
Get the hot-dry-windy index.
pub fn cape_ratio(&self) -> Optioned<f64>
[src]
Get the wet/dry CAPE ratio. EXPERIMENTAL.
pub fn convective_deficit(&self) -> Optioned<CelsiusDiff>
[src]
Get the convective temperature deficit.
pub fn dcape(&self) -> Optioned<JpKg>
[src]
Get the DCAPE.
pub fn with_mixed_layer_parcel_analysis<T>(self, anal: T) -> Self where
Option<ParcelAnalysis>: From<T>,
[src]
Option<ParcelAnalysis>: From<T>,
Set the mixed layer parcel analysis.
pub fn mixed_layer_parcel_analysis(&self) -> Option<&ParcelAnalysis>
[src]
Get the mixed layer parcel analysis
pub fn with_surface_parcel_analysis<T>(self, anal: T) -> Self where
Option<ParcelAnalysis>: From<T>,
[src]
Option<ParcelAnalysis>: From<T>,
Set the surface parcel analysis.
pub fn surface_parcel_analysis(&self) -> Option<&ParcelAnalysis>
[src]
Get the surface parcel analysis
pub fn with_most_unstable_parcel_analysis<T>(self, anal: T) -> Self where
Option<ParcelAnalysis>: From<T>,
[src]
Option<ParcelAnalysis>: From<T>,
Set the most unstable parcel analysis.
pub fn most_unstable_parcel_analysis(&self) -> Option<&ParcelAnalysis>
[src]
Get the most unstable parcel analysis
pub fn with_convective_parcel_analysis<T>(self, anal: T) -> Self where
Option<ParcelAnalysis>: From<T>,
[src]
Option<ParcelAnalysis>: From<T>,
Set the convective parcel analysis.
pub fn convective_parcel_analysis(&self) -> Option<&ParcelAnalysis>
[src]
Get the convective parcel analysis
pub fn with_downburst_profile<T>(self, parcel_profile: T) -> Self where
Option<ParcelProfile>: From<T>,
[src]
Option<ParcelProfile>: From<T>,
Set the downburst profile
pub fn downburst_profile(&self) -> Option<&ParcelProfile>
[src]
Get the downburst profile
pub fn with_provider_analysis(
self,
provider_analysis: HashMap<&'static str, f64>
) -> Self
[src]
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>
[src]
Get a reference to the provider analysis so you can query it.
pub fn provider_analysis_mut(&mut self) -> &mut HashMap<&'static str, f64>
[src]
Get a mutable reference to the provider analysis so you can modify it.
pub fn sounding(&self) -> &Sounding
[src]
Get a reference to the sounding.
pub fn fill_in_missing_analysis_mut(&mut self)
[src]
Analyze the sounding to get as much information as you can.
pub fn fill_in_missing_analysis(self) -> Self
[src]
Analyze the sounding to get as much information as you can.
Trait Implementations
impl Clone for Analysis
[src]
fn clone(&self) -> Analysis
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Debug for Analysis
[src]
Auto Trait Implementations
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,