Getting Started | Issues | Contribute | Citation | Authors

What is shapelets?

Shapelets is a Python-based library that implements several shapelet functions and some of their applications in science and engineering. Shapelet functions are a complete and orthogonal set of localized basis functions with mathematical properties convenient for image analysis and manipulation. Applications include:

• Astronomy/astrophysics (A. Refregier (2003), R. Massey (2005), J. Berge (2019))
• Nanostructure characterization (R. Suderman (2015), T. Akdeniz (2018), M. P. Tino (2024))
• Computational neuroscience (J. D. Victor (2006), T. O. Sharpee (2009))
• Medical imaging (J. Weissman (2004))

The shapelets library provides reference code and documentation for the following shapelet functions:

• Cartesian shapelets (A. Refregier (2003))
• Polar shapelets (R. Massey (2005))
• Exponential shapelets (J. Berge (2019))
• Orthonormal polar shapelets (T. Akdeniz (2018), M. P. Tino (2024))

Getting Started

If you have Python 3.10+ installed on your machine, you can install the shapelets library via pip:

pip install shapelets

Otherwise, consult the official website for installation instructions.

Issues

If you encounter any problems with shapelets, please create a post using the issue tracker. Provide a clear and concise description of the problem with images/code-snippets where appropriate. We will address these problems as fast as possible.

Contribute

The authors of the shapelets library welcome contributions to the source code. Please follow the contribution policy:

• Open an issue on the library issue tracker clearly describing your intentions on code modifications

• Ensure your modifications or additions adhere to the existing standard of the shapelets library (i.e. how are your docstrings?)

• Test your modifications to ensure the integrity of the library is intact via the entry point: shapelets-test

• Once the issue has been discussed with a library author, you may open a pull request containing your modifications

Citation

If you plan to use shapelets in your own work, please cite using the Cite this repository dropdown button on the top right of this page (under About).

Authors

• Matthew Peres Tino ([email protected])
• Abbas Yusuf Abdulaziz
• Nasser Mohieddin Abukhdeir
• Robert Suderman
• Thomas Akdeniz