taup.path
Module Contents
Classes
API
- class taup.path.PathQuery
Initialization
- calc(taupServer)
Sends all params to the server, returns the result parsed from JSON into dataclasses.
- calcJson(taupServer)
Sends all params to the server, returns the result parsed from JSON.
- calcGmt(taupServer)
Sends all params to the server, returns the result as a text version of gmt.
- calcHtml(taupServer)
Sends all params to the server, returns the result as a text version of html.
- calcSvg(taupServer)
Sends all params to the server, returns the result as a text version of svg.
- calcText(taupServer)
Sends all params to the server, returns the result as a text version of text.
- get_allindex()
returns current value of allindex as a Boolean
- allindex(val)
Sets the allindex parameter, of type Boolean
all arrivals at sampling of model
Known as
--allindexin command line.- Parameters:
val – value to set allindex to
- get_az()
returns current value of az as a Double
- az(val)
Sets the az parameter, of type Double
azimuth in degrees, source to receiver
Known as
--azin command line.- Parameters:
val – value to set az to
- get_baz()
returns current value of baz as a Double
- baz(val)
Sets the baz parameter, of type Double
backazimuth in degrees, receiver to source
Known as
--bazin command line.- Parameters:
val – value to set baz to
- get_color()
returns current value of color as a edu.sc.seis.TauP.cmdline.args.ColorType
- color(val)
- Sets the color parameter, a choice of one of:
auto, wavetype, phase, none
style of coloring for paths and wavefronts, one of: auto, wavetype, phase, none
Known as
--colorin command line.- Parameters:
val – value to set color to
- get_degminmax()
returns current value of degminmax as a [D
- degminmax(val)
Sets the degminmax parameter, of type [D
min and max distance in degrees for plotting
Known as
--degminmaxin command line.- Parameters:
val – value to set degminmax to
- get_deg()
returns current value of degree as a List
- deg(val)
Sets the degree parameter, of type List of Double If a single Double is passed in, it is automatically wrapped in a list. So params.deg( value ) and params.deg( [ value ] ) are equivalent.
distance in degrees
Known as
--degin command line. Also known as--degreein command line.- Parameters:
val – value to set degree to
- andDeg(val)
Append a value to the degree parameter, of type Double
distance in degrees
Known as
--degin command line. Also known as--degreein command line.- Parameters:
val – value to set degree to
- get_degree()
returns current value of degree as a List
- degree(val)
Sets the degree parameter, of type List of Double If a single Double is passed in, it is automatically wrapped in a list. So params.degree( value ) and params.degree( [ value ] ) are equivalent.
distance in degrees
Known as
--degreein command line.- Parameters:
val – value to set degree to
- andDegree(val)
Append a value to the degree parameter, of type Double
distance in degrees
Known as
--degreein command line.- Parameters:
val – value to set degree to
- get_degreerange()
returns current value of degreerange as a List
- degreerange(val)
Sets the degreerange parameter, of type List of Double step or min,max or min,max,step
regular distance range in degrees, one of step; min max or min max step. Default min is 0, max is 180 and step is 10.
Known as
--degreerangein command line.- Parameters:
val – value to set degreerange to
- andDegreerange(val)
Append a value to the degreerange parameter, of type Double
regular distance range in degrees, one of step; min max or min max step. Default min is 0, max is 180 and step is 10.
Known as
--degreerangein command line.- Parameters:
val – value to set degreerange to
- get_depthminmax()
returns current value of depthminmax as a [D
- depthminmax(val)
Sets the depthminmax parameter, of type [D
min and max depth, km, for plotting
Known as
--depthminmaxin command line.- Parameters:
val – value to set depthminmax to
- get_evt()
returns current value of event as a List
- evt(lat, lon)
Sets the event parameter, of type List of Double
event latitude and longitude. Creates a distance if station is also given.
Known as
--evtin command line. Also known as--eventin command line.- Parameters:
val – value to set event to
- andEvt(lat, lon)
Sets the event parameter, of type List of Double
event latitude and longitude. Creates a distance if station is also given.
Known as
--evtin command line. Also known as--eventin command line.- Parameters:
val – value to set event to
- get_event()
returns current value of event as a List
- event(lat, lon)
Sets the event parameter, of type List of Double
event latitude and longitude. Creates a distance if station is also given.
Known as
--eventin command line.- Parameters:
val – value to set event to
- andEvent(lat, lon)
Sets the event parameter, of type List of Double
event latitude and longitude. Creates a distance if station is also given.
Known as
--eventin command line.- Parameters:
val – value to set event to
- get_exactdegree()
returns current value of exactdegree as a List
- exactdegree(val)
Sets the exactdegree parameter, of type List of Double If a single Double is passed in, it is automatically wrapped in a list. So params.exactdegree( value ) and params.exactdegree( [ value ] ) are equivalent.
exact distance traveled in degrees, not 360-d
Known as
--exactdegreein command line.- Parameters:
val – value to set exactdegree to
- andExactdegree(val)
Append a value to the exactdegree parameter, of type Double
exact distance traveled in degrees, not 360-d
Known as
--exactdegreein command line.- Parameters:
val – value to set exactdegree to
- get_exactdegreerange()
returns current value of exactdegreerange as a List
- exactdegreerange(val)
Sets the exactdegreerange parameter, of type List of Double step or min,max or min,max,step
regular distance range in exact degrees, not 360-deg, one of step; min max or min max step. Default min is 0, max is 180 and step is 10.
Known as
--exactdegreerangein command line.- Parameters:
val – value to set exactdegreerange to
- andExactdegreerange(val)
Append a value to the exactdegreerange parameter, of type Double
regular distance range in exact degrees, not 360-deg, one of step; min max or min max step. Default min is 0, max is 180 and step is 10.
Known as
--exactdegreerangein command line.- Parameters:
val – value to set exactdegreerange to
- get_exactkilometer()
returns current value of exactkilometer as a List
- exactkilometer(val)
Sets the exactkilometer parameter, of type List of Double If a single Double is passed in, it is automatically wrapped in a list. So params.exactkilometer( value ) and params.exactkilometer( [ value ] ) are equivalent.
exact distance traveled in kilometers, not 360-k
Known as
--exactkilometerin command line.- Parameters:
val – value to set exactkilometer to
- andExactkilometer(val)
Append a value to the exactkilometer parameter, of type Double
exact distance traveled in kilometers, not 360-k
Known as
--exactkilometerin command line.- Parameters:
val – value to set exactkilometer to
- get_exactkilometerrange()
returns current value of exactkilometerrange as a List
- exactkilometerrange(val)
Sets the exactkilometerrange parameter, of type List of Double step or min,max or min,max,step
regular distance range in kilometers, not 360-k, one of step; min max or min max step. Default min is 0, max is 1000 and step is 100.
Known as
--exactkilometerrangein command line.- Parameters:
val – value to set exactkilometerrange to
- andExactkilometerrange(val)
Append a value to the exactkilometerrange parameter, of type Double
regular distance range in kilometers, not 360-k, one of step; min max or min max step. Default min is 0, max is 1000 and step is 100.
Known as
--exactkilometerrangein command line.- Parameters:
val – value to set exactkilometerrange to
- get_geodetic()
returns current value of geodetic as a Boolean
- geodetic(val)
Sets the geodetic parameter, of type Boolean
use geodetic latitude for distance calculations, which implies an ellipticity. Default is spherical. Note this only affects calculation of distance from lat/lon pairs, all travel time calculations are done in a purely spherical model.
Known as
--geodeticin command line.- Parameters:
val – value to set geodetic to
- get_geodeticflattening()
returns current value of geodeticflattening as a Double
- geodeticflattening(val)
Sets the geodeticflattening parameter, of type Double
Inverse Elliptical flattening for distance calculations when –geodetic, defaults to WGS84 ~ 298.257. The distance calculation uses 1/x.
Known as
--geodeticflatteningin command line.- Parameters:
val – value to set geodeticflattening to
- get_incident()
returns current value of incident as a List
- incident(val)
Sets the incident parameter, of type List of Double If a single Double is passed in, it is automatically wrapped in a list. So params.incident( value ) and params.incident( [ value ] ) are equivalent.
incident angle in degrees at the receiver, zero is down, 90 horizontal, 180 is up.
Known as
--incidentin command line.- Parameters:
val – value to set incident to
- andIncident(val)
Append a value to the incident parameter, of type Double
incident angle in degrees at the receiver, zero is down, 90 horizontal, 180 is up.
Known as
--incidentin command line.- Parameters:
val – value to set incident to
- get_incidentrange()
returns current value of incidentrange as a List
- incidentrange(val)
Sets the incidentrange parameter, of type List of Double step or min,max or min,max,step
regular range in incident angle in degrees, one of step; min max or min max step. Default min is 0 and step is 10.
Known as
--incidentrangein command line.- Parameters:
val – value to set incidentrange to
- andIncidentrange(val)
Append a value to the incidentrange parameter, of type Double
regular range in incident angle in degrees, one of step; min max or min max step. Default min is 0 and step is 10.
Known as
--incidentrangein command line.- Parameters:
val – value to set incidentrange to
- get_km()
returns current value of kilometer as a List
- km(val)
Sets the kilometer parameter, of type List of Double If a single Double is passed in, it is automatically wrapped in a list. So params.km( value ) and params.km( [ value ] ) are equivalent.
distance in kilometers along surface.
Known as
--kmin command line. Also known as--kilometerin command line.- Parameters:
val – value to set kilometer to
- andKm(val)
Append a value to the kilometer parameter, of type Double
distance in kilometers along surface.
Known as
--kmin command line. Also known as--kilometerin command line.- Parameters:
val – value to set kilometer to
- get_kilometer()
returns current value of kilometer as a List
- kilometer(val)
Sets the kilometer parameter, of type List of Double If a single Double is passed in, it is automatically wrapped in a list. So params.kilometer( value ) and params.kilometer( [ value ] ) are equivalent.
distance in kilometers along surface.
Known as
--kilometerin command line.- Parameters:
val – value to set kilometer to
- andKilometer(val)
Append a value to the kilometer parameter, of type Double
distance in kilometers along surface.
Known as
--kilometerin command line.- Parameters:
val – value to set kilometer to
- get_kilometerrange()
returns current value of kilometerrange as a List
- kilometerrange(val)
Sets the kilometerrange parameter, of type List of Double step or min,max or min,max,step
regular distance range in kilometers, one of step; min max or min max step. Default min is 0, max is 1000 and step is 100.
Known as
--kilometerrangein command line.- Parameters:
val – value to set kilometerrange to
- andKilometerrange(val)
Append a value to the kilometerrange parameter, of type Double
regular distance range in kilometers, one of step; min max or min max step. Default min is 0, max is 1000 and step is 100.
Known as
--kilometerrangein command line.- Parameters:
val – value to set kilometerrange to
- get_label()
returns current value of label as a Boolean
- label(val)
Sets the label parameter, of type Boolean
label with phase name
Known as
--labelin command line.- Parameters:
val – value to set label to
- get_legend()
returns current value of legend as a Boolean
- legend(val)
Sets the legend parameter, of type Boolean
create a legend
Known as
--legendin command line.- Parameters:
val – value to set legend to
- get_mapwidth()
returns current value of mapwidth as a Float
- mapwidth(val)
Sets the mapwidth parameter, of type Float
plot width in units from –mapwidthunit.
Known as
--mapwidthin command line.- Parameters:
val – value to set mapwidth to
- get_mapwidthunit()
returns current value of mapwidthunit as a String
- mapwidthunit(val)
Sets the mapwidthunit parameter, of type String
plot width unit, i for inch, c for cm or p for px.
Known as
--mapwidthunitin command line.- Parameters:
val – value to set mapwidthunit to
- get_maxpathinc()
returns current value of maxpathinc as a Double
- maxpathinc(val)
Sets the maxpathinc parameter, of type Double
Maximum distance increment in degrees between path points, avoid visible segmentation in plots
Known as
--maxpathincin command line.- Parameters:
val – value to set maxpathinc to
- get_mod()
returns current value of model as a String
- mod(val)
Sets the model parameter, of type String
use velocity model “modelName” for calculations. Default is iasp91. Other builtin models include prem, ak135, ak135fcont, and ak135favg.
Known as
--modin command line. Also known as--modelin command line.- Parameters:
val – value to set model to
- get_model()
returns current value of model as a String
- model(val)
Sets the model parameter, of type String
use velocity model “modelName” for calculations. Default is iasp91. Other builtin models include prem, ak135, ak135fcont, and ak135favg.
Known as
--modelin command line.- Parameters:
val – value to set model to
- get_onlynameddiscon()
returns current value of onlynameddiscon as a Boolean
- onlynameddiscon(val)
Sets the onlynameddiscon parameter, of type Boolean
only draw circles on the plot for named discontinuities like moho, cmb, iocb
Known as
--onlynameddisconin command line.- Parameters:
val – value to set onlynameddiscon to
- get_p()
returns current value of phase as a List
- p(val)
Sets the phase parameter, of type List of String If a single String is passed in, it is automatically wrapped in a list. So params.p( value ) and params.p( [ value ] ) are equivalent.
seismic phase names
Known as
-pin command line. Also known as--phasein command line.- Parameters:
val – value to set phase to
- andP(val)
Append a value to the phase parameter, of type String
seismic phase names
Known as
-pin command line. Also known as--phasein command line.- Parameters:
val – value to set phase to
- get_phase()
returns current value of phase as a List
- phase(val)
Sets the phase parameter, of type List of String If a single String is passed in, it is automatically wrapped in a list. So params.phase( value ) and params.phase( [ value ] ) are equivalent.
seismic phase names
Known as
--phasein command line.- Parameters:
val – value to set phase to
- andPhase(val)
Append a value to the phase parameter, of type String
seismic phase names
Known as
--phasein command line.- Parameters:
val – value to set phase to
- get_ph()
returns current value of phase as a List
- ph(val)
Sets the phase parameter, of type List of String If a single String is passed in, it is automatically wrapped in a list. So params.ph( value ) and params.ph( [ value ] ) are equivalent.
seismic phase names
Known as
--phin command line. Also known as--phasein command line.- Parameters:
val – value to set phase to
- andPh(val)
Append a value to the phase parameter, of type String
seismic phase names
Known as
--phin command line. Also known as--phasein command line.- Parameters:
val – value to set phase to
- get_rayparamdeg()
returns current value of rayparamdeg as a List
- rayparamdeg(val)
Sets the rayparamdeg parameter, of type List of Double If a single Double is passed in, it is automatically wrapped in a list. So params.rayparamdeg( value ) and params.rayparamdeg( [ value ] ) are equivalent.
ray parameter from the source in s/deg, up or down is determined by the phase
Known as
--rayparamdegin command line.- Parameters:
val – value to set rayparamdeg to
- andRayparamdeg(val)
Append a value to the rayparamdeg parameter, of type Double
ray parameter from the source in s/deg, up or down is determined by the phase
Known as
--rayparamdegin command line.- Parameters:
val – value to set rayparamdeg to
- get_rayparamidx()
returns current value of rayparamidx as a List
- rayparamidx(val)
Sets the rayparamidx parameter, of type List of Integer If a single Integer is passed in, it is automatically wrapped in a list. So params.rayparamidx( value ) and params.rayparamidx( [ value ] ) are equivalent.
ray parameter from the source as index into model sampling, up or down is determined by the phase
Known as
--rayparamidxin command line.- Parameters:
val – value to set rayparamidx to
- andRayparamidx(val)
Append a value to the rayparamidx parameter, of type Integer
ray parameter from the source as index into model sampling, up or down is determined by the phase
Known as
--rayparamidxin command line.- Parameters:
val – value to set rayparamidx to
- get_rayparamkm()
returns current value of rayparamkm as a List
- rayparamkm(val)
Sets the rayparamkm parameter, of type List of Double If a single Double is passed in, it is automatically wrapped in a list. So params.rayparamkm( value ) and params.rayparamkm( [ value ] ) are equivalent.
ray parameter from the source in s/km, up or down is determined by the phase
Known as
--rayparamkmin command line.- Parameters:
val – value to set rayparamkm to
- andRayparamkm(val)
Append a value to the rayparamkm parameter, of type Double
ray parameter from the source in s/km, up or down is determined by the phase
Known as
--rayparamkmin command line.- Parameters:
val – value to set rayparamkm to
- get_rayparamrad()
returns current value of rayparamrad as a List
- rayparamrad(val)
Sets the rayparamrad parameter, of type List of Double If a single Double is passed in, it is automatically wrapped in a list. So params.rayparamrad( value ) and params.rayparamrad( [ value ] ) are equivalent.
ray parameter from the source in s/rad, up or down is determined by the phase
Known as
--rayparamradin command line.- Parameters:
val – value to set rayparamrad to
- andRayparamrad(val)
Append a value to the rayparamrad parameter, of type Double
ray parameter from the source in s/rad, up or down is determined by the phase
Known as
--rayparamradin command line.- Parameters:
val – value to set rayparamrad to
- get_stadepth()
returns current value of receiverdepth as a List
- stadepth(val)
Sets the receiverdepth parameter, of type List of Double If a single Double is passed in, it is automatically wrapped in a list. So params.stadepth( value ) and params.stadepth( [ value ] ) are equivalent.
the receiver depth in km for stations not at the surface
Known as
--stadepthin command line. Also known as--receiverdepthin command line.- Parameters:
val – value to set receiverdepth to
- andStadepth(val)
Append a value to the receiverdepth parameter, of type Double
the receiver depth in km for stations not at the surface
Known as
--stadepthin command line. Also known as--receiverdepthin command line.- Parameters:
val – value to set receiverdepth to
- get_receiverdepth()
returns current value of receiverdepth as a List
- receiverdepth(val)
Sets the receiverdepth parameter, of type List of Double If a single Double is passed in, it is automatically wrapped in a list. So params.receiverdepth( value ) and params.receiverdepth( [ value ] ) are equivalent.
the receiver depth in km for stations not at the surface
Known as
--receiverdepthin command line.- Parameters:
val – value to set receiverdepth to
- andReceiverdepth(val)
Append a value to the receiverdepth parameter, of type Double
the receiver depth in km for stations not at the surface
Known as
--receiverdepthin command line.- Parameters:
val – value to set receiverdepth to
- get_scat()
returns current value of scatter as a List
- scat(depth, degree)
Sets the scatter parameter, of type List of Double
scattering depth and distance in degrees, which may be negative. Only effects phases with ‘o’ or ‘O’ in the phase name.
Known as
--scatin command line. Also known as--scatterin command line.- Parameters:
val – value to set scatter to
- get_scatter()
returns current value of scatter as a List
- scatter(depth, degree)
Sets the scatter parameter, of type List of Double
scattering depth and distance in degrees, which may be negative. Only effects phases with ‘o’ or ‘O’ in the phase name.
Known as
--scatterin command line.- Parameters:
val – value to set scatter to
- get_h()
returns current value of sourcedepth as a List
- h(val)
Sets the sourcedepth parameter, of type List of Double If a single Double is passed in, it is automatically wrapped in a list. So params.h( value ) and params.h( [ value ] ) are equivalent.
source depth in km
Known as
-hin command line. Also known as--sourcedepthin command line.- Parameters:
val – value to set sourcedepth to
- andH(val)
Append a value to the sourcedepth parameter, of type Double
source depth in km
Known as
-hin command line. Also known as--sourcedepthin command line.- Parameters:
val – value to set sourcedepth to
- get_sourcedepth()
returns current value of sourcedepth as a List
- sourcedepth(val)
Sets the sourcedepth parameter, of type List of Double If a single Double is passed in, it is automatically wrapped in a list. So params.sourcedepth( value ) and params.sourcedepth( [ value ] ) are equivalent.
source depth in km
Known as
--sourcedepthin command line.- Parameters:
val – value to set sourcedepth to
- andSourcedepth(val)
Append a value to the sourcedepth parameter, of type Double
source depth in km
Known as
--sourcedepthin command line.- Parameters:
val – value to set sourcedepth to
- get_evdepth()
returns current value of sourcedepth as a List
- evdepth(val)
Sets the sourcedepth parameter, of type List of Double If a single Double is passed in, it is automatically wrapped in a list. So params.evdepth( value ) and params.evdepth( [ value ] ) are equivalent.
source depth in km
Known as
--evdepthin command line. Also known as--sourcedepthin command line.- Parameters:
val – value to set sourcedepth to
- andEvdepth(val)
Append a value to the sourcedepth parameter, of type Double
source depth in km
Known as
--evdepthin command line. Also known as--sourcedepthin command line.- Parameters:
val – value to set sourcedepth to
- get_sta()
returns current value of station as a List
- sta(lat, lon)
Sets the station parameter, of type List of Double
station latitude and longitude. Creates a distance if event is also given.
Known as
--stain command line. Also known as--stationin command line.- Parameters:
val – value to set station to
- andSta(lat, lon)
Sets the station parameter, of type List of Double
station latitude and longitude. Creates a distance if event is also given.
Known as
--stain command line. Also known as--stationin command line.- Parameters:
val – value to set station to
- get_station()
returns current value of station as a List
- station(lat, lon)
Sets the station parameter, of type List of Double
station latitude and longitude. Creates a distance if event is also given.
Known as
--stationin command line.- Parameters:
val – value to set station to
- andStation(lat, lon)
Sets the station parameter, of type List of Double
station latitude and longitude. Creates a distance if event is also given.
Known as
--stationin command line.- Parameters:
val – value to set station to
- get_takeoff()
returns current value of takeoff as a List
- takeoff(val)
Sets the takeoff parameter, of type List of Double If a single Double is passed in, it is automatically wrapped in a list. So params.takeoff( value ) and params.takeoff( [ value ] ) are equivalent.
takeoff angle in degrees from the source, zero is down, 90 horizontal, 180 is up.
Known as
--takeoffin command line.- Parameters:
val – value to set takeoff to
- andTakeoff(val)
Append a value to the takeoff parameter, of type Double
takeoff angle in degrees from the source, zero is down, 90 horizontal, 180 is up.
Known as
--takeoffin command line.- Parameters:
val – value to set takeoff to
- get_takeoffrange()
returns current value of takeoffrange as a List
- takeoffrange(val)
Sets the takeoffrange parameter, of type List of Double step or min,max or min,max,step
regular range in takeoff angle in degrees, one of step; min,max or min,max,step. Default min is 0 and step is 10.
Known as
--takeoffrangein command line.- Parameters:
val – value to set takeoffrange to
- andTakeoffrange(val)
Append a value to the takeoffrange parameter, of type Double
regular range in takeoff angle in degrees, one of step; min,max or min,max,step. Default min is 0 and step is 10.
Known as
--takeoffrangein command line.- Parameters:
val – value to set takeoffrange to
- get_withtime()
returns current value of withtime as a Boolean
- withtime(val)
Sets the withtime parameter, of type Boolean
include time for each path point, no effect for SVG.
Known as
--withtimein command line.- Parameters:
val – value to set withtime to
- get_xaxis()
returns current value of xaxis as a edu.sc.seis.TauP.DistanceAxisType
- xaxis(val)
- Sets the xaxis parameter, a choice of one of:
degree, radian, kilometer
x axis type, the depth/radius axis, one of degree, radian, kilometer No effect for SVG output.
Known as
--xaxisin command line.- Parameters:
val – value to set xaxis to
- get_yaxis()
returns current value of yaxis as a edu.sc.seis.TauP.DepthAxisType
- yaxis(val)
- Sets the yaxis parameter, a choice of one of:
depth, radius
y axis type, the depth/radius axis, one of depth, radius No effect for SVG output.
Known as
--yaxisin command line.- Parameters:
val – value to set yaxis to
- create_params()
Create dict of params suitible for passing to requests query call.