enhance bin and crop API docstring with examples #191
Conversation
bobleesj
left a comment
There was a problem hiding this comment.
@arthurmccray ready for review - I think I asked you before what was the best way to crop 4dstem dataset so that I can fit stuff in VRAM. I am sure there will be another @bobleesj down the road.
|
I was also looking at whether But I think being able to free the original array makes this |
There was a problem hiding this comment.
lgtm!
regarding modify_in_place=True, memory profiling can be a little annoying in python, but I'm pretty sure that this should work as expected and free the memory. And it's nice having both this and the slicing methods so we have the option for views as well :)
|
@arthurmccray Thanks Arthur for your quick review. If it looks ok! please merge! I will just double check whether it frees the memory! |
What this PR does
cropandbinare commonly used during the first few cells of 4D-STEM data processing.While its usage can be learned from the notebooks, this PR adds examples to the documentation so users can use it w/o searching through notebooks (experienced by @bobleesj since RAM is precious)
What should reviewer(s) do
No function changed. Just enhancing the doc. Please take a quick look at the in-line.