Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

These web services are the back-end of the MWA triggering system, described in detail Hancock et al, 2019 (https://ui.adsabs.harvard.edu/link_gateway/2019PASA...36...46H/EPRINT_PDF)

...

Parameters can be passed in the URL, as with the other services, but there are usually a lot of them, so POSTing them is or you can POST them if preferred.

Base parameters are:

...

  • result['success'] - a Boolean, True if the observations were scheduled successfully, False if there was an error.
  • result['errors'] - a dictionary, containing integer keys from 0-N, where each value is an error message. Normally empty.
  • result['params'] - a dictionary containing all parameters passed to the web service, after parsing, and some extra parameters calculated by the web service (the name of the automatically chosen calibrator, etc).
  • result['clear'] - the commands used to clear the schedule. It contains the keys/values:
    • 'command': The full clear_schedule.py command line
    • 'retcode': The integer return code from that command
    • 'stderr': The output to STDERR from that command
    • 'stdout': The output to STDOUT from that command
  • result['schedule'] - the commands used to schedule the triggered observations. It contains the keys/values:
    • 'command': A string containing all of the schedule_observation.py command lines
    • 'retcode':The integer return code from the shell spawned to run those commands
    • 'stderr': The output to STDERR from those commands
    • 'stdout': The output to STDOUT from those commands
  • result['trigger_id'] - A unique integer identifying this particular call to the trigger service. You can use this to look up more details using the trigger 'find' web service (see below).
  • result['obsid_list'] - The observation IDs of all MWA observations covered by the buffer dump and subsequent voltage capture. Use these observation IDs to download the voltage capture files, and to determine the telescope setting/s during the time span including the captured data.

Find - Search for and view past calls to trigger observations using these web services

eg: https://ws.mwatelescope.org/trigger/find

When called with no parameters, this service returns a web form for entering parameters to search for previous triggers, like the 'find observatons' metadata web service.

If called with parameters, this service returns (depending on the html parameter) either an HTML page or a JSON structure, with a list of trigger calls.

Optional parameters are:

  • pagesize: By default, the web service returns a maximum of 200 triggers at a time. Use this parameter to specify a smaller page size, or (with care) a larger one.
  • page: By default, the web service returns the first pagesize results. If you pass a number in the page argument, then that 'page' of results is returned instead.
  • html: If this parameter is given, the results are returned in human-readable format as a web page, instead of a JSON structure. If there are more than pagesize observations, buttons to skip to other pages will be shown as well. Clicking on the obsid in the results takes you to the observation summary page (described below).
  • trigger_id: Returns a single result, with this trigger ID.
  • trigger_mode: one of 'MWAX_CORRELATOR', 'MWAX_VCS' or 'BUFFER'
  • pretend: One of 'on', 'true', or a non-zero integer to find only 'pretend mode' triggers, or anything else to find only 'not pretend mode' triggers.
  • success: One of 'on', 'true', or a non-zero integer to find only successful triggers, or anything else to find only not-successful triggers (that failed generate observations or data).
  • mintime_utc, maxtime_utc: Time constraints for when the trigger happened, in ISOT string format.
  • project_id: Return only triggers called with this project ID code.
  • obsname: Matches the observation name passed with the trigger call. Use the '%' character as a wildcard matching 0 or more occurrences of any character.
  • creator: Matches the creator name passed with the trigger call. Use the '%' character as a wildcard matching 0 or more occurrences of any character.
  • desc: If supplied, with any value, reverse the sort order.
  • pretty: If supplied and evaluates to True, pretty-format the JSON stucture for human readability.


Show - View detailed information about a single past call to trigger observations

eg: https://ws.mwatelescope.org/trigger/show?trigger_id=17

Given a single trigger ID, this service returns detailed information about that trigger. Currently this service only returns  JSON structure, but it will be ugraded to return a web page instead.

Parameters are: