Skip to content

MFDv5: Enforce Window beta whenever using noise SFTs

Rodrigo Tenorio requested to merge rodrigo.tenorio/lalsuite:614-mfdv5-enforce-window-beta into master

Description

Parse input window name whenever the check is done, check if it requires a beta parameter, and if it does make sure the user set it. This is done using XLALParseWindowNameAndCheckBeta to parse the window name and then using the list of allowed windows to check whether window is allowed.

  • I'm missing a test case
  • This will break any code in which tukey is called without a beta. That should have been always the case though. @karl-wette @david-keitel ?

API Changes and Justification

@karl-wette @david-keitel technical review would be very much appreciated.

The following are required for MFDv5 to be able to retrieve 1) window name 2) whether beta is required:

  1. Add prototype XLALParseWindowNameAndCheckBeta to window/Window.h and remove static key.
  2. Define AllowedWindows[LAL_WINDOWTYPE_LAST] as an extern in window/Window.h.

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

Closes #614 (closed)

Edited by Rodrigo Tenorio

Merge request reports