API Reference

Here all foehnix classes and functions will be listed.

Main classes and functions

foehnix.Foehnix Foehn Classification Based on a Two-Component Mixture Model
foehnix.Family Common logic for the foehnix families
foehnix.GaussianFamily Gaussian foehnix mixture model family
foehnix.LogisticFamily Logistic foehnix mixture model family
foehnix.foehnix.Control Foehnix Two-Component Mixture-Model Control Object
foehnix.Foehnix.no_concomitant_fit Fitting foehnix Mixture Model Without Concomitant Model.
foehnix.Foehnix.unreg_fit Fitting unregularized foehnix Mixture Model with Concomitant Model.
foehnix.Foehnix.predict Predict method for foehnix Mixture Models

Filter

foehnix.foehnix_filter Evaluates Data Filter Rules for foehnix Mixture Model Calls

Support functions

foehnix.Foehnix.summary Prints information about the model
foehnix.Foehnix.plot Plotting method, helper function.
foehnix.iwls_logit Iterative weighted least squares solver for a logistic regression model.
foehnix.iwls_logit.iwls_summary Prints some statistics for a given concomitant model
foehnix.get_demodata Returns a demo data.

Plotting

foehnix.model_plots.loglik Plots the log-likelihood sum path through the iterations of the EM algorithm
foehnix.model_plots.loglikcontribution Plots the log-likelihood with respect to initial log-likelihood
foehnix.model_plots.coef Plots the estimated coefficients
foehnix.model_plots.hist Conditional histogram plot
foehnix.analysis_plots.TSControl Control object for the foehnix time series plot function.
foehnix.analysis_plots.tsplot Time series plot for foehnix models
foehnix.analysis_plots.image foehnix Image Plot - Hovmoeller Diagram