API docs
========

Entropy Functions
-----------------

::

    spkit.entropy
    spkit.mutual_Info
    spkit.entropy_joint
    spkit.entropy_cond
    spkit.entropy_cross
    spkit.entropy_kld
    spkit.entropy_spectral
    spkit.entropy_sample
    spkit.entropy_approx
    spkit.entropy_svd
    spkit.entropy_permutation
    spkit.dispersion_entropy
    spkit.dispersion_entropy_multiscale_refined




::

    spkit.entropy
    spkit.mutual_Info
    spkit.entropy_joint
    spkit.entropy_cond
    spkit.entropy_cross
    spkit.entropy_kld
    spkit.entropy_spectral
    spkit.entropy_sample
    spkit.entropy_approx
    spkit.entropy_svd
    spkit.entropy_permutation
    spkit.dispersion_entropy
    spkit.dispersion_entropy_multiscale_refined


::
    
    spkit.cwt.ScalogramCWT
    spkit.cwt.compare_cwt_example
    spkit.dft_analysis
    spkit.dft_synthesis
    spkit.stft_analysis
    spkit.stft_synthesis
    spkit.sineModel_analysis
    spkit.sineModel_synthesis
    spkit.f0_detection
    spkit.peak_detection
    spkit.peak_interp
    spkit.TWM_f0
    spkit.TWM_algo
    
    
    
    spkit.frft
    spkit.ifrft
    spkit.ffrft
    spkit.iffrft
    
    spkit.HistPlot
    spkit.Mu_law
    spkit.A_law
    spkit.bin_width
    spkit.binSize_FD
    spkit.Quantize
    spkit.plotJointEntropyXY
    
    
    spkit.low_resolution
    spkit.cdf_mapping
    
    
    spkit.SVD
    spkit.ICA
    spkit.infomax
    
    
    spkit.filterDC
    spkit.filterDC_sGolay
    spkit.filter_X
    spkit.Periodogram
    spkit.getStats
    spkit.getQuickStats
    spkit.OutLiers
    
    spkit.wavelet_filtering
    spkit.wavelet_filtering_win
    spkit.WPA_temporal
    spkit.WPA_coeff
    spkit.WPA_plot
    
    
    spkit.RFB
    spkit.RFB_prange
    spkit.Create_Dictionary
    spkit.PeriodStrength
    spkit.RFB_example_1
    spkit.RFB_example_2
    


.. ::
    
    spkit.eeg.ATAR
    spkit.eeg.ATAR_1Ch
    spkit.eeg.ATAR_mCh
    spkit.eeg.ICA_filtering
    spkit.eeg.ICAremoveArtifact
    spkit.eeg.cart2sph
    spkit.eeg.sph2cart
    spkit.eeg.pol2cart
    spkit.eeg.TopoMap
    spkit.eeg.Gen_SSFI
    spkit.eeg.showTOPO
    spkit.eeg.RhythmicDecomposition
    spkit.eeg.Periodogram
    
    
.. ::
    
    spkit.data.load_data
    spkit.data.eegSample
    spkit.data.eegSample_1ch
    spkit.data.eegSample_artifact
    spkit.data.primitivePolynomials
    
    spkit.data.mclassGaus
    create_dataset
    
    
    
    spkit.ml.LR
    spkit.ml.LogisticRegression
    spkit.ml.NaiveBayes
    spkit.ml.ClassificationTree
    spkit.ml.RegressionTree