search

v-morello / riptide

Pulsar searching with the Fast Folding Algorithm (FFA)
https://riptide-ffa.readthedocs.io/
MIT License
30 stars 11 forks source link

Option to disable harmonic flagging #5

Open chiamintan opened 6 months ago

chiamintan commented 6 months ago

The current riptide pipeline set up have harmonic flagging being run all the time. For my case of having a large number of candidates (10000+) with little candidates being flagged (<100), it is not useful to take ~1 hour to run the flagging. So I think there should be an option to disable the harmonic flagging process.

v-morello commented 6 months ago

Hi @chiamintan,

This would be a good addition. There is no way to skip harmonic flagging at the moment. Currently, the harmonic filter parameters are set like so in the config file: https://github.com/v-morello/riptide/blob/90f23860d416bd718d70c9e19a9be2ad55856cfe/riptide/pipeline/config/example.yaml#L177-L181

I suggest adding the following key and adding a check for it in the flag_harmonics method of the pipeline:

harmonic_flagging:
  # Skip harmonic flagging if false
  enable: true

I can do this easily when I have an opening (soon-ish), but it could also be a good exercise for a student in your group to get more familiar with the code and get some git / GitHub MR / Python experience. Your pick.