| IrisClient-class {IRISSeismic} | R Documentation |
Class "IrisClient"
Description
A class for making data and metadata requests from IRIS DMC web services.
Slots
site:Object of class
"character": this is the first part of the url that the web service will be pointed to, defaults tohttps://service.iris.eduservice_type:Object of class
"character": defaults tofdsnws; for data retrieval from the IRIS PH5 repository, set this toph5ws;debug:Object of class
"logical": when set to TRUE will cause any web service requestURL to be printeduseragent:Object of class
"character": client identification string
Methods
- getAvailability
-
makes a channel request of the station web service and returns the result as a dataframe; see
getAvailability - getChannel
-
makes a channel request of the station web service and returns the result as a dataframe; see
getChannel - getDataAvailability
-
makes a channel request of the irisws availability web service and returns the result as a dataframe; see
getDataAvailability - getDataselect
-
makes a request of the dataselect web service and returns a
Streamobject; seegetDataselect - getDistaz
-
makes a request of the distaz web service and returns a the information as a dataframe; see
getDistaz - getEvalresp
-
makes a request of the instrument response web service and returns the information as a dataframe; see
getEvalresp - getEvent
-
makes a request of the event web service and returns the information as a dataframe, if
site='https://service.iris.edu' thengetEventwill direct to "https://earthquake.usgs.gov/fdsnws/event/1/query?"; seegetEvent - getNetwork
-
makes a network request of the station web service and returns the result as a dataframe; see
getNetwork - getSNCL:
-
calls the
getDataselectmethod and returns aStreamobject; seegetSNCL - getStation
-
makes a station request of the station web service and returns the result as a dataframe; see
getStation - getTraveltime
-
makes a request of the traveltime web service and returns the information as a dataframe; see
getTraveltime - getUnavailability
-
makes a channel request of the station web service and returns the result as a dataframe; see
getUnavailability
Note
The IrisClient object is inspired by the clients.fdsn.client.Client class found in the
python ObsPy package (https://docs.obspy.org/packages/autogen/obspy.clients.fdsn.client.Client.html).
Author(s)
Jonathan Callahan jonathan@mazamascience.com
Examples
## Not run:
# Open a connection to IRIS DMC webservices
iris <- new("IrisClient", debug=TRUE)
starttime <- as.POSIXct("2012-01-24", tz="GMT")
endtime <- as.POSIXct("2012-01-25", tz="GMT")
# Get the waveform
st <- getDataselect(iris,"AK","PIN","","BHZ",starttime,endtime)
mean(st)
## End(Not run)