API¶
-
class
ltf_catalog.
Catalog
(data)[source]¶ -
data
¶ Returns a numpy.ndarray containing the currently loaded data
-
get_catalog_of_detections
(*criteria)[source]¶ Return a new catalog containing only the detections, according to the default criteria or the custom one specified during the call.
Examples:
Get the detections with the standard criteria (Final_TS >= 25 and GRB_Events >= 3):
> detections = c.get_catalog_of_detections()Get the detections requiring a TS larger than 30 and more than 10 events:
> detections = c.get_catalog_of_detections(“Final_TS >= 30”,”GRB_events >= 10”)
-
triggers
¶ Return the list of all the triggers
-
-
class
ltf_catalog.
TriggerResults
(name, windows)[source]¶ -
date
¶ Returns the date in UTC format
Returns: a string containing the date in UTC format
-
gcn_type
¶ Returns the GCN_type, which can be used to figure out if this GRB belongs to the seed from the GBM, INTEGRAL, SWIFT and so on
Returns: a string
-
get_longest_time_scale_with_detection
(TS=25)[source]¶ Returns the longest time scale among the time windows having a TS larger than TS
Parameters: TS – threshold for claiming a detection (default : 25) Returns: the longest time windows
-
get_position_with_smallest_error
(TS=25)[source]¶ Returns the position with the smallest error among all the time scales where the candidate has a TS larger than the provided threshold
Parameters: TS – threshold for TS (default: 25) Returns: a tuple (R.A., Dec, error), where the error is the 90% containment (statistical only)
-
maximum_TS
¶ Returns the largest TS
Returns: the maximum of TS
-
name
¶ Return the trigger name
Returns: trigger name
-
time_scale_with_largest_TS
¶ Returns the time scale which resulted in the largest TS
Returns: the time window with the maximum TS
-
trigger_time
¶ Returns the trigger time
Returns: the trigger time
-
windows
¶ Returns the time windows for this trigger where the search has been successfully executed
Returns: a list of time windows
-