PPSD: Spectrogram
FR
EN
This section of the PPSD WebService generates spectrogram images for a defined data source and time period.
URL Builder
Documentation
Examples
Usage
/spectrogram? (channel-options) (date-range-options) [image-options] [plot-options] [nodata=404]
where :
channel-options :: (network=<network>) (station=<station>) (location=<location>) (channel=<channel>)
date-range-options :: (starttime=<date>) (endtime=<date>)
image-options :: [dpi=<dots per inch>] [width=<pixels>] [height=<pixels>]
[format=<png|jpg|pdf>] [transparent=<true|false>]
plot-options :: [grid=<true|false>] [cmap=<>] [cmax=<>]
[xmin=<>] [xmax=<>] [ymin=<>] [ymax=<>]
(..) mandatory
[..] optional
Parameters
Data source selection
Parameter |
Alias |
Exemple |
Description |
network |
net |
FR |
Seismic network code. Accepts wildcards and lists. |
station |
sta |
CIEL |
Station code. Accepts wildcards and lists. |
location |
loc |
00 |
Location code. Use loc=-- for empty location codes. Accepts wildcards and lists. |
channel |
cha |
HHZ |
Channel code. Accepts wildcards and lists. |
Wildcards and lists
- Wildcards: the question mark ? represents any single character, while the asterisk * represents zero or more characters.
- List: multiple items may be retrieved using a comma-separated list. Wildcards may be included in the list.
For example, with channel codes: channel=EH?,BHZ
Time period selection
Parameter |
Alias |
Exemple |
Description |
starttime |
start |
2010-01-10T00:00:00 |
Selects power spectral densities from the specified time inclusive. |
endtime |
end |
2011-02-11T01:00:00 |
Selects power spectral densities before the specified time inclusive. |
Date and time formats
YYYY-MM-DDThh:mm:ss[.ssssss] ex. 1997-01-31T12:04:32.123
YYYY-MM-DD ex. 1997-01-31 (a time of 00:00:00 is assumed)
currentutcday (today at 00:00:00)
with :
YYYY :: four digits of the year
MM :: two digits of the month (01=January, etc.)
DD :: two digits of the day of the month (01 to 31)
T :: date-time separator
hh :: two digits of the hour (00 to 23)
mm :: two digits of minutes (00 to 59)
ss :: two digits of the seconds (00 to 59)
ssssss :: one to six digits of microseconds in decimal base (0 to 999999)
Image configuration
Parameter |
Alias |
Default |
Description |
width |
|
900 |
Output image width (pixels). From 640 to 2000. |
height |
|
600 |
Height of the output image (pixels). From 480 to 2000. |
dpi |
|
100 |
Image resolution. |
format |
|
png |
File output format: PNG, JPG, PDF. |
nodata |
|
204 |
Return code in case of missing data |
transparent |
|
true |
Activate the transparency of the image background (valid only for PNG format). |
Graphical options
Parameter |
Alias |
Default |
Description |
ObsPy |
colormap |
cmap |
viridis_r |
Name of the colormap Matplotlib to use |
cmap |
colormap_max |
cmax |
30 |
Maximum value of the colormap |
|
grid |
|
true |
Displays the grid |
grid |
period_min |
xmin |
0.01 |
Minimum limit of periods to be represented on the X axis |
|
period_max |
xmax |
179 |
Maximum limit of the periods to be represented on the X axis |
|
power_min |
ymin |
-200 |
Minimum limit of values to be represented on the Y axis |
|
power_max |
ymax |
-50 |
Maximum limit of the values to be represented on the Y axis |
|