apps.objects¶
A django application for serving data concerning recently observed astronomical objects. The focus of this app is on the object itself, and not the corresponding alerts.
apps.objects.urls¶
The urls
module configures routes from URLs to views.
URL | View | name |
---|---|---|
/ |
RecentObjectsView |
recent-objects |
/<str:pk> |
ObjectSummaryView |
object-summary |
/salt2/ |
Salt2FitView |
salt2-fits |
json/ |
RecentObjectsJsonView |
objects-json |
/singlejson/<str:pk> |
RecentAlertsJsonView |
single-object-json |
salt2json/ |
Salt2FitsJsonView |
salt2-fit-json |
salt2json/<str:pk> |
Salt2FitsJsonView |
salt2-fit-json |
apps.objects.forms¶
The forms
module defines views forms for data entry and query
construction.
broker_web.apps.objects.forms.FilterObjectsForm |
Form for filtering a table of alerted objects |
-
class
broker_web.apps.objects.forms.
FilterObjectsForm
(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 alerted objects
- Fields:
- time_range (
DurationField
) min_ra (FloatField
) max_ra (FloatField
) min_dec (FloatField
) max_dec (FloatField
)
apps.objects.views¶
The views
module defines View
objects for converting web requests
into rendered responses.
broker_web.apps.objects.views.ObjectsJsonView |
|
broker_web.apps.objects.views.RecentAlertsJsonView |
|
broker_web.apps.objects.views.ObjectSummaryView |
View for displaying a table of all recent objects matching a query |
broker_web.apps.objects.views.RecentObjectsView |
View for displaying a summary table of objects with recent alerts |
-
class
broker_web.apps.objects.views.
ObjectSummaryView
(**kwargs)¶ View for displaying a table of all recent objects matching a query
-
get
(request, *args, **kwargs)¶ Handle an incoming HTTP request
Parameters: request (HttpRequest) – Incoming HTTP request Returns: Outgoing JsonResponse
-
-
class
broker_web.apps.objects.views.
RecentObjectAlertsJsonView
(**kwargs)¶ JSON rendering of recent alerts for a given object
-
static
fetch_object_alerts
(object_id, limit=50)¶ Return a list of all alerts corresponding to an object Id
Parameters: - object_id (str) – Object identifier
- limit (int) – Maximum number of alerts to return
Returns: A list of dictionaries
-
get
(request, *args, **kwargs)¶ Handle an incoming HTTP request
Parameters: request (HttpRequest) – Incoming HTTP request Returns: Outgoing JsonResponse
-
static
-
class
broker_web.apps.objects.views.
RecentObjectsJsonView
(**kwargs)¶ View for serving recently observed objects as a paginated JSON response
-
static
fetch_objects
(limit=10000)¶ Returns a list of objects with recently issued alerts as a list of dicts
Parameters: limit (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.objects.views.
RecentObjectsView
(**kwargs)¶ View for displaying a summary table of objects with recent 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
-
-
class
broker_web.apps.objects.views.
Salt2FitView
(**kwargs)¶ View for displaying a table of salt2 fits to recently observed objects
-
get
(request, *args, **kwargs)¶ Handle an incoming HTTP request
Parameters: request (HttpRequest) – Incoming HTTP request Returns: Outgoing JsonResponse
-
-
class
broker_web.apps.objects.views.
Salt2FitsJsonView
(**kwargs)¶ View for serving recent Salt2 fit results as a paginated JSON response
-
static
fetch_salt2_fits
(object_id=None, limit=1000)¶ Return a list of recent Salt2 fits for a given astronomical object
Parameters: - object_id (str) – Object identifier
- limit (int) – Maximum number of fits to return
Returns: A list of dictionaries
-
get
(request, *args, **kwargs)¶ Handle an incoming HTTP request
Parameters: request (HttpRequest) – Incoming HTTP request Returns: Outgoing JsonResponse
-
static