Helper Functions( antares.helper )

Global helper functions.

Methods Summary

GenerateCameraAlertStream([alert_num])	Generate a stream of camera alert IDs from the demo database.
ConstructAlertFromID(target_id, target_type)	Generate an alert from the demo database given its ID and type.

Methods Documentation

helper.GenerateCameraAlertStream(alert_num=10)

Generate a stream of camera alert IDs from the demo database.

Parameters:alert_num (int) – the number of camera alerts to be generated. Returns:a list of camera alert IDs. Return type:list

helper.ConstructAlertFromID(target_id, target_type)

Generate an alert from the demo database given its ID and type.

Parameters:

• target_id (int) – ID of the alert to be constructed.
• target_type (string) – type of the alert to be constructed. ‘E’: camera alert, ‘R’: alert replica.

Returns:

antares.alert.Alert constructed alert object.