Package edu.sc.seis.TauP

Class SeismicPhaseSegment

java.lang.Object

edu.sc.seis.TauP.SeismicPhaseSegment

public class SeismicPhaseSegment
extends Object

Partial segment of a full seismic phase, usually between major boundaries or turn points.

Constructor Summary

Constructors

Constructor	Description
SeismicPhaseSegment(TauModel tMod, int startBranch, int endBranch, boolean isPWave, PhaseInteraction endAction, LayerPropogationType layerPropogationType, String legName, double minRayParam, double maxRayParam)
SeismicPhaseSegment(TauModel tMod, int startBranch, int endBranch, boolean isPWave, PhaseInteraction endAction, LayerPropogationType layerPropogationType, String legName, double minRayParam, double maxRayParam, PhaseInteraction prevEndAction)

Method Summary

Modifier and Type	Method	Description
double	calcEnergyFluxFactorReflTran(Arrival arrival, boolean nextLegIsPWave, boolean allSH)	Calculates the product of the energy flux reflection and transmission coefficients for this leg.
ArrivalPathSegment	calcPathTimeDist(Arrival currArrival, TimeDist prevEnd, int segmentIndex, int totalNumSegments, SeismicPhaseSegment prevSeg)
SeismicPhaseReflTransHolder	calcReflTran(Arrival arrival, boolean nextLegIsPWave, boolean allSH)	Calculates the product of the reflection and transmission coefficients for this leg.
List<TimeDist>	calcTimeDist(Arrival currArrival, TimeDist prevEnd, boolean doPath, SeismicPhaseSegment prevSeg)
SeismicPhaseSegment	clone()
edu.sc.seis.TauP.BranchDescription	describe()
String	describeBranchRange()
static String	describeBranchRange(TauModel tMod, int startBranch, int endBranch)
static String	endActionToString(PhaseInteraction endAction)
boolean	endsAtTop()
static SeismicPhaseSegment	failSegment(TauModel tMod)
static SeismicPhaseSegment	failSegment(TauModel tMod, int startBranch, int endBranch, boolean isPWave, LayerPropogationType layerPropogationType, String legName)
double	getBotDepth()
double[]	getDepthRange()
String	getDepthRangeJSON()
String	getDepthRangeString()
PhaseInteraction	getEndAction()
int	getEndBranch()
double	getEndDepth()
boolean	getIsFlat()
boolean	getIsPWave()
String	getLegName()
double	getMaxRayParam()
double	getMaxRayParamDeg()
double	getMinRayParam()
double	getMinRayParamDeg()
PhaseInteraction	getPrevEndAction()
int	getStartBranch()
TauModel	getTauModel()
TauModel	getTMod()
double	getTopDepth()
static PhaseInteraction	prevEndActionForStart(LayerPropogationType layerPropogationType)
static String	segmentDescribe(List<SeismicPhaseSegment> segmentList)
static String	segmentDescribe(List<SeismicPhaseSegment> segmentList, boolean includeRP)
static String	segmentListDescribe(List<List<SeismicPhaseSegment>> segmentListList)
static SeismicPhaseSegment	startingSegment(TauModel tMod, int startBranch, int endBranch, boolean isPWave, PhaseInteraction endAction, LayerPropogationType layerPropogationType, String legName, double minRayParam, double maxRayParam)
String	toJSONString()
String	toString()
int	turnBranch(double rp)	Calculate the TauBranch a ray turns within.

Methods inherited from class java.lang.Object

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

Constructor Details

SeismicPhaseSegment

public SeismicPhaseSegment(TauModel tMod,
 int startBranch,
 int endBranch,
 boolean isPWave,
 PhaseInteraction endAction,
 LayerPropogationType layerPropogationType,
 String legName,
 double minRayParam,
 double maxRayParam,
 PhaseInteraction prevEndAction)

SeismicPhaseSegment

public SeismicPhaseSegment(TauModel tMod,
 int startBranch,
 int endBranch,
 boolean isPWave,
 PhaseInteraction endAction,
 LayerPropogationType layerPropogationType,
 String legName,
 double minRayParam,
 double maxRayParam)

Method Details

startingSegment

public static SeismicPhaseSegment startingSegment(TauModel tMod,
 int startBranch,
 int endBranch,
 boolean isPWave,
 PhaseInteraction endAction,
 LayerPropogationType layerPropogationType,
 String legName,
 double minRayParam,
 double maxRayParam)

prevEndActionForStart

public static PhaseInteraction prevEndActionForStart(LayerPropogationType layerPropogationType)

failSegment

public static SeismicPhaseSegment failSegment(TauModel tMod)

failSegment

public static SeismicPhaseSegment failSegment(TauModel tMod,
 int startBranch,
 int endBranch,
 boolean isPWave,
 LayerPropogationType layerPropogationType,
 String legName)

turnBranch

public int turnBranch(double rp)

Calculate the TauBranch a ray turns within. If the segement is not downgoing, or the end action is not TURN then result is -1.

Parameters:

rp - ray param

Returns:

number of the tau branch where the ray turns, if possible

endsAtTop

public boolean endsAtTop()
                  throws TauModelException

Throws:

TauModelException

endActionToString

public static String endActionToString(PhaseInteraction endAction)

describeBranchRange

public String describeBranchRange()

describeBranchRange

public static String describeBranchRange(TauModel tMod,
 int startBranch,
 int endBranch)

toString

public String toString()

Overrides:

toString in class Object

getIsPWave

public boolean getIsPWave()

getIsFlat

public boolean getIsFlat()

getLegName

public String getLegName()

getTauModel

public TauModel getTauModel()

getMinRayParam

public double getMinRayParam()

getMaxRayParam

public double getMaxRayParam()

getMinRayParamDeg

public double getMinRayParamDeg()

getMaxRayParamDeg

public double getMaxRayParamDeg()

getDepthRangeString

public String getDepthRangeString()

getDepthRangeJSON

public String getDepthRangeJSON()

getTopDepth

public double getTopDepth()

getBotDepth

public double getBotDepth()

getEndDepth

public double getEndDepth()

getStartBranch

public int getStartBranch()

getEndBranch

public int getEndBranch()

getDepthRange

public double[] getDepthRange()

getTMod

public TauModel getTMod()

getEndAction

public PhaseInteraction getEndAction()

getPrevEndAction

public PhaseInteraction getPrevEndAction()

describe

public edu.sc.seis.TauP.BranchDescription describe()

toJSONString

public String toJSONString()

calcTimeDist

public List<TimeDist> calcTimeDist(Arrival currArrival,
 TimeDist prevEnd,
 boolean doPath,
 SeismicPhaseSegment prevSeg)
                            throws SlownessModelException

Throws:

SlownessModelException

calcPathTimeDist

public ArrivalPathSegment calcPathTimeDist(Arrival currArrival,
 TimeDist prevEnd,
 int segmentIndex,
 int totalNumSegments,
 SeismicPhaseSegment prevSeg)
                                    throws SlownessModelException

Throws:

SlownessModelException

calcEnergyFluxFactorReflTran

public double calcEnergyFluxFactorReflTran(Arrival arrival,
 boolean nextLegIsPWave,
 boolean allSH)
                                    throws TauModelException,
SlownessModelException

Calculates the product of the energy flux reflection and transmission coefficients for this leg.

Parameters:

arrival - arrival/ ray parameter to use for the calculation

nextLegIsPWave - if next leg is a P wave, neede for final coefficient at end of leg

allSH - if should calculate the SH coefficients instead of P-SV

Throws:

TauModelException

SlownessModelException

calcReflTran

public SeismicPhaseReflTransHolder calcReflTran(Arrival arrival,
 boolean nextLegIsPWave,
 boolean allSH)
                                         throws TauModelException,
SlownessModelException

Calculates the product of the reflection and transmission coefficients for this leg.

Parameters:

arrival - arrival/ ray parameter to use for the calculation

nextLegIsPWave - if next leg is a P wave, neede for final coefficient at end of leg

allSH - if should calculate the SH coefficients instead of P-SV

Throws:

TauModelException

SlownessModelException

clone

public SeismicPhaseSegment clone()

Overrides:

clone in class Object

segmentListDescribe

public static String segmentListDescribe(List<List<SeismicPhaseSegment>> segmentListList)

segmentDescribe

public static String segmentDescribe(List<SeismicPhaseSegment> segmentList)

segmentDescribe

public static String segmentDescribe(List<SeismicPhaseSegment> segmentList,
 boolean includeRP)