Skip to content
Pierre-Étienne Fiquet edited this page Jun 29, 2018 · 21 revisions

Welcome to the pyrtools wiki!

For now, we'll use this to organize how we revamp the code and keep notes on the process.

Organization

We need to overhaul how the code is organized. Right now, it looks a lot like MATLAB, with a single file per function. To make it more pythonic, we should have several files that contain a variety of related functions. Proposed files:

  • tools
    • synthetic_images
    • image statistics
    • display tools
  • pyramids
    • c code and wrapper
    • pyramids
    • filters

reference used for imports: https://chrisyeh96.github.io/2017/08/08/definitive-guide-python-imports.html#summary--key-points

Pyramid hierarchy

Right now, the pyramids inherit classes like this:

pyramid
|
|---------------|
|               |
Spyr            Lpyr
|               |
SFpyr           |------------|
|               |            |
SCFpyr          Gpyr        Wpyr

pyramid is pretty empty right now, should update to contain more meaningful methods (for example, can probably put showPyr) there and see if it's possible to consolidate the separate streams for Lpyr and Spyr.

Clone this wiki locally