NSF SAGE Facility MUSTANG noise-pdf Web Service Documentation

Description

The noise-pdf web service returns Probability Density Functions (PDFs) for seismic channels.

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

Query Usage

/query? (channel-options) [date-range-options] [plot-options] (format-option) [noiseprofile-options] [nodata-option]

Where:

channel-options      :: (net[work]=<network>&sta[tion]=<station>&loc[ation]=<location>&cha[annel]=<channel>) | 
                        (target=<nslcq>[,<nslcq>...])
date-range-options   :: [start[time]=<time>]&[end[time]=<time>]
plot-options         :: [plot.height=<pixel-height>] [plot.width=<pixel-width>] [plot.model=<show|hide>] 
                        [plot.minmodemax=<show|hide>] [plot.legend=<show|hide>]
                        [plot.title=<'title'|hide>] [plot.subtitle=<'title'|hide>]
                        [plot.titlefont.size=<value>][plot.subtitlefont.size=<value>]
                        [plot.labelfont.size=<value>][plot.axisfont.size=<value>]
                        [plot.period.max=<value>] [plot.period.min=<value>] 
                        [plot.period.label=<'title'|show|hide>] [plot.period.axis=<show|hide>]
                        [plot.power.max=<value>] [plot.power.min=<value>] 
                        [plot.power.label=<show|hide>] [plot.power.axis=<show|hide>] 
                        [plot.frequency.label=<'title'|show|hide] [plot.frequency.axis=<show|hide>] 
                        [plot.interpolation=<bicubic|bilinear|none>][plot.histogram=<show|hide>]
                        [plot.scale.display=<show|hide>][plot.scale.label=<'title'|show|hide>]
                        [plot.scale.axis=<show|hide>][plot.scale.width=<pixel-width>]
noiseprofile-options :: [noiseprofile.type=<min,max,mode,mean,median,percentile,...>]
format-option        :: [format=<plot|text|xml|noiseprofile_text|noiseprofile_csvpipe|noiseprofile_xml>]
nodata-option        :: [nodata=<404|204>]

(..) required
[..] optional

Sample Queries

Comma Separated Values (csv)
../query?target=IU.ANMO.00.BHZ.M&starttime=2013-12-01&endtime=2013-12-31&format=text

XML
../query?target=IU.ANMO.00.BHZ.M&starttime=2013-12-01&endtime=2013-12-31&format=xml

Plot
../query?target=IU.ANMO.00.BHZ.M&starttime=2013-12-01&endtime=2013-12-31&format=plot

Plot With Color Scale
../query?target=IU.ANMO.00.BHZ.M&starttime=2013-12-01&endtime=2013-12-31&format=plot&plot.scale.display=show

Noise Profile

Detailed Descriptions of each Query Parameter

parameter examples discussion default type
start[time] 2010-12-19 Limit to PSD data starting between starttime (inclusive) and endtime (exclusive) earliest available day
end[time] 2010-12-20 Limit to PSD data starting between starttime (inclusive) and endtime (exclusive) latest available day
net[work] IU Select Network code. (can be glob wildcard) string
sta[tion] ANMO Select station code. (can be glob wildcard) string
loc[ation] 00 Select location code. Use -- for empty location. (can be glob wildcard). string
cha[nnel] BH? Select channel code. (can be glob wildcard) string
quality * Select quality code. M for data from our miniSEED archive. D for data from our PH5 archive. (can be glob wildcard) string
target IU.ANMO.00.BHZ.M Network.Station.Location.Channel.Quality. Can be comma separated list or multiple target parameters string
format plot plot, xml, text, noiseprofile_text, noiseprofile_xml, noiseprofile_csvpipe string
nodata 404 Http response codes for no data found 404, 204 404 (subject to change) 204, 404
plot.height 7500 Height of plot in pixels 500 positive integer
plot.width 1000 Width of plot in pixels 700 positive integer
plot.title My+Title Alternative to auto generated title. hide for no title. auto from target list url encoded string
plot.titlefont.size 12 Sets the title font size. Auto postitive integer
plot.subtitle My+Subtitle Alternative to auto generated title. hide for no subtitle auto from date range url encoded string
plot.subtitlefont.size 12 Sets the sub-title font size. Auto postitive integer
plot.period.min 0.1 Minimum period of plot. Must be given with power.period.max auto from data positive number
plot.period.max 50 Maximum period of plot. Must be given with power.period.min auto from data positive number
plot.period.label hide Hide or show “Period (seconds)” show show, hide or custom
plot.period.axis hide Hide or show period axis show show, hide
plot.power.min -190 Minimum power of plot. Must be given with plot.power.max auto from data integer
plot.power.max -120 Maximum power of plot. Must be given with plot.power.min auto from data integer
plot.power.label hide Hide or show “Power[10log…[db]]” show show, hide or custom
plot.power.axis hide Hide or show power axis show show, hide
plot.frequency.label hide Hide or show “Frequency (Hz)” show show, hide or custom
plot.frequency.axis hide Hide or show frequency axis show show, hide
plot.labelfont.size 18 Manually set the size of axis labels auto positive integer
plot.model show Hide or show the Peterson high and low noise models show show, hide
plot.minmodemax hide Hide or show min, mode, max curves show show, hide
plot.legend hide Hide or show the inset legend box show show, hide
plot.interpolation bicubic histogram image interpolation method bicubic bicubic, bilinear, none
plot.histogram hide Hide or show histogram image show show, hide
plot.scale.display show Hide or show color scale hide show, hide
plot.scale.label hide Hide, show, or give a custom scale label show, hide or custom
plot.scale.axis hide Hide, show, or scale axis show, hide
plot.scale.width 20 Pixel width of the color scale pixel width
noiseprofile.type mean,5,95 Comma separated list min, mean, median, mode, max, [integer 0-100]

Date Formats

Year, Month, Day in Month:

YYYY-MM-DD ex. 1997-01-31 a time of 00:00:00 is assumed

Where:

YYYY	:: four-digit year
MM	:: two-digit month (01=January, etc.)
DD	:: two-digit day of month (01 through 31)

Problems with this service?

Please send an email report of which service you were using, your URL query, and any error feedback to:
data-help@earthscope.org
We will address your issue as soon as possible.

MUSTANG noise-pdf web service