taup.refltrans

Module Contents

Classes

RefltransQuery

API

class taup.refltrans.RefltransQuery

Initialization

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

returns current value of abs as a Boolean

abs(val)

Sets the abs parameter, of type Boolean

absolute value of amplitude factor

Known as --abs in command line.

Parameters:

val – value to set abs to

get_angles()

returns current value of angles as a Boolean

angles(val)

Sets the angles parameter, of type Boolean

all angle coefficients, like TpAngle

Known as --angles in command line.

Parameters:

val – value to set angles to

get_anglestep()

returns current value of anglestep as a Double

anglestep(val)

Sets the anglestep parameter, of type Double

step in degrees when x is degrees

Known as --anglestep in command line.

Parameters:

val – value to set anglestep to

get_depth()

returns current value of depth as a String

depth(val)

Sets the depth parameter, of type String

Depth in model to get boundary parameters, may be number or name like moho.

Known as --depth in command line.

Parameters:

val – value to set depth to

get_down()

returns current value of down as a Boolean

down(val)

Sets the down parameter, of type Boolean

incident is downgoing

Known as --down in command line.

Parameters:

val – value to set down to

get_energyflux()

returns current value of energyflux as a Boolean

energyflux(val)

Sets the energyflux parameter, of type Boolean

all energy flux coefficients, like TppEnergy

Known as --energyflux in command line.

Parameters:

val – value to set energyflux to

get_fsrf()

returns current value of fsrf as a Boolean

fsrf(val)

Sets the fsrf parameter, of type Boolean

all free surface receiver functions, like FreeRecFuncPz

Known as --fsrf in command line.

Parameters:

val – value to set fsrf to

get_layer()

returns current value of layer as a [D

layer(val)

Sets the layer parameter, of type [D

inbound and transmitted layer parameters, vp, vs, rho, vp, vs, rho

Known as --layer in command line.

Parameters:

val – value to set layer 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_pwave()

returns current value of pwave as a Boolean

pwave(val)

Sets the pwave parameter, of type Boolean

incident P wave

Known as --pwave in command line.

Parameters:

val – value to set pwave 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_rpstep()

returns current value of rpstep as a Double

rpstep(val)

Sets the rpstep parameter, of type Double

step in ray param when x is ray param

Known as --rpstep in command line.

Parameters:

val – value to set rpstep 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_shwave()

returns current value of shwave as a Boolean

shwave(val)

Sets the shwave parameter, of type Boolean

incident SH wave

Known as --shwave in command line.

Parameters:

val – value to set shwave 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_swave()

returns current value of swave as a Boolean

swave(val)

Sets the swave parameter, of type Boolean

incident S wave

Known as --swave in command line.

Parameters:

val – value to set swave to

get_up()

returns current value of up as a Boolean

up(val)

Sets the up parameter, of type Boolean

incident is upgoing, reverses the sense of the boundary

Known as --up in command line.

Parameters:

val – value to set up 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_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

get_x()

returns current value of x as a edu.sc.seis.TauP.cmdline.TauP_ReflTransPlot$DegRayParam

x(val)

Sets the x parameter, a choice of one of:

degree, rayparam

X axis data type, one of degree, rayparam, default is degree

Known as -x in command line.

Parameters:

val – value to set x to

get_y()

returns current value of y as a List

y(val)

Sets the y parameter, a choice of one of:

Rpp, Rps, Rsp, Rss, Tpp, Tps, Tsp, Tss, Rshsh, Tshsh, RppEnergy, TppEnergy, RpsEnergy, TpsEnergy, RspEnergy, TspEnergy, RssEnergy, TssEnergy, RshshEnergy, TshshEnergy, RpAngle, RsAngle, TpAngle, TsAngle, FreeRecFuncPr, FreeRecFuncSvr, FreeRecFuncPz, FreeRecFuncSvz, FreeRecFuncSh of edu.sc.seis.TauP.ReflTransAxisType

Y axis data type, one or more of Rpp, Rps, Rsp, Rss, Tpp, Tps, Tsp, Tss, Rshsh, Tshsh, RppEnergy, TppEnergy, RpsEnergy, TpsEnergy, RspEnergy, TspEnergy, RssEnergy, TssEnergy, RshshEnergy, TshshEnergy, RpAngle, RsAngle, TpAngle, TsAngle, FreeRecFuncPr, FreeRecFuncSvr, FreeRecFuncPz, FreeRecFuncSvz, FreeRecFuncSh, default is all displacement coef.

Known as -y in command line.

Parameters:

val – value to set y to

andY(val)

Append a value to the y parameter, a choice of one of:

Rpp, Rps, Rsp, Rss, Tpp, Tps, Tsp, Tss, Rshsh, Tshsh, RppEnergy, TppEnergy, RpsEnergy, TpsEnergy, RspEnergy, TspEnergy, RssEnergy, TssEnergy, RshshEnergy, TshshEnergy, RpAngle, RsAngle, TpAngle, TsAngle, FreeRecFuncPr, FreeRecFuncSvr, FreeRecFuncPz, FreeRecFuncSvz, FreeRecFuncSh

Y axis data type, one or more of Rpp, Rps, Rsp, Rss, Tpp, Tps, Tsp, Tss, Rshsh, Tshsh, RppEnergy, TppEnergy, RpsEnergy, TpsEnergy, RspEnergy, TspEnergy, RssEnergy, TssEnergy, RshshEnergy, TshshEnergy, RpAngle, RsAngle, TpAngle, TsAngle, FreeRecFuncPr, FreeRecFuncSvr, FreeRecFuncPz, FreeRecFuncSvz, FreeRecFuncSh, default is all displacement coef.

Known as -y in command line.

Parameters:

val – value to set y to

create_params()

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