SWIFT_BAT_GRB_POS_ACK conversion #36
Conversation
Explicit int conversion removed MAXI_UNKNOWN conversion Removed GECAM_FLT and GECAM_GND conversion Added documentation and changed function name reformatted file deleted files
|
@parsotat, would you please review this? |
…sary equalities changed Unused to intentionally omitted reformated comments
| comments = "\n".join( | ||
| [val for (key, val) in flag_descriptions.items() if (soln_status_bits[key])] | ||
| ) |
There was a problem hiding this comment.
Please capture these flags in a machine-readable way, not as comments.
There was a problem hiding this comment.
I use additional_info to capture the data stored in the COMMENTS: fields in the text notices. Some of these are redundant with the data in the notices and can be removed(I've mainly added them for completeness). However, some of the these comments I think may be too complex to easily translate into a field like "StarTracker not locked so trigger probably bogus" or "This was orginally a SubTresh, but it is now converted to a real BAT_POS.".
f#inished comments
| "image_peak": bin[10], | ||
| "background_events": bin[22], | ||
| "background_start_time": utils.datetime_to_iso8601(bin[5], bin[23]), | ||
| "backgroun_duration": bin[24] * 1e-2, |
There was a problem hiding this comment.
typo: should be "background_duration"
There was a problem hiding this comment.
Hey @bob-wiegand! Could you link the package that you used for spell-checking? I think it would be easier for me to run this on my end and correct it for each notice type instead of you having to manually list each error. Thanks!
There was a problem hiding this comment.
Note: I am not sure it would be simpler since it was still somewhat manual.
I ran https://github.com/crate-ci/typos
$ typos --words
on the files to find the words then
$ hunspell -d en_US
to check them. hunspell will build up a dictionary of excusable terms for gcn-*.
The silliest aspect is that I was unable to find a way to get typos to exclude times (e.g., 1987-01-02T03:04:05.6); although extend-ignore-re will exclude the times from the misspelling list, I could not figure out how to get it to exclude them from the word/identifier list.
| "image_peak": bin[10], | ||
| "background_events": bin[22], | ||
| "background_start_time": utils.datetime_to_iso8601(bin[5], bin[23]), | ||
| "backgroun_duration": bin[24] * 1e-2, |
| "image_peak": bin[10], | ||
| "background_events": bin[22], | ||
| "background_start_time": utils.datetime_to_iso8601(bin[5], bin[23]), | ||
| "backgroun_duration": bin[24] * 1e-2, |
| else: | ||
| grb_status = "It is not a GRB" | ||
|
|
||
| calalog_num = bin[25] |
There was a problem hiding this comment.
It does not affect the output, but suggest renaming variable: s/calalog/catalog/
| else: | ||
| grb_status = "It is not a GRB" | ||
|
|
||
| calalog_num = bin[25] |
| "flaring_known_source": bool(soln_status_bits[2]), | ||
| "star_tracker_status": start_tracker_status[soln_status_bits[10]], | ||
| "bright_star_nearby": bool(soln_status_bits[13]), | ||
| "originally_subtresh": bool(soln_status_bits[14]), |
There was a problem hiding this comment.
update subtresh to subthresh.
Would "was_subthreshold" be a better name?
All SWIFT_BAT_* notices have a very similar similar conversion with just a few differing/missing fields. So if the format is acceptable I could commit the rest of the conversions to this pull request as well.
The following keywords do not exist in the core schema for SWIFT_BAT_GRB_POS_ACK: