Skip to content

Allow lalpulsar_MakeSFTs to skip channels if not in frames

Evan Goetz requested to merge evan-goetz/lalsuite:skip-chans into master

Description

This will not be the default mode of operation, but with this MR, a user can set a flag (--allow-skipping=TRUE) that allows the program to skip channels if they are not in the frame files. The default mode (--allow-skipping=FALSE) will be an error is emitted, otherwise just a warning that SFTs for that channel will not be created. Additionally, if a channel could not have SFTs created because of the channel not being in frames or the sample rate is too low and the user had specified --allow-skipping=TRUE, then an empty file nosfts in the output path is created and the program moves on.

This optional mode of operation is helpful for Fscans when monitoring a list of channels and a channel is removed/renamed/sample rate changed by commissioners causing the workflow to break and causing a lot of downstream headaches when averaging over a day/week/month where the channel change has occurred

This change should have no detrimental impact on any production code since it maintains the current operation which is to fail on a channel not being present in frames or sample rate being too low.

Additional tests have been added to verify the correct behaviour is maintained.

API Changes and Justification

Backwards Compatible Changes

  • This change does not modify any class/function/struct/type definitions in a public C header file or any Python class/function definitions
  • This change adds new classes/functions/structs/types to a public C header file or Python module

Backwards Incompatible Changes

  • This change modifies an existing class/function/struct/type definition in a public C header file or Python module
  • This change removes an existing class/function/struct/type from a public C header file or Python module

If any of the Backwards Incompatible check boxes are ticked please provide a justification why this change is necessary and why it needs to be done in a backwards incompatible way.

Review Status

Should be checked over by @karl-wette and/or @david-keitel. @ansel-neunzert may be interested to check this out as well

Edited by Evan Goetz

Merge request reports