scikit-image icon indicating copy to clipboard operation
scikit-image copied to clipboard

Clarify that `pyramid_gaussian` returns a generator, not a sequence of images

Open alexdesiqueira opened this issue 2 years ago • 2 comments

Description

See @grlee77's comment on #6293:

One subtle point that could perhaps be clarified more in this demo is that pyramid_gaussian returns a generator, and not a sequence of images. It is only because it is wrapped in the call to tuple that we get a sequence that we can index into (and one that we can traverse once to determine the shape and then a second time to build up the composite).

alexdesiqueira avatar May 05 '22 17:05 alexdesiqueira

I'm wondering if we should revisit that API decision for skimage2, too.

jni avatar May 06 '22 16:05 jni

@jni could be a good solution. We need consistency :slightly_smiling_face:

alexdesiqueira avatar May 06 '22 16:05 alexdesiqueira

~Hi all - newbie to open source stuff looking to get involved. Would it be ok if I begin with this issue?~

parthgvora avatar Sep 29 '22 18:09 parthgvora

@parthgvora, sorry for the silence on our side. Please feel free to work on this in case you are still interested!

lagru avatar Mar 08 '23 13:03 lagru

Sorry for my silence as well - things got rather busy for me. I'll let another handle this - I don't have the free time unfortunately. Apologies!

parthgvora avatar Mar 13 '23 19:03 parthgvora

No problem and thanks for letting us now! :slightly_smiling_face:

lagru avatar Mar 13 '23 20:03 lagru

Hi, I'm currently working on it and should have a Merge Request out by tomorrow!

jakeMartin1234 avatar Mar 15 '23 06:03 jakeMartin1234

Hi, I made the required change in https://github.com/scikit-image/scikit-image/pull/6835. Please let me know if you think it needs any more changes.

jakeMartin1234 avatar Mar 15 '23 23:03 jakeMartin1234