shapelets
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, you can install the shapelets library via pip:
pip install shapelets
- If you do not have Python 3.10+ installed, consult the installation guide.
- Consult the examples to see how the library can be used.
- Checkout other documentation:
If you plan to use the shapelets library for your own work, please cite appropriately using the citation below.
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 following bibtex citation:
@article{TinoShapelets2024,
author = {Tino, Matthew Peres and Abdulaziz, Abbas Yusuf and Suderman, Robert and Akdeniz, Thomas and Abukhdeir, Nasser Mohieddin},
title = {Shapelets: A Python package implementing shapelet functions and their applications},
doi = {10.21105/joss.06058},
journal = {Journal of Open Source Software},
number = {95},
pages = {6058},
volume = {9},
year = {2024},
url = {https://joss.theoj.org/papers/10.21105/joss.06058}
}
Authors
- Matthew Peres Tino (mptino@uwaterloo.ca)
- Abbas Yusuf Abdulaziz
- Nasser Mohieddin Abukhdeir
- Robert Suderman
- Thomas Akdeniz
1######################################################################################################################## 2# Copyright 2023 the authors (see AUTHORS file for full list). # 3# # 4# This file is part of shapelets. # 5# # 6# Shapelets is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General # 7# Public License as published by the Free Software Foundation, either version 2.1 of the License, or (at your option) # 8# any later version. # 9# # 10# Shapelets is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied # 11# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more # 12# details. # 13# # 14# You should have received a copy of the GNU Lesser General Public License along with shapelets. If not, see # 15# <https://www.gnu.org/licenses/>. # 16######################################################################################################################## 17 18# Website front page goes here 19 20r""" 21 22.. include:: ../WEBHOME.md 23 24"""