Skip to content
Python Wrapper for Hilbert–Huang Transform MATLAB Package
Jupyter Notebook Python
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
hhtpywrapper Fix no rcada_emd function problem Jun 2, 2019
notebooks add plot_hs method to HSA class Jun 5, 2017
LICENSE Update LICENSE Apr 7, 2017
README.md update the intro of this project Jun 3, 2017
requirements.txt add pyzmq to requirements.txt Jun 1, 2017
setup.py Fix no rcada_emd function problem Jun 2, 2019

README.md

Python Wrapper for Hilbert–Huang Transform MATLAB Package

License: MIT DOI

HHTpywrapper instantaneously tracks frequency and amplitude variations of a signal generated by non-stationary and nonlinear processes (e.g., quasi-periodic oscillations of astronomical objects). It uses Python as an interface to call the Hilbert–Huang Transform (HHT) MATLAB package. HHT is a time-frequency analysis method to adaptively decompose a signal into basis components at different timescales (i.e., the empirical mode decomposition), and then Hilbert transform these components into instantaneous phases, frequencies and amplitudes as functions of time (i.e., Hilbert spectral analysis). HHT has been successfully applied to analyzing X-ray quasi-periodic oscillations from the active galactic nucleus RE J1034+396 (Hu et al. 2014) and two black hole X-ray binaries, XTE J1550–564 (Su et al. 2015) and GX 339-4 (Su et al. 2017). HHTpywrapper provides examples of reproducing HHT analysis results in Su et al. (2015) and Su et al. (2017). This project is originated from the Astro Hack Week 2015.

Requirements

  • Linux or Windows operating system (The fast EEMD code in the HHT MATLAB package has not supported Mac yet)
  • Python 3.x+
  • MATLAB
  • Numpy
  • Scipy
  • Astropy
  • Matplotlib
  • pymatbridge (A simple Python => MATLAB(R) interface and a matlab magic for ipython)
  • pyunpack and patool (For extracting the .zip/.rar HHT MATLAB package files)
  • UNZIP and UNRAR (sudo apt-get install unzip unrar)

Installation

  1. Clone this project from GitHub:

     $ git clone https://github.com/HHTpy/HHTpywrapper.git
    
  2. In the project directory, install required packages:

     $ pip install -r requirements.txt
    
  3. In the project directory, execute:

     $ python setup.py install
    

Examples of Package Usage

Directory Structure

After finishing the installation, you can see the below directory structure:

Important Links

Other HHT-related Python Codes

Authors

You can’t perform that action at this time.