Enum light_curve_feature::features::VillarLnPrior

#[non_exhaustive]
pub enum VillarLnPrior {
    Fixed(Box<LnPrior<NPARAMS>>),
    Hosseinzadeh2020 {
        time_units_in_day: f64,
        min_amplitude: f64,
    },
}

Logarithm of priors for VillarFit parameters

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Fixed(Box<LnPrior<NPARAMS>>)

Hosseinzadeh2020

Fields

time_units_in_day: f64

min_amplitude: f64

Adopted from Hosseinzadeh, et al. 2020, table 2

time_units_in_day specifies the units of time you use in yout TimeSeries object, it should be 1 for days, 86400 for seconds, etc. min_amplitude is a lower bound for the log-uniform prior of amplitude, the original paper used unity

Implementations

impl VillarLnPrior

pub fn fixed(ln_prior: LnPrior<NPARAMS>) -> Self

pub fn hosseinzadeh2020(time_units_in_day: f64, min_flux: f64) -> Self

pub fn ln_prior_from_ts<T: Float>(
    &self,
    ts: &mut TimeSeries<'_, T>
) -> LnPrior<NPARAMS>

Trait Implementations

impl Clone for VillarLnPrior

fn clone(&self) -> VillarLnPrior

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VillarLnPrior

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VillarLnPrior

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<LnPrior<NPARAMS>> for VillarLnPrior

fn from(item: LnPrior<NPARAMS>) -> Self

Converts to this type from the input type.

impl JsonSchema for VillarLnPrior

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for VillarLnPrior

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.