Allow combining masks using dials.generate_mask

[phyy-nx]

eg dials.generate_mask imported.expt beamcenter.mask border=1

or dials.generate_mask beamcenter.mask border.mask

Requires cctbx/dxtbx#744

• TODO: update docs and add a test

[biochem-fan]

Hi Aaron, this is a great functionality I also need.

TODO: update docs and add a test

Yes, documenting how masking works in DIALS would be very nice.

It is not clear how the trusted range mask, the mask from a dxtbx class and the user supplied mask work. Are they combined, or one replaces the other?

There are some old discussions (e.g. #236 and #1340) but I am not sure if the current implementation works in the same way.

[phyy-nx]

It is not clear how the trusted range mask, the mask from a dxtbx class and the user supplied mask work. Are they combined, or one replaces the other?

My understanding is that the final mask for spotfinding and integration is the static mask from dxtbx & the dynamic mask from dxtbx & the trusted range mask & the user supplied mask

[codecov]

Codecov Report

Attention: Patch coverage is 72.72727% with 15 lines in your changes missing coverage. Please review.

Project coverage is 78.19%. Comparing base (1052d96) to head (24bde47).
Report is 7 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2711      +/-   ##
==========================================
+ Coverage   78.16%   78.19%   +0.03%     
==========================================
  Files         616      616              
  Lines       76578    76730     +152     
  Branches    10978    11020      +42     
==========================================
+ Hits        59855    60001     +146     
- Misses      14485    14486       +1     
- Partials     2238     2243       +5     

[graeme-winter]

Mostly cosmetic though some comments around handling files gracefully which are pickled but not pickled masks

starting is a nasty prefix, suggested improvements

[phyy-nx]

Mostly cosmetic though some comments around handling files gracefully which are pickled but not pickled masks

starting is a nasty prefix, suggested improvements

Done!

[phyy-nx]

@graeme-winter this is ready for your re-review. Tests are passing. Thanks!

[graeme-winter]

Reviewed following updates, thank you