NEW: Optional median filtering of probe "hot spots"

[a4894z]

This doesn't fix the underlying cause of these hot spots but this should cure the symptoms of the underlying disease for the time being

Purpose

Sometimes we see these strange "hot spots" in the shared probe modes; we are still unsure of the underlying cause of these hot spots but use of a median filter seems to be effective of removing them when do occur.

Approach

I introduce a function that simply takes the absolute value of the shared probe modes, and applies a median filter to each mode. The width of the median window is specified in the .toml file; alternatively we default to NOT using any median filtering.

Pre-Merge Checklists

Submitter

• [ ] Write a helpfully descriptive pull request title.
• [ ] Organize changes into logically grouped commits with descriptive commit messages.
• [ ] Document all new functions.
• [ ] Click 'details' on the readthedocs check to view the updated docs.
• [ ] Write tests for new functions or explain why they are not needed.
• [ ] Address any complaints from pep8speaks.

Reviewer

• [x] Actually read all of the code.
• [ ] Run the new code yourself; the included tests should make this easy.
• [ ] Write a summary of the changes as you understand them.
• [x] Thank the submitter.

[pep8speaks]

Hello @a4894z! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file src/tike/ptycho/probe.py:

Line 142:78: W291 trailing whitespace Line 146:63: E201 whitespace after '(' Line 146:72: E202 whitespace before ')' Line 147:81: E501 line too long (85 > 80 characters) Line 205:66: W291 trailing whitespace

• In the file src/tike/ptycho/ptycho.py:

Line 446:40: E251 unexpected spaces around keyword / parameter equals Line 446:42: E251 unexpected spaces around keyword / parameter equals Line 446:81: E501 line too long (98 > 80 characters)

Comment last updated at 2024-02-07 17:33:58 UTC

[carterbox]

I thought automerge would wait until the tests pass. Oops!