Skip to content

Add --strictSFTBand options to lalapps_Makefakedata_v{4|5}

Karl Wette requested to merge ANU-CGA/lalsuite:MFD-strict-band-option into master

Description

Add --strictSFTBand options to lalapps_Makefakedata_v{4|5}, which make these code return SFTs with half-open interval frequency ranges [fmin,fmax). This makes these codes use the same convention as lalapps_MakeSFTs and lalapps_splitSFTs, which is convenient e.g. for tests.

These options are not enabled by default; doing so breaks too many existing behaviours (e.g. the test suite).

Implemented by adding an option strict to XLALExtractBandFromSFT() to control band extraction behaviour: strict=true tries to return a half-open interval, strict=false gives the previous "covering band" behaviour.

API Changes and Justification

Backwards Compatible Changes

  • This change introduces no API changes
  • This change adds new API calls

Backwards Incompatible Changes

  • This change modifies an existing API
  • This change removes an existing API

This change requires passing new information to a C function, which is always ABI-incompatible. (The new ABI will be expecting more memory than the old ABI - either for a new function argument, or a new struct field - which a program linked against the old ABI will not provide.) Alternative would be to copy-n-paste 4 functions and a struct, which is not acceptable from a code maintenance POV - that approach would rapidly lead to code bloat if used consistently.

Review Status

Closes #439 (closed)

Depends on !1687 (merged)

Merge request reports