Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 1.97 KB

README.md

File metadata and controls

28 lines (21 loc) · 1.97 KB

ScatteringTransform

Stable Dev Build Status Codecov Coveralls

An implementation of the generalized scattering transform in Julia. Documentation in progress.

Installation

Basic installation: at the moment, this is not an official package. Because of this, to install it, you must first clone it, then make it accessible to your project.

Dependencies

This uses Wai Ho Chak's rotated_monogenic.jl package that can be found here, and added via Pkg.develop("https://github.com/UCD4IDS/rotated_monogenic.jl.git").

Installation

In 0.7 onwards, use either Pkg.add("https://github.com/dsweber2/ScatteringTransform.jl.git"), Pkg.develop("https://github.com/dsweber2/ScatteringTransform.jl.git"), or ] add https://github.com/dsweber2/ScatteringTransform.jl.git in a REPL. Then from a Repl

  (v0.7) pkg> activate .
  (ScatteringTransform) pkg> instantiate

either way, make sure you don't have more than a single thread when building by setting JULIA_NUM_THREADS = 1 before calling Pkg.build.

Basic Usage

This implementation works strictly on 1 dimensional data and uses Morlet waveletsby default. If you supply data that has more dimensions, it will transform along the last dimension. For more detailed description, see the documentation (docs/basicUsage.jl)