pyrtools

image pyramid code in python 3

https://github.com/labforcomputationalvision/pyrtools

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    6 of 12 committers (50.0%) from academic institutions
  • Institutional organization owner
    Organization labforcomputationalvision has institutional domain (www.cns.nyu.edu)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation

Repository

image pyramid code in python 3

Basic Info
  • Host: GitHub
  • Owner: LabForComputationalVision
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage: https://pyrtools.readthedocs.io/
  • Size: 231 MB
Statistics
  • Stars: 82
  • Watchers: 11
  • Forks: 22
  • Open Issues: 2
  • Releases: 0
Created over 7 years ago · Last pushed 9 months ago
Metadata Files
Readme License Citation

README.md

pyrtools: tools for multi-scale image processing

PyPI Version Anaconda-Server Badge License: MIT Python version Build Status Documentation Status DOI Binder codecov

Briefly, the tools include: - Recursive multi-scale image decompositions (pyramids), including Laplacian pyramids, QMFs, Wavelets, and steerable pyramids. These operate on 1D or 2D signals of arbitrary dimension. - Fast 2D convolution routines, with subsampling and boundary-handling. - Fast point-operations, histograms, histogram-matching. - Fast synthetic image generation: sine gratings, zone plates, fractals, etc. - Display routines for images and pyramids. These include several auto-scaling options, rounding to integer zoom factors to avoid resampling artifacts, and useful labeling (dimensions and gray-range).

This is a python 3 port of Eero Simoncelli's matlabPyrTools, but it does not attempt to recreate all of the matlab code from matlabPyrTools. The goal is to create a Python interface for the C code at the heart of matlabPyrTools.

NOTE: If you are only interested in the complex steerable pyramid, we have a pytorch implementation in the plenoptic package; the implementation in plenoptic is differentiable.

Citing us

If you use pyrtools in a published academic article or presentation, please cite us! You can find the link to the most recent release on Zenodo here (though please specify the version you used not the most recent one!). You can also get a formatted citation at the top right of our GitHub repo

Installation

You can install pyrtools using either pip:

sh pip install pyrtools

or conda:

sh conda install pyrtools -c conda-forge

You may also install from source, directly from the git repository. This is largely useful if you are seeking to modify the code or make contributions. To do so, clone the repository and run pip install. On Mac or Linux, that looks like:

sh git clone https://github.com/LabForComputationalVision/pyrtools.git cd pyrtools/ pip install .

You may also want an editable install, pip install -e ., in which case changes you make in the source code will be reflected in your install.

Pyramid resources

If you would like to learn more about pyramids and why they're helpful for image processing, here are some resources to get you started:

Usage:

  • load modules: import pyrtools as pt

  • create pyramid: pyr = pt.pyramids.LaplacianPyramid(img)

  • reconstruct image from pyramid: recon_img = pyr.recon_pyr()

Please see TUTORIALS/02_pyramids.ipynb for more examples.

For developres

Testing

You can find unit tests in TESTS/unitTests.py and run them with python TESTS/unitTests.py.

Build the documentation

NOTE: If you just want to read the documentation, you do not need to do this; documentation is built automatically on readthedocs.

However, it can be built locally as well. You would do this if you've made changes locally to the documentation (or the docstrings) that you would like to examine before pushing.

```

create a new virtual environment and then...

install pyrtools with sphinx and documentation-related dependencies

pip install -e .[docs]

build documentation

cd docs/ make html ```

The index page of the documentation will then be located at docs/_build/html/index.html, open it in your browser to navigate around.

Owner

  • Name: LCV
  • Login: LabForComputationalVision
  • Kind: organization
  • Location: 4 Washington Place, New York, 10003

Laboratory for Computational Vision, NYU

GitHub Events

Total
  • Release event: 6
  • Watch event: 7
  • Delete event: 11
  • Push event: 15
  • Pull request event: 17
  • Fork event: 1
  • Create event: 16
Last Year
  • Release event: 6
  • Watch event: 7
  • Delete event: 11
  • Push event: 15
  • Pull request event: 17
  • Fork event: 1
  • Create event: 16

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 456
  • Total Committers: 12
  • Avg Commits per committer: 38.0
  • Development Distribution Score (DDS): 0.507
Top Committers
Name Email Commits
William F. Broderick b****d@g****m 225
Rob Young r****g@c****u 99
pehf p****6@n****u 58
ravos j****o@g****m 48
Zhuo Wang z****g@1****u 13
Zahra Kadkhodaie z****8@n****u 6
Nikhil Parthasarathy n****h@g****m 2
Caroline Haimerl h****l@c****u 1
Pierre-Étienne Fiquet p****f@u****m 1
Kathryn Bonnen k****n@K****l 1
eerosim e****o@1****u 1
TrellixVulnTeam c****d@t****m 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 12
  • Total pull requests: 39
  • Average time to close issues: 4 months
  • Average time to close pull requests: 18 days
  • Total issue authors: 11
  • Total pull request authors: 6
  • Average comments per issue: 2.83
  • Average comments per pull request: 0.74
  • Merged pull requests: 36
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 17
  • Average time to close issues: N/A
  • Average time to close pull requests: 16 days
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • billbrod (2)
  • KirillHiddleston (1)
  • berthyf96 (1)
  • Michael-Liao (1)
  • peoplecure (1)
  • kargaranamir (1)
  • saracenaly (1)
  • devernay (1)
  • FUGUILuo (1)
  • tdelanversin (1)
  • pehf (1)
Pull Request Authors
  • billbrod (38)
  • kbonnen (1)
  • freshNfunky (1)
  • TrellixVulnTeam (1)
  • WardBrian (1)
  • pehf (1)
Top Labels
Issue Labels
bug (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 1,529 last-month
  • Total dependent packages: 3
  • Total dependent repositories: 8
  • Total versions: 14
  • Total maintainers: 1
pypi.org: pyrtools

Python tools for multi-scale image processing, including Laplacian pyramids, Wavelets, and Steerable Pyramids.

  • Versions: 14
  • Dependent Packages: 3
  • Dependent Repositories: 8
  • Downloads: 1,529 Last month
Rankings
Dependent packages count: 2.3%
Dependent repos count: 5.2%
Average: 6.9%
Stargazers count: 8.3%
Forks count: 8.4%
Downloads: 10.3%
Maintainers (1)
Last synced: 6 months ago

Dependencies

setup.py pypi
  • Pillow >=3.4
  • matplotlib >=1.5
  • numpy >=1.1
  • requests >=2.21
  • scipy >=0.18
  • tqdm >=4.29
.github/workflows/ci.yml actions
  • FedericoCarboni/setup-ffmpeg v2 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action 858dd794fbb81941b6d60b0dca860878cba60fa9 composite
  • re-actors/alls-green afee1c1eac2a506084c274e9c02c8e0687b48d9e composite
.github/workflows/deploy.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
docs/environment.yml pypi
  • nbsphinx *
  • nbsphinx_link *
  • sphinxcontrib-apidoc *