taup.curve

Module Contents

Classes

CurveQuery

API

class taup.curve.CurveQuery

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_attenuationfreq()

returns current value of attenuationfreq as a Float

attenuationfreq(val)

Sets the attenuationfreq parameter, of type Float

attenuation frequency for amplitude calculations, default is 1.0

Known as --attenuationfreq in command line.

Parameters:

val – value to set attenuationfreq to

get_az()

returns current value of az as a Double

az(val)

Sets the az parameter, of type Double

azimuth in degrees, for amp calculations

Known as --az in command line.

Parameters:

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

Parameters:

val – value to set color 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_mw()

returns current value of mw as a Float

mw(val)

Sets the mw parameter, of type Float

scale amplitude by source moment magnitude, default is 4.0

Known as --mw in command line.

Parameters:

val – value to set mw to

get_numattenuationfreq()

returns current value of numattenuationfreq as a Integer

numattenuationfreq(val)

Sets the numattenuationfreq parameter, of type Integer

number attenuation frequencies for amplitude calculations, default is 64

Known as --numattenuationfreq in command line.

Parameters:

val – value to set numattenuationfreq 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_reddeg()

returns current value of reddeg as a Double

reddeg(val)

Sets the reddeg parameter, of type Double

outputs curves with a reducing velocity (deg/sec), no effect if axis is not distance-like/time

Known as --reddeg in command line.

Parameters:

val – value to set reddeg to

get_redkm()

returns current value of redkm as a Double

redkm(val)

Sets the redkm parameter, of type Double

outputs curves with a reducing velocity (km/sec), no effect if axis is not distance-like/time

Known as --redkm in command line.

Parameters:

val – value to set redkm to

get_rel()

returns current value of rel as a String

rel(val)

Sets the rel parameter, of type String

plot relative to the given phase, no effect unless distance/time

Known as --rel in command line.

Parameters:

val – value to set rel 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_strikediprake()

returns current value of strikediprake as a List

strikediprake(val)

Sets the strikediprake parameter, of type List of Float

fault strike, dip and rake for amplitude calculations. If not given radiation pattern is unity in all directions.

Known as --strikediprake in command line.

Parameters:

val – value to set strikediprake to

andStrikediprake(val)

Append a value to the strikediprake parameter, of type Float

fault strike, dip and rake for amplitude calculations. If not given radiation pattern is unity in all directions.

Known as --strikediprake in command line.

Parameters:

val – value to set strikediprake to

get_xabs()

returns current value of xabs as a Boolean

xabs(val)

Sets the xabs parameter, of type Boolean

X axis is absolute value

Known as --xabs in command line.

Parameters:

val – value to set xabs to

get_x()

returns current value of xaxis as a edu.sc.seis.TauP.AxisType

x(val)

Sets the xaxis parameter, a choice of one of:

radian, radian180, degree, degree180, kilometer, kilometer180, rayparamrad, rayparamdeg, rayparamkm, time, tau, takeoffangle, incidentangle, turndepth, amp, amppsv, ampsh, geospread, refltran, refltranpsv, refltransh, index, tstar, attenuation, theta, energygeospread, pathlength, radiation, radiationpsv, radiationsh

X axis data type, default is degree180, one of radian, radian180, degree, degree180, kilometer, kilometer180, rayparamrad, rayparamdeg, rayparamkm, time, tau, takeoffangle, incidentangle, turndepth, amp, amppsv, ampsh, geospread, refltran, refltranpsv, refltransh, index, tstar, attenuation, theta, energygeospread, pathlength, radiation, radiationpsv, radiationsh

Known as -x in command line. Also known as --xaxis in command line.

Parameters:

val – value to set xaxis to

get_xaxis()

returns current value of xaxis as a edu.sc.seis.TauP.AxisType

xaxis(val)

Sets the xaxis parameter, a choice of one of:

radian, radian180, degree, degree180, kilometer, kilometer180, rayparamrad, rayparamdeg, rayparamkm, time, tau, takeoffangle, incidentangle, turndepth, amp, amppsv, ampsh, geospread, refltran, refltranpsv, refltransh, index, tstar, attenuation, theta, energygeospread, pathlength, radiation, radiationpsv, radiationsh

X axis data type, default is degree180, one of radian, radian180, degree, degree180, kilometer, kilometer180, rayparamrad, rayparamdeg, rayparamkm, time, tau, takeoffangle, incidentangle, turndepth, amp, amppsv, ampsh, geospread, refltran, refltranpsv, refltransh, index, tstar, attenuation, theta, energygeospread, pathlength, radiation, radiationpsv, radiationsh

Known as --xaxis in command line.

Parameters:

val – value to set xaxis to

get_xlog()

returns current value of xlog as a Boolean

xlog(val)

Sets the xlog parameter, of type Boolean

X axis is log

Known as --xlog in command line.

Parameters:

val – value to set xlog to

get_xminmax()

returns current value of xminmax as a [D

xminmax(val)

Sets the xminmax parameter, of type [D

min and max x axis for plotting

Known as --xminmax in command line.

Parameters:

val – value to set xminmax to

get_yabs()

returns current value of yabs as a Boolean

yabs(val)

Sets the yabs parameter, of type Boolean

Y axis is absolute value

Known as --yabs in command line.

Parameters:

val – value to set yabs to

get_y()

returns current value of yaxis as a edu.sc.seis.TauP.AxisType

y(val)

Sets the yaxis parameter, a choice of one of:

radian, radian180, degree, degree180, kilometer, kilometer180, rayparamrad, rayparamdeg, rayparamkm, time, tau, takeoffangle, incidentangle, turndepth, amp, amppsv, ampsh, geospread, refltran, refltranpsv, refltransh, index, tstar, attenuation, theta, energygeospread, pathlength, radiation, radiationpsv, radiationsh

Y axis data type, default is time, one of radian, radian180, degree, degree180, kilometer, kilometer180, rayparamrad, rayparamdeg, rayparamkm, time, tau, takeoffangle, incidentangle, turndepth, amp, amppsv, ampsh, geospread, refltran, refltranpsv, refltransh, index, tstar, attenuation, theta, energygeospread, pathlength, radiation, radiationpsv, radiationsh

Known as -y in command line. Also known as --yaxis in command line.

Parameters:

val – value to set yaxis to

get_yaxis()

returns current value of yaxis as a edu.sc.seis.TauP.AxisType

yaxis(val)

Sets the yaxis parameter, a choice of one of:

radian, radian180, degree, degree180, kilometer, kilometer180, rayparamrad, rayparamdeg, rayparamkm, time, tau, takeoffangle, incidentangle, turndepth, amp, amppsv, ampsh, geospread, refltran, refltranpsv, refltransh, index, tstar, attenuation, theta, energygeospread, pathlength, radiation, radiationpsv, radiationsh

Y axis data type, default is time, one of radian, radian180, degree, degree180, kilometer, kilometer180, rayparamrad, rayparamdeg, rayparamkm, time, tau, takeoffangle, incidentangle, turndepth, amp, amppsv, ampsh, geospread, refltran, refltranpsv, refltransh, index, tstar, attenuation, theta, energygeospread, pathlength, radiation, radiationpsv, radiationsh

Known as --yaxis in command line.

Parameters:

val – value to set yaxis to

get_ylog()

returns current value of ylog as a Boolean

ylog(val)

Sets the ylog parameter, of type Boolean

Y axis is log

Known as --ylog in command line.

Parameters:

val – value to set ylog to

get_yminmax()

returns current value of yminmax as a [D

yminmax(val)

Sets the yminmax parameter, of type [D

min and max y axis for plotting

Known as --yminmax in command line.

Parameters:

val – value to set yminmax to

create_params()

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