IRIS DMC MUSTANG noise-pdf-browser Web Service Documentation

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.

Below is a full list of service parameters and their usage.

Query Usage

/gallery

/gallery? (channel-options) [date-range-options] [image-size-options] [format-options] [no-data-options]

Where:

channel-options    :: (net[work]=<network>&sta[tion]=<station>&loc[ation]=<location>&cha[annel]=<channel>) | 
                      (target=<nslcq>[,<nslcq>...])
date-range-options :: [starttime=<time>][endtime=<time>][maxintervals=<number-of-date-intervals>]
                      [interval=<all|year|month|week>]
image-size-options :: [imgwidth=<image-width-pixels>] [imgheight=<image-height-pixels>]

/breakout

/breakout? (channel-options) [date-range-options]  [image-size-options] [format-options] [no-data-options]

Where:

channel-options    :: (net[work]=<network>&sta[tion]=<station>&loc[ation]=<location>&cha[annel]=<channel>) | 
                      (target=<nslcq>)
date-range-options :: [time=<time>](interval=<all|year|month|week>)
image-size-options :: [imgwidth=<image-width-pixels>] [imgheight=<image-height-pixels>]
                      [subimgwidth=<image-width-pixels>] [subimgheight=<image-height-pixels>]

/summary

/summary? (channel-options) [format-options] [no-data-options]

Where:

channel-options    :: (net[work]=<network>&sta[tion]=<station>&loc[ation]=<location>&cha[annel]=<channel>) | 
                      (target=<nslcq>[,<nslcq>...])

format-options  :: (format=<text|json|html>)
no-data-options :: (nodata=<200|204|404>)
(..) required
[..] optional

Sample Queries

Gallery View
…/gallery?target=IU.ANMO.00.*.M
…/gallery?target=IU.ANMO.*.*.M&starttime=2011-03-01&interval=month&maxintervals=5
…/gallery?target=IU.*.*.BH1.M&endtime=2012-01-01&interval=year&maxintervals=3
…/gallery?target=IU.ANMO.00.BH?.M&starttime=2011-03-01&endtime=2011-06-02&interval=month
…/gallery?target=IU.ANMO.*.*.M&format=text
…/gallery?network=IU&station=ANMO&channel=BH1,BH2,BHZ&interval=all&starttime=2011-03-01&endtime=2011-06-02

Breakout View
…/breakout?target=IU.ANMO.00.BH2.M
…/breakout?target=IU.ADK.00.BH1.M&time=2010-01-01&interval=year

Summary View
…/summary?target=IU.*.*.BH?.M
…/summary?target=IU.*.*.BH?.M&format=text
…/summary?target=IU.*.*.BH?.M&format=json

Detailed Descriptions of each Query Parameter

Common Parameters

All three methods take these parameters.

parameter examples discussion default type
net[work] IU Select SEED Network code. (*) (**) string
sta[tion] ANMO Select SEED station code. (*) (**) string
loc[tion] 00 Select SEED location code.(*). Use — for empty (**) string
cha[nnel] BH? Select SEED channel code. (*) (**) string
quality M Select SEED channel code.(*) (**) string
target IU.ANMO.00.BHZ.M Select mustang target name (*) string
format html one of html, json or text html string
nodata 200 Determines http response code when query results in no data. Must be one of 200, 204, 404 200 string

(*) For the /gallery and /summary methods glob wild cards of * and ? can be used as well as CSV (comma separated value) lists.

(**) For the /gallery and /summary methods, if any of the [network, station, location, channel, quality] parameters are set, any unspecified parameters from that set will be wild carded.

/gallery Parameters

parameter example discussion default type
starttime 2010-12-01 start time of gallery (see help) not set day
endtime 2013-03-02 start time of gallery (see help) current time day
maxintervals 5 number of time intervals to display (see help) 4 number
interval month one of all, year, month, week, day (see help) year string
imgwidth 400 pixel width of generated images 250 positive number
imgheight 300 pixel height of generated images 200 positive number

Any combination of starttime, endtime and maxintervals is allowed except for all three together.

Multiple targets allowed: yes

/breakout Parameters

parameter example discussion default type
time 2010-12-01 time of selected interval (see help) current time day
interval month one of all, year, month, week, day (see help) all string
imgwidth 500 pixel width of main image 500 positive number
imgheight 400 pixel height of main image 400 positive number
subimgwidth 250 pixel width of sub-interval images 250 positive number
subimgheight 200 pixel height of sub-interval images 200 positive number

If interval=all is selected, the time parameter is ignored and is not required. Otherwise, the time parameter is required.

Multiple targets allowed: no

/summary Parameters

Takes all common parameters.

Multiple targets allowed: yes


MUSTANG noise-pdf-browser web service