SpectralDistances
This package facilitates the calculation of distances between signals, primarily in the frequency domain. The main functionality revolves around rational spectra, i.e., the spectrum of a rational function, known as a transfer function, an autoregressive model or an autoregressive moving-average model.
This repository implements all optimal-transport based distances between spectra detailed in the following pre-pre print
Installation
The package is registered and you may install it by
using Pkg
pkg"add SpectralDistances"High-level overview
The main workflow is as follows
- Define a distance
- Evaluate the distance between two points (signals, histograms, periodograms, etc.)
You can also calculate barycenters, interpolations, and barycentric coordinates of signals under the chosen distance.
This package extends Distances.jl and all distance types are subtypes of Distances.PreMetric, even though some technically are true metrics and some are not even pre-metrics.
Many distances are differentiable and can thus be used for gradient-based learning. The rest of this manual is divided into the following sections
Contents
- Distances
- Time-Frequency distances
- Models and root manipulations
- Interpolations and Barycenters
- Plotting
- Misc.
- Examples
- Task View
All Exported functions and types
SpectralDistances.AbstractDistanceSpectralDistances.AbstractRationalDistanceSpectralDistances.AbstractSignalDistanceSpectralDistances.BuresDistanceSpectralDistances.CoefficientDistanceSpectralDistances.ConvOptimalTransportDistanceSpectralDistances.DiscreteGridTransportDistanceSpectralDistances.DiscreteGridTransportDistanceSpectralDistances.DiscretizedRationalDistanceSpectralDistances.EnergyDistanceSpectralDistances.EuclideanRootDistanceSpectralDistances.HungarianRootDistanceSpectralDistances.KernelWassersteinRootDistanceSpectralDistances.ModelDistanceSpectralDistances.OptimalTransportHistogramDistanceSpectralDistances.OptimalTransportRootDistanceSpectralDistances.RationalCramerDistanceSpectralDistances.RationalOptimalTransportDistanceSpectralDistances.SCWorkspaceSpectralDistances.SlidingConvOptimalTransportDistanceSpectralDistances.SymmetricDistanceSpectralDistances.WelchLPDistanceSpectralDistances.WelchOptimalTransportDistanceSpectralDistances.IPOTSpectralDistances.complete_distmatSpectralDistances.discrete_grid_transportcostSpectralDistances.discrete_grid_transportplanSpectralDistances.distmatSpectralDistances.distmat_euclideanSpectralDistances.distmat_euclidean!SpectralDistances.domainSpectralDistances.domain_transformSpectralDistances.mask_filterSpectralDistances.normalize_spectrogramSpectralDistances.ot_convexSpectralDistances.ot_jumpSpectralDistances.precomputeSpectralDistances.sinkhornSpectralDistances.sinkhorn_convolutionalSpectralDistances.sinkhorn_convolutionalSpectralDistances.sinkhorn_logSpectralDistances.sinkhorn_log!SpectralDistances.sinkhorn_unbalancedSpectralDistances.TimeDistanceSpectralDistances.TimeVaryingARSpectralDistances.TimeWindowDynamicAxisWarping.dtwnnSlidingDistancesBase.distance_profileSpectralDistances.ARSpectralDistances.ARMASpectralDistances.AbstractModelSpectralDistances.ContinuousRootsSpectralDistances.ContinuousRootsSpectralDistances.DiscreteRootsSpectralDistances.DiscreteRootsSpectralDistances.FitMethodSpectralDistances.HungarianAssignementSpectralDistances.IRLSSpectralDistances.LSSpectralDistances.PLRSpectralDistances.SortAssignementSpectralDistances.TLSControlSystemsBase.denvecControlSystemsBase.tfControlSystemsBase.tfPolynomialRoots.rootsSpectralDistances.change_precisionSpectralDistances.checkrootsSpectralDistances.coefficientsSpectralDistances.domain_transformSpectralDistances.examplemodelsSpectralDistances.fitmodelSpectralDistances.fitmodelSpectralDistances.fitmodelSpectralDistances.fitmodelSpectralDistances.hungariansortSpectralDistances.lsSpectralDistances.normalization_factorSpectralDistances.normalize_energySpectralDistances.plrSpectralDistances.polarSpectralDistances.reflectSpectralDistances.residuesSpectralDistances.residuesSpectralDistances.residueweightSpectralDistances.roots2polySpectralDistances.simplex_residueweightSpectralDistances.spectralenergySpectralDistances.spectralenergySpectralDistances.unitweight