Package edu.sc.seis.TauP.cmdline

Class TauP_Curve

java.lang.Object

edu.sc.seis.TauP.cmdline.TauP_Tool

edu.sc.seis.TauP.cmdline.TauP_AbstractPhaseTool

edu.sc.seis.TauP.cmdline.TauP_Curve

All Implemented Interfaces:

Callable<Integer>

public class TauP_Curve
extends TauP_AbstractPhaseTool

Field Summary

Fields

Modifier and Type	Field	Description
protected Double	azimuth
protected Double	reduceVelDeg	the reducing velocity to use if reduceTime == true, in units of radians/second .
protected Double	reduceVelKm
protected String	redVelString
protected String	relativePhaseName
protected boolean	xAxisAbs
protected boolean	xAxisLog
protected double[]	xAxisMinMax
protected AxisType	xAxisType
protected boolean	yAxisAbs
protected boolean	yAxisLog
protected double[]	yAxisMinMax
protected AxisType	yAxisType

Fields inherited from class edu.sc.seis.TauP.cmdline.TauP_AbstractPhaseTool

phaseNames

Fields inherited from class edu.sc.seis.TauP.cmdline.TauP_Tool

ABREV_SYNOPSIS, abstractOutputTypeArgs, OPTIONS_HEADING, toolProps

Constructor Summary

Constructors

Constructor	Description
TauP_Curve()

Method Summary

Modifier and Type	Method	Description
Arrival	arrivalAtIndex(int i, SeismicPhase phase)
static boolean	axisIsDistanceLike(AxisType axisType)	True if the axis type is distance-like.
static boolean	axisIsTimeLike(AxisType axisType)	True if the axis type is time.
String	axisLabel(AxisType axisType)
List<XYPlottingData>	calculate(AxisType xAxisType, AxisType yAxisType)
List<XYPlottingData>	calculateLinear(AxisType xAxisType, AxisType yAxisType)
List<double[]>	calculatePlotForType(SeismicPhase phase, AxisType axisType, boolean ensure180)
protected List<double[]>	calculatePlotForTypeContig(SeismicPhase phase, AxisType axisType, boolean ensure180)
void	destroy()
String	getOutFileExtension()
String	getOutputFormat()
Double	getReduceVelDeg()
Double	getReduceVelKm()
double	getReduceVelRadian()
String	getRedVelLabel()
String	getRelativePhaseName()
double[]	getxAxisMinMax()
AxisType	getxAxisType()
double[]	getyAxisMinMax()
AxisType	getyAxisType()
void	init()	preforms intialization of the tool.
boolean	isReduceTime()
boolean	isxAxisAbs()
boolean	isxAxisLog()
boolean	isyAxisAbs()
boolean	isyAxisLog()
void	printResult(PrintWriter writer, List<XYPlottingData> xyPlots)
List<XYPlottingData>	reduce(List<XYPlottingData> xy)
Double	reduceVelForAxis(AxisType axisType)
void	setReduceVelDeg(double reduceVel)	set the reducing velocity, in degrees/second.
void	setReduceVelKm(double reduceVel)	set the reducing velocity, in kilometers/second.
void	setRelativePhaseName(String relativePhaseName)
void	setxAxisAbs(boolean xAxisAbs)
void	setxAxisLog(boolean xAxisLog)
void	setxAxisMinMax(double[] xAxisMinMax)
void	setxAxisType(AxisType xAxisType)
void	setxMinMax(double min, double max)
void	setyAxisAbs(boolean yAxisAbs)
void	setyAxisLog(boolean yAxisLog)
void	setyAxisMinMax(double[] yAxisMinMax)
void	setyAxisType(AxisType yAxisType)
void	setyMinMax(double min, double max)
void	start()
void	validateArguments()

Methods inherited from class edu.sc.seis.TauP.cmdline.TauP_AbstractPhaseTool

appendPhaseName, appendPhaseName, calcSeismicPhases, calcSeismicPhases, clearPhaseNames, clearPhases, createTimeResult, getNumPhases, getPhaseArgs, getRadiusOfEarth, getReceiverDepths, getScatterer, getScattererDepth, getSeismicPhases, getSourceDepths, getTauModelDepthCorrected, getTauModelName, parsePhaseNameList, setModelName, setPhaseNameList, setPhaseNames, setScatterer, setSingleReceiverDepth, setSingleSourceDepth, setTauModel

Methods inherited from class edu.sc.seis.TauP.cmdline.TauP_Tool

call, configDefaults, getCmdLineArgs, isDEBUG, isVerbose, setDEBUG, setOutFileBase, setOutFileExtension, setOutputFormat, setToolPropsFilename, setVerbose, toolNameFromClass

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

relativePhaseName

protected String relativePhaseName

xAxisType

protected AxisType xAxisType

yAxisType

protected AxisType yAxisType

azimuth

protected Double azimuth

xAxisAbs

protected boolean xAxisAbs

yAxisAbs

protected boolean yAxisAbs

xAxisLog

protected boolean xAxisLog

yAxisLog

protected boolean yAxisLog

reduceVelDeg

protected Double reduceVelDeg

the reducing velocity to use if reduceTime == true, in units of radians/second .

reduceVelKm

protected Double reduceVelKm

redVelString

protected String redVelString

xAxisMinMax

protected double[] xAxisMinMax

yAxisMinMax

protected double[] yAxisMinMax

Constructor Details

TauP_Curve

public TauP_Curve()

Method Details

init

public void init()
          throws TauPException

preforms intialization of the tool. Properties are queried for the default model to load, source depth to use, phases to use, etc.

Overrides:

init in class TauP_AbstractPhaseTool

Throws:

TauPException

start

public void start()
           throws IOException,
TauPException

Specified by:

start in class TauP_Tool

Throws:

IOException

TauPException

calculate

public List<XYPlottingData> calculate(AxisType xAxisType,
 AxisType yAxisType)
                               throws TauPException

Throws:

TauPException

calculateLinear

public List<XYPlottingData> calculateLinear(AxisType xAxisType,
 AxisType yAxisType)
                                     throws TauPException

Throws:

TauPException

reduce

public List<XYPlottingData> reduce(List<XYPlottingData> xy)
                            throws TauModelException

Throws:

TauModelException

calculatePlotForType

public List<double[]> calculatePlotForType(SeismicPhase phase,
 AxisType axisType,
 boolean ensure180)
                                    throws SlownessModelException,
TauModelException

Throws:

SlownessModelException

TauModelException

calculatePlotForTypeContig

protected List<double[]> calculatePlotForTypeContig(SeismicPhase phase,
 AxisType axisType,
 boolean ensure180)
                                             throws SlownessModelException,
TauModelException

Throws:

SlownessModelException

TauModelException

arrivalAtIndex

public Arrival arrivalAtIndex(int i,
 SeismicPhase phase)
                       throws SlownessModelException,
TauModelException

Throws:

SlownessModelException

TauModelException

printResult

public void printResult(PrintWriter writer,
 List<XYPlottingData> xyPlots)
                 throws TauPException

Throws:

TauPException

destroy

public void destroy()
             throws TauPException

Specified by:

destroy in class TauP_Tool

Throws:

TauPException

axisIsDistanceLike

public static boolean axisIsDistanceLike(AxisType axisType)

True if the axis type is distance-like.

axisIsTimeLike

public static boolean axisIsTimeLike(AxisType axisType)

True if the axis type is time.

validateArguments

public void validateArguments()
                       throws TauModelException

Specified by:

validateArguments in class TauP_Tool

Throws:

TauModelException

getxAxisType

public AxisType getxAxisType()

setxAxisType

public void setxAxisType(AxisType xAxisType)

getyAxisType

public AxisType getyAxisType()

setyAxisType

public void setyAxisType(AxisType yAxisType)

getxAxisMinMax

public double[] getxAxisMinMax()

setxAxisMinMax

public void setxAxisMinMax(double[] xAxisMinMax)

getyAxisMinMax

public double[] getyAxisMinMax()

setyAxisMinMax

public void setyAxisMinMax(double[] yAxisMinMax)

isxAxisAbs

public boolean isxAxisAbs()

setxAxisAbs

public void setxAxisAbs(boolean xAxisAbs)

isyAxisAbs

public boolean isyAxisAbs()

setyAxisAbs

public void setyAxisAbs(boolean yAxisAbs)

isxAxisLog

public boolean isxAxisLog()

setxAxisLog

public void setxAxisLog(boolean xAxisLog)

isyAxisLog

public boolean isyAxisLog()

setyAxisLog

public void setyAxisLog(boolean yAxisLog)

axisLabel

public String axisLabel(AxisType axisType)

isReduceTime

public boolean isReduceTime()

getRelativePhaseName

public String getRelativePhaseName()

setRelativePhaseName

public void setRelativePhaseName(String relativePhaseName)

getReduceVelRadian

public double getReduceVelRadian()

Returns:

reducing velocity in degrees/second. The internal usage is radians/second.

getReduceVelDeg

public Double getReduceVelDeg()

setReduceVelDeg

public void setReduceVelDeg(double reduceVel)

set the reducing velocity, in degrees/second. The internal representation is radians/second.

getReduceVelKm

public Double getReduceVelKm()

Returns:

reducing velocity in kilometers/second. The internal usage is radians/second.

reduceVelForAxis

public Double reduceVelForAxis(AxisType axisType)
                        throws TauModelException

Throws:

TauModelException

setReduceVelKm

public void setReduceVelKm(double reduceVel)

set the reducing velocity, in kilometers/second. The internal representation is radians/second.

getRedVelLabel

public String getRedVelLabel()

getOutputFormat

public String getOutputFormat()

Specified by:

getOutputFormat in class TauP_Tool

getOutFileExtension

public String getOutFileExtension()

Overrides:

getOutFileExtension in class TauP_Tool

setxMinMax

public void setxMinMax(double min,
 double max)

setyMinMax

public void setyMinMax(double min,
 double max)