SeedPSD: histogram
EN
FR
This section of the PPSD webservice generates "Probability Density Functions" (PDFs) images for a defined data source and time period.
URL builder
Documentation
Examples
Usage
/histogram? (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 :: [cmap=<>] [cmax=<>] [coverage=<true|false>] [cumulative=<true|false>] [fontsize=<points>] [grid=<true|false>]
[mean=<true|false>] [mode=<true|false>] [noisemodels=<true|false>] [percentiles=<true|false>]
[xfrequency=<true|false>] [xmin=<>] [xmax=<>] [ymin=<>] [ymax=<>]
(..) mandatory
[..] optional
Parameters
Data source selection
Parameter |
Alias |
Example |
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
- ? : use the question mark as a wildcard to represent any single character.
- * : use the asterisk as a wildcard to represent zero or more characters.
- , : use the comma combine multiple items within a list. Wildcards may be included in the list..
For example, with channel codes: channel=EH?,BHZ
Time period selection
Parameter |
Alias |
Example |
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
Format |
Example |
Description |
YYYY-MM-DDThh:mm:ss[.ssssss] |
1997-01-31T12:04:32.123 |
a date and a time user-defined |
YYYY-MM-DD |
1997-01-31 |
a user-defined date but 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 |
plot.width |
900 |
Output image width (pixels). From 640 to 2000. |
height |
plot.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, plot.color.palette |
viridis_r |
Name of the colormap Matplotlib to use |
cmap |
colormap_max |
cmax |
30 |
Maximum value of the colormap |
max_percentage |
coverage |
|
True |
Displays the data coverage below the PPSD histogram. Only years that are included in the user's selection are shown. The green regions represent available data. The red and blank regions represent gaps in the time series. The bottom blue line shows the measures that are present in the histogram while the grey areas show the grey areas show the unselected data.
|
show_coverage |
cumulative |
|
False |
Cumulative representation of the histogram showing color coded for each frequency/amplitude bin at what percentage in time the value is not exceeded by the data.
|
cumulative |
font_size |
fontsize, plot.labelfont.size |
10 |
Font size |
|
grid |
|
True |
Displays the grid. |
grid |
mean |
|
False |
Displays the mean values of the PSD. |
show_mean |
mode |
plot.minmodemax |
False |
Displays the mode values of the PSD. |
show_mode |
noise_models |
noise, plot.model |
True |
Shows the noise models. |
show_noise_models |
percentiles |
|
False |
Shows the approximate representation of the percentiles. |
show_percentiles |
x_frequency |
xfrequency, frequency, plot.horzaxis |
False |
Displays the X axis in frequency (Hertz) or in period (seconds) |
xaxis_frequency |
x_min |
xmin, plot.period.min |
0.01 |
Minimum limit of periods to be represented on the X axis |
period_lim |
x_max |
xmax, plot.period.max |
179 |
Maximum limit of the periods to be represented on the X axis |
period_lim |
y_min |
ymin, plot.power.min |
-200 |
Minimum limit of values to be represented on the Y axis |
|
y_max |
ymax, plot.power.max |
-50 |
Maximum limit of the values to be represented on the Y axis |
|