Help: noise-pdf-browser v.1

Description

The noise-pdf-browser web service returns browsable views of PDF noise plots.

There are three service query methods:

/gallery

Produces a grid of PDF images where the columns are selected calendar intervals (for example months) while the rows are selected targets.

/breakout

For specified target, produces a plot of a calendar interval (for example a year) along with plots of the sub-intervals (for example months) that comprise it.

/summary

Produces a list of targets with the date-ranges of available PDF information.

Overview of Service

The noise-pdf-browser web service provides a calendar centric view into the Probability Density Function (PDF) information generated by the mustang system. Along with allowing for the discovery of what PDF calculations have been made, the service makes it possible to quickly discover instrument noise characteristics problems and to pinpoint the dates at which these problems have happened.

Intervals

The /gallery and /breakout methods use date range intervals. Five types of intervals are supported:

  • all
  • year
  • month
  • week
  • day

The all interval represent the entire time range of PDF measurements for any given target. The year interval represents regular calendar years. The month interval represents regular calendar months. The week interval represents weeks running Sunday through Saturday. The day interval represent regular days. All dates are GMT.

The interval parameter is used to select the desired calendar interval type; for example interval=month.

/gallery

The /gallery method displays a grid of PDF images. The horizontal rows are selected targets. The vertical columns are calendar intervals. For example, if interval=year is selected, the columns might be the years 2001, 2002, 2003 and 2004. If no interval parameter is specified, interval=year is used.

The starttime, endtime and maxintervals parameters select which years, months, weeks or days are displayed.

If interval=all is chosen, rows are grouped by the first three letters of the channel name.

If interval=all is chosen, the maxintervals parameter is ignored. The starttime and endtime parameters can be used to time-window the displayed data.

starttime not specified. endtime not specified:

The most recent intervals, for which there is data available for the selected targets, are displayed. 
If the maxinterval parameter is not specified, at most 4 intervals are displayed. 
Example:
   If the most recent PDF data available was in the year 2016 and interval=year&maxintervals=5 were selected, 
   the years 2012, 2013, 2014, 2015, 2016 would be shown.

starttime specified. endtime not specified:

The earliest intervals, going back in time to the given starttime, for which there is data available 
for the selected targets, are displayed. If the maxinterval parameter is not specified, at most 4 
intervals are displayed.
Example:
   If PDF data is available from 2000 to 2010 and interval=year&maxintervals=3&starttime=2001-01-01 
   were selected, the years 2001, 2002, 2003 would be shown.

starttime not specified. endtime specified:

The most recent intervals, going forward in time to the given endtime for which there is data available 
for the selected targets, are displayed. If the maxinterval parameter is not specified, at most 4 intervals are displayed.
Example:
   If PDF data is available from 2000 to 2010 and interval=year&maxintervals=3&endtime=2009-01-01 
   were selected, the years 2006, 2007, 2008 would be shown.

starttime specified. endtime specified:

All intervals overlapping (either partially or completely) by the specified time range are displayed. 
maxintervals cannot be specified.
Example:
   If PDF data is available from 2000 to 2010 and ...@interval=year&starttime=2001-01-01&endtime=2004-01-01@... 
   were selected, the years 2001, 2002, 2003, 2004 would be shown.

Important Note On Interval Selection
The starttime and endtime parameters select which calendar intervals are displayed. They do not clip those intervals. The intervals which are selected are those that overlap with the selected data range; starttime inclusive, endtime exclusive. However, this behavior is different for interval=all. For interval=all the starttime and endtime clip the display data.

Assuming data is available, the following table illustrates what years would be returned for the given parameters:

starttime endtime returned years
starttime=2000-01-01 endtime=2005-01-01 2000, 2001, 2002, 2003, 2004
starttime=2000-08-23 endtime=2005-01-01 2000, 2001, 2002, 2003, 2004
starttime=2000-01-01 endtime=2005-01-02 2000, 2001, 2002, 2003, 2004, 2005
starttime=1999-12-31T23:59:59 endtime=2005-01-01 1999, 2000, 2001, 2002, 2003, 2004

/breakout

The /breakout method displays one main interval and the sub-intervals which cover it.

interval sub-intervals
interval=all years available for the selected target
interval=year months available for the selected year and target
interval=month days available for the selected month and target
interval=week days for the selected week and target
interval=day not accepted

The selected main calendar interval is determined by the time and interval parameters. The time parameter defaults to the current time.
The selected calendar interval will include the given time (start inclusive, end exclusive).

For example: both interval=year&time=2001-01-01 and interval=year&time=2001-11-11 will select the year 2001

/summary

The /summary method displays a list of available targets and the date extents of available PDF measurements. It provides hyper-links to the /breakout view with interval=all selected.

target selection

There are two ways to select targets.

  • Use the target variable
  • Use network, station, location, channel, quality variables

Target selection for /breakout method

The /breakout method allows for only one target to be selected. Therefore, wildcarding is not allowed.

Two ways to select the same target in the breakout method:

Target selection for /gallery and /summary methods

Target selection is flexible. Any combination of the target, network, station, location, channel and quality parameters can be used.

The /gallery and /summary methods allow for multiple targets to be selected.

Wild carding and CSV lists:

The target and network, station, location, channel and quality parameters take glob style wild carding characters * and ? as well as comma separated values CSV list.

Examples:

Automatic wild carding:

If any of the network, station, location, channel and quality parameters are selected, any of the non-selected parameters will be wild carded.

For example network=IU&channel=BHZ will select all of the targets with channel names BHZ in the IU network:

…/gallery?network=IU&channel=BHZ

Simultaneous Request Limitations, Lazy Image Loading and Printing

If the Mustang PDF plotting service (http://service.iris.edu/mustang/noise-pdf/1/) receives too many simultaneous requests from any given client, the offending client will be shut out for 60 seconds. The /gallery and /breakout services are capable of producing HTML output with image links to this service that will cause web-browsers to reach this limit. In order to prevent this from happening, the HTML output made by the /gallery and /breakout services uses a Javascript lazy-image-loading library. This library causes images to not be loaded until they are scrolled into view thus avoiding the simultaneous request limit.

When printing from a web browser, it may be necessary to scroll all of the images into view before printing.

See Also: