taup.wavefront

Module Contents

Classes

WavefrontQuery

API

class taup.wavefront.WavefrontQuery

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_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 --color in 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 --degminmax in command line.

Parameters:

val – value to set degminmax 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 --depthminmax in command line.

Parameters:

val – value to set depthminmax 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 --legend in 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 --mapwidth in 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 --mapwidthunit in command line.

Parameters:

val – value to set mapwidthunit 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 --mod in command line. Also known as --model in 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 --model in command line.

Parameters:

val – value to set model to

get_negdist()

returns current value of negdist as a Boolean

negdist(val)

Sets the negdist parameter, of type Boolean

outputs negative distance as well so wavefronts are in both halves.

Known as --negdist in command line.

Parameters:

val – value to set negdist 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 but not 410

Known as --onlynameddiscon in 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 -p in command line. Also known as --phase in 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 -p in command line. Also known as --phase in 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 --phase in 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 --phase in 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 --ph in command line. Also known as --phase in 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 --ph in command line. Also known as --phase in command line.

Parameters:

val – value to set phase 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 --stadepth in command line. Also known as --receiverdepth in 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 --stadepth in command line. Also known as --receiverdepth in 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 --receiverdepth in 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 --receiverdepth in 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 --scat in command line. Also known as --scatter in 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 --scatter in 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 -h in command line. Also known as --sourcedepth in 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 -h in command line. Also known as --sourcedepth in 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 --sourcedepth in 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 --sourcedepth in 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 --evdepth in command line. Also known as --sourcedepth in 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 --evdepth in command line. Also known as --sourcedepth in command line.

Parameters:

val – value to set sourcedepth to

get_timefiles()

returns current value of timefiles as a Boolean

timefiles(val)

Sets the timefiles parameter, of type Boolean

outputs each time into a separate file within the gmt script.

Known as --timefiles in command line.

Parameters:

val – value to set timefiles to

get_timestep()

returns current value of timestep as a Float

timestep(val)

Sets the timestep parameter, of type Float

steps in time (seconds) for output, default is 100

Known as --timestep in command line.

Parameters:

val – value to set timestep 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 --xaxis in 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 --yaxis in command line.

Parameters:

val – value to set yaxis to

create_params()

Create dict of params suitible for passing to requests query call.