apps.alerts¶
A django application for serving up data about recently observed LSST/ZTF alerts published in a collection of configured PubSub topics.
apps.alerts.urls¶
The urls module configures routes from URLs to views.
| URL | View | name |
|---|---|---|
/ |
RecentAlertsView |
recent-alerts |
<str:pk> |
AlertSummaryView |
alert-summary |
json/ |
AlertsJsonView |
alerts-json |
apps.alerts.forms¶
The forms module defines views forms for data entry and query
construction.
broker_web.apps.alerts.forms.FilterAlertsForm |
Form for filtering a table of alerts |
-
class
broker_web.apps.alerts.forms.FilterAlertsForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None)¶ Form for filtering a table of alerts
- Fields:
- include_internal (
BooleanField) min_ra (FloatField) max_ra (FloatField) min_dec (FloatField) max_dec (FloatField)` time_range (DurationField)
apps.alerts.views¶
The views module defines View objects for converting web requests
into rendered responses.
broker_web.apps.alerts.views.AlertsJsonView |
Serves recent alerts as a paginated JSON response |
broker_web.apps.alerts.views.AlertSummaryView |
Displays information about a single alert |
broker_web.apps.alerts.views.RecentAlertsView |
Provides a summary table of recently ingested alerts |
-
class
broker_web.apps.alerts.views.AlertSummaryView(**kwargs)¶ Displays information about a single alert
-
get(request, *args, **kwargs)¶ Handle an incoming HTTP request
Parameters: request (HttpRequest) – Incoming HTTP request Returns: Outgoing JsonResponse
-
get_alert_data_for_id(alert_id, survey)¶ Retrieve alert data for a given alert ID
Parameters: - alert_id (int) – Id of the alert to retrieve data for
- survey (str) – Parent survey of the alert
Returns: A dictionary of alert data
-
static
get_value_added_data_for_id(alert_id, survey)¶ Retrieve value added data products for a given alert ID
Parameters: - alert_id (int) – Id of the alert to retrieve data for
- survey (str) – Parent survey of the alert
Returns: A dictionary of value added data products
-
-
class
broker_web.apps.alerts.views.AlertsJsonView(**kwargs)¶ Serves recent alerts as a paginated JSON response
-
static
fetch_alerts_as_dicts(request, num_alerts=10000)¶ Returns a list of recent alerts messages as dicts
Parameters: - request (HttpRequest) – Incoming HTTP request
- num_alerts (int) – Maximum number of alerts to return
Returns: A list of dictionaries representing
-
get(request)¶ Handle an incoming HTTP request
Parameters: request (HttpRequest) – Incoming HTTP request Returns: Outgoing JsonResponse
-
static
-
class
broker_web.apps.alerts.views.RecentAlertsView(**kwargs)¶ Provides a summary table of recently ingested alerts
-
get(request)¶ Handle an incoming HTTP request
Parameters: request (HttpRequest) – Incoming HTTP request Returns: Outgoing HTTPResponse
-
post(request)¶ Fill in the page’s form with values from the POST request
Parameters: request (HttpRequest) – Incoming HTTP request Returns: Outgoing HTTPResponse
-