Global masking

[james-trayford]

Apply a global mask to autoplotter plots. This can be specified in the pipeline config.yaml, and constructed in registration.py. Without specification, no mask is applied.

Changes straddle the pipeline and pipeline-configs repositories see also PRs SWIFTSIM/pipeline#25, SWIFTSIM/pipeline-configs#130.

[MatthieuSchaller]

Do you have an example of how to use this in the auto-plotter?

[james-trayford]

@MatthieuSchaller Thanks for the review, this should work in conjunction with the other two pull requests, I just tagged the lines in the pipeline-config PR (SWIFTSIM/pipeline-configs#130) where the global mask is specified and registered, note you will also need the SWIFTSIM/pipeline#25 PR changes for auto_plotter_global_mask to be a valid parameter in config.yml

[MatthieuSchaller]

I am happy with this to be merged. Does what it should.

[JBorrow]

Has this been tested in production yet? I'm concerned about the use of x_mask = self.global_mask and then the modification of x_mask.

[EvgeniiChaikin]

Hi @james-trayford,

I reviewed your changes. Everything looks good and works as expected. I added a couple of comments, mostly to improve the readability of the code.

You may also want to add the global mask tag here https://github.com/james-trayford/velociraptor-python/blob/master/velociraptor-plot#L152 in case someone decides to use auto plotter separately from swift-pipeline.

[james-trayford]

Has this been tested in production yet? I'm concerned about the use of x_mask = self.global_mask and then the modification of x_mask.

I think this works, I've replaced the modification of x_mask to avoid conclusion, but I keep x_mask as a temporary array to combine the global and plot-level structure masks.

[EvgeniiChaikin]

Everything looks good! Just added one more comment. Apart from that, I think this branch is ready to be merged after SWIFTSIM/pipeline#25 is rebased to the current master