Package edu.sc.seis.TauP.cmdline
Class TauP_AbstractPhaseTool
- java.lang.Object
-
- edu.sc.seis.TauP.cmdline.TauP_Tool
-
- edu.sc.seis.TauP.cmdline.TauP_AbstractPhaseTool
-
- All Implemented Interfaces:
java.util.concurrent.Callable<java.lang.Integer>
- Direct Known Subclasses:
TauP_AbstractRayTool
,TauP_Curve
,TauP_Find
,TauP_PhaseDescribe
,TauP_SetMSeed3
,TauP_SetSac
,TauP_Spikes
,TauP_Wavefront
public abstract class TauP_AbstractPhaseTool extends TauP_Tool
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.List<PhaseName>
phaseNames
names of phases to be used, ie PKIKP.-
Fields inherited from class edu.sc.seis.TauP.cmdline.TauP_Tool
ABREV_SYNOPSIS, abstractOutputTypeArgs, OPTIONS_HEADING, toolProps
-
-
Constructor Summary
Constructors Constructor Description TauP_AbstractPhaseTool(AbstractOutputTypeArgs outputTypeArgs)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
appendPhaseName(PhaseName phaseName)
void
appendPhaseName(java.lang.String phaseName)
java.util.List<SeismicPhase>
calcSeismicPhases(double sourceDepth)
Calculates the seismic phases using a possibly new or changed tau model for the given source depth.java.util.List<SeismicPhase>
calcSeismicPhases(double sourceDepth, java.util.List<java.lang.Double> receiverDepths, Scatterer scatterer)
void
clearPhaseNames()
void
clearPhases()
TimeResult
createTimeResult(boolean isWithAmplitude, SeismicSourceArgs sourceArgs, java.util.List<Arrival> arrivalList)
int
getNumPhases()
PhaseArgs
getPhaseArgs()
double
getRadiusOfEarth()
java.util.List<java.lang.Double>
getReceiverDepths()
Scatterer
getScatterer()
double
getScattererDepth()
java.util.List<SeismicPhase>
getSeismicPhases()
java.util.List<java.lang.Double>
getSourceDepths()
TauModel
getTauModelDepthCorrected(double sourceDepth)
Gets depth corrected TauModel.java.lang.String
getTauModelName()
void
init()
java.util.List<PhaseName>
parsePhaseNameList()
void
setModelName(java.lang.String modelName)
void
setPhaseNameList(java.util.List<PhaseName> phaseNames)
void
setPhaseNames(java.util.List<java.lang.String> phaseNames)
void
setScatterer(Scatterer scatterer)
void
setSingleReceiverDepth(double receiverDepth)
void
setSingleSourceDepth(double depth)
void
setTauModel(TauModel tMod)
-
Methods inherited from class edu.sc.seis.TauP.cmdline.TauP_Tool
call, configDefaults, destroy, getCmdLineArgs, getOutFileExtension, getOutputFormat, isDEBUG, isVerbose, setDEBUG, setOutFileBase, setOutFileExtension, setOutputFormat, setToolPropsFilename, setVerbose, start, toolNameFromClass, validateArguments
-
-
-
-
Field Detail
-
phaseNames
protected java.util.List<PhaseName> phaseNames
names of phases to be used, ie PKIKP.
-
-
Constructor Detail
-
TauP_AbstractPhaseTool
public TauP_AbstractPhaseTool(AbstractOutputTypeArgs outputTypeArgs)
-
-
Method Detail
-
createTimeResult
public TimeResult createTimeResult(boolean isWithAmplitude, SeismicSourceArgs sourceArgs, java.util.List<Arrival> arrivalList) throws PhaseParseException
- Throws:
PhaseParseException
-
getRadiusOfEarth
public double getRadiusOfEarth()
-
parsePhaseNameList
public java.util.List<PhaseName> parsePhaseNameList() throws PhaseParseException
- Throws:
PhaseParseException
-
setPhaseNameList
public void setPhaseNameList(java.util.List<PhaseName> phaseNames)
-
init
public void init() throws TauPException
- Specified by:
init
in classTauP_Tool
- Throws:
TauPException
-
setPhaseNames
public void setPhaseNames(java.util.List<java.lang.String> phaseNames) throws PhaseParseException
- Throws:
PhaseParseException
-
appendPhaseName
public void appendPhaseName(java.lang.String phaseName) throws PhaseParseException
- Throws:
PhaseParseException
-
appendPhaseName
public void appendPhaseName(PhaseName phaseName)
-
getNumPhases
public int getNumPhases()
-
clearPhaseNames
public void clearPhaseNames()
-
setSingleSourceDepth
public void setSingleSourceDepth(double depth)
-
setSingleReceiverDepth
public void setSingleReceiverDepth(double receiverDepth)
-
getScattererDepth
public double getScattererDepth()
-
getScatterer
public Scatterer getScatterer()
-
setScatterer
public void setScatterer(Scatterer scatterer)
-
getTauModelName
public java.lang.String getTauModelName()
-
getTauModelDepthCorrected
public TauModel getTauModelDepthCorrected(double sourceDepth) throws TauModelException
Gets depth corrected TauModel.- Parameters:
sourceDepth
- earthqauke source depth- Returns:
- corrected tau model
- Throws:
TauModelException
- if depth correct fails
-
setModelName
public void setModelName(java.lang.String modelName)
-
setTauModel
public void setTauModel(TauModel tMod)
-
clearPhases
public void clearPhases()
-
calcSeismicPhases
public java.util.List<SeismicPhase> calcSeismicPhases(double sourceDepth) throws TauPException
Calculates the seismic phases using a possibly new or changed tau model for the given source depth.- Parameters:
sourceDepth
- earthquake source depth- Returns:
- calculated seismic phases
- Throws:
TauModelException
- if calculation failsTauPException
-
calcSeismicPhases
public java.util.List<SeismicPhase> calcSeismicPhases(double sourceDepth, java.util.List<java.lang.Double> receiverDepths, Scatterer scatterer) throws TauModelException
- Throws:
TauModelException
-
getSourceDepths
public java.util.List<java.lang.Double> getSourceDepths() throws TauPException
- Throws:
TauPException
-
getReceiverDepths
public java.util.List<java.lang.Double> getReceiverDepths() throws TauPException
- Throws:
TauPException
-
getSeismicPhases
public java.util.List<SeismicPhase> getSeismicPhases() throws TauPException
- Throws:
TauPException
-
getPhaseArgs
public PhaseArgs getPhaseArgs()
-
-