Description

For skimage2 we want to conform our footprint generating functions and make the API more consistent. We can do a lot here with backward-compatible conventional deprecations. There are two aspects to this:

• (a) Prefix all functions with footprint_*. We decided against consolidation in a submodule during the last EuroSciPy sprint.
• (b) Generalize the signature as much as possible and try to consolidate functions that only differ in number of dimensions. A lot of the functions are married to a specific number of dimensions because of their API (e.g. rectangle(nrows, ncols)). Instead something like footprint_rectangle(shape=...) can account for all dimensions.

Can be closed, when (a) is completely done. We should take (b) into account as we go through each function, but if it proves to much work or maintaining backwards compatibility proves difficult, it's okay to defer that as another breaking change during the skimage2 transition. Decomposition complicates this even more.

Should resolve #7736 before this, since it makes this issue easier.

Blocked by

• Separate decomposed footprint generation into extra functions #7736

Implementing PRs:

• Replace square, rectangle, cube with footprint_rectangular #7566
• Refactor to skimage.morphology.footprint_octagon #7626
• WIP: Refactor to skimage.morphology.footprint_ellipse #7628