Package edu.sc.seis.TauP

Class ProtoSeismicPhase

java.lang.Object

edu.sc.seis.TauP.ProtoSeismicPhase

All Implemented Interfaces:

Comparable<ProtoSeismicPhase>

public class ProtoSeismicPhase
extends Object
implements Comparable<ProtoSeismicPhase>

Represents a partial seismic phase, appended to as a name is parsed. May also fail if part way if phase is not compatible with the model.

Constructor Summary

Constructors

Constructor	Description
ProtoSeismicPhase(List<SeismicPhaseSegment> segmentList, double receiverDepth)

Method Summary

Modifier and Type	Method	Description
final void	add(SeismicPhaseSegment seg)
protected SeismicPhaseSegment	addFlatBranch(boolean isPWave, PhaseInteraction prevEndAction, PhaseInteraction endAction, String currLeg)
SeismicPhaseSegment	addToBranch(int endBranch, boolean isPWave, boolean nextIsPWave, PhaseInteraction endAction, String currLeg)	Adds a segment to a path of a seismic phase.
SimpleSeismicPhase	asSeismicPhase()
List<Integer>	branchNumSeg()
String	branchNumSeqStr()
String	branchNumSeqStrWithSegBreaks()
void	calcEndSegRayParam()
int	calcInteractionNumber()
protected double	calcMaxTransitRP(int startBranch, int endBranch, boolean isPWave, PhaseInteraction prevEndAction, double maxRayParam)
int	calcStartBranch(String currLeg)	Calculate the starting branch number for the current leg.
int	compareTo(ProtoSeismicPhase o)
int	countDiffLegs()
int	countFlatLegs()
int	countHeadLegs()
final SeismicPhaseSegment	endSegment()
static ProtoSeismicPhase	failNewPhase(TauModel tMod, boolean isPWave, LayerPropogationType layerPropogationType, double receiverDepth, String phaseName, String reason)
SeismicPhaseSegment	failNext(String reason)
static int	findEndDiscon(TauModel tMod, int startBranchNum, boolean isPWave, LayerPropogationType layerPropogationType)	Finds discontinuity branch in direction given.
final SeismicPhaseSegment	get(int i)
final PhaseInteraction	getEndAction()
SeismicPhaseSegment	getFlatSegment()
String	getName()
String	getPuristName()
final List<SeismicPhaseSegment>	getSegmentList()
TauModel	gettMod()
final boolean	isEmpty()
boolean	isSuccessful()
static String	legNameForSegment(TauModel tMod, int endBranch, boolean isPWave, LayerPropogationType layerPropogationType, PhaseInteraction endAction)
static String	legNameForSegment(TauModel tMod, SeismicPhaseSegment seg)
ProtoSeismicPhase	nextSegment(boolean isPWave, int endDisconBranchNum, PhaseInteraction endAction)	Propogates a ray to the discontinuity given.
ProtoSeismicPhase	nextSegment(boolean isPWave, PhaseInteraction endAction)
int	nextStartBranch()
String	phaseNameForSegments()
String	phaseNameForSegments(boolean zapED)
String	segmentListAsString()
final int	size()
final SeismicPhaseSegment	sourceSegment()
List<ShadowOrProto>	splitForAllHighSlowness()
List<ShadowOrProto>	splitForHighSlowness(TauBranch hszBranch)
List<ShadowOrProto>	splitForHighSlownessDiscon(int hszBranchNum, boolean isPWave)	Split for a discontinuity where above slowness is smaller than below.
static ProtoSeismicPhase	start(SeismicPhaseSegment startSeg, double receiverDepth)
static ProtoSeismicPhase	startEmpty(String phaseName, TauModel tMod, double receiverDepth)	Starts a phase with no legs.
static ProtoSeismicPhase	startNewPhase(TauModel tMod, boolean isPWave, PhaseInteraction endAction, LayerPropogationType layerPropogationType, double receiverDepth)
void	validateSegList()
String	zapEDIfPossible(SeismicPhaseSegment seg, SeismicPhaseSegment next, String legName)

Methods inherited from class java.lang.Object

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

Constructor Details

ProtoSeismicPhase

public ProtoSeismicPhase(List<SeismicPhaseSegment> segmentList,
 double receiverDepth)

Method Details

startEmpty

public static ProtoSeismicPhase startEmpty(String phaseName,
 TauModel tMod,
 double receiverDepth)

Starts a phase with no legs.

Parameters:

phaseName - name of phase

tMod - tau model, which includes the source depth

receiverDepth - depth of the receiver

Returns:

proto phase ready for adding legs

start

public static ProtoSeismicPhase start(SeismicPhaseSegment startSeg,
 double receiverDepth)

failNewPhase

public static ProtoSeismicPhase failNewPhase(TauModel tMod,
 boolean isPWave,
 LayerPropogationType layerPropogationType,
 double receiverDepth,
 String phaseName,
 String reason)

startNewPhase

public static ProtoSeismicPhase startNewPhase(TauModel tMod,
 boolean isPWave,
 PhaseInteraction endAction,
 LayerPropogationType layerPropogationType,
 double receiverDepth)
                                       throws TauPException

Throws:

TauPException

failNext

public SeismicPhaseSegment failNext(String reason)

nextSegment

public ProtoSeismicPhase nextSegment(boolean isPWave,
 PhaseInteraction endAction)
                              throws TauModelException

Throws:

TauModelException

nextStartBranch

public int nextStartBranch()
                    throws TauModelException

Throws:

TauModelException

nextSegment

public ProtoSeismicPhase nextSegment(boolean isPWave,
 int endDisconBranchNum,
 PhaseInteraction endAction)
                              throws TauModelException

Propogates a ray to the discontinuity given.

Parameters:

isPWave - true for P, false for S

endDisconBranchNum - branch number for the layer below the discontinuity

endAction - end action when hitting the discontinuity

Returns:

phase with one additional segment

Throws:

TauModelException

findEndDiscon

public static int findEndDiscon(TauModel tMod,
 int startBranchNum,
 boolean isPWave,
 LayerPropogationType layerPropogationType)

Finds discontinuity branch in direction given. Branch number is below the discontinuity.

Parameters:

tMod - the model

startBranchNum - starting branch

isPWave - true for P

layerPropogationType - up or down

Returns:

branch number below the discontinuity

validateSegList

public void validateSegList()
                     throws TauModelException

Throws:

TauModelException

splitForAllHighSlowness

public List<ShadowOrProto> splitForAllHighSlowness()
                                            throws TauModelException

Throws:

TauModelException

splitForHighSlowness

public List<ShadowOrProto> splitForHighSlowness(TauBranch hszBranch)
                                         throws TauModelException

Throws:

TauModelException

splitForHighSlownessDiscon

public List<ShadowOrProto> splitForHighSlownessDiscon(int hszBranchNum,
 boolean isPWave)
                                               throws TauModelException

Split for a discontinuity where above slowness is smaller than below. Usually a low velocity zone. Only splits for discontinuities internal to a SeismicPhaseSegment as discontinuities at the boundary are handled via normal phase generation and min,max ray param and cannot generate an internal shadow zone.

Parameters:

hszBranchNum - TauBranch number with the discon at its top

isPWave - true for P waves, false for S waves

Returns:

phase split for shadow zone

Throws:

TauModelException

calcEndSegRayParam

public void calcEndSegRayParam()
                        throws TauModelException

Throws:

TauModelException

getSegmentList

public final List<SeismicPhaseSegment> getSegmentList()

get

public final SeismicPhaseSegment get(int i)

isEmpty

public final boolean isEmpty()

getFlatSegment

public SeismicPhaseSegment getFlatSegment()

getEndAction

public final PhaseInteraction getEndAction()

endSegment

public final SeismicPhaseSegment endSegment()

sourceSegment

public final SeismicPhaseSegment sourceSegment()

isSuccessful

public boolean isSuccessful()

size

public final int size()

countFlatLegs

public int countFlatLegs()

countHeadLegs

public int countHeadLegs()

countDiffLegs

public int countDiffLegs()

add

public final void add(SeismicPhaseSegment seg)

calcStartBranch

public int calcStartBranch(String currLeg)
                    throws TauModelException

Calculate the starting branch number for the current leg. This is the same as the previous end branch number for reflections, and offset by one for transmissions.

Parameters:

currLeg - current leg name

Returns:

branch number

Throws:

TauModelException

addToBranch

public SeismicPhaseSegment addToBranch(int endBranch,
 boolean isPWave,
 boolean nextIsPWave,
 PhaseInteraction endAction,
 String currLeg)
                                throws TauModelException

Adds a segment to a path of a seismic phase. Generally this corresponds to a character in a phase name, like K in PKP.

Parameters:

endBranch - ending branch number, start is calculated from the end branch and end action of the prior leg.

isPWave - current leg phase type, true for P, false for S

nextIsPWave - next leg phase type, true for P, false for S, determines if a phase conversion at the end

endAction - action the phase takes at the end, like TURN or REFLECT_TOPSIDE

currLeg - name of current leg

Returns:

The segment added by this call

Throws:

TauModelException - if arguments not possible in the model, but not thrown for a simple failure to exist

calcMaxTransitRP

protected double calcMaxTransitRP(int startBranch,
 int endBranch,
 boolean isPWave,
 PhaseInteraction prevEndAction,
 double maxRayParam)

addFlatBranch

protected SeismicPhaseSegment addFlatBranch(boolean isPWave,
 PhaseInteraction prevEndAction,
 PhaseInteraction endAction,
 String currLeg)
                                     throws TauModelException

Throws:

TauModelException

calcInteractionNumber

public int calcInteractionNumber()

zapEDIfPossible

public String zapEDIfPossible(SeismicPhaseSegment seg,
 SeismicPhaseSegment next,
 String legName)

phaseNameForSegments

public String phaseNameForSegments()

phaseNameForSegments

public String phaseNameForSegments(boolean zapED)

legNameForSegment

public static String legNameForSegment(TauModel tMod,
 SeismicPhaseSegment seg)

legNameForSegment

public static String legNameForSegment(TauModel tMod,
 int endBranch,
 boolean isPWave,
 LayerPropogationType layerPropogationType,
 PhaseInteraction endAction)

branchNumSeg

public List<Integer> branchNumSeg()

branchNumSeqStr

public String branchNumSeqStr()

branchNumSeqStrWithSegBreaks

public String branchNumSeqStrWithSegBreaks()

asSeismicPhase

public SimpleSeismicPhase asSeismicPhase()
                                  throws TauModelException

Throws:

TauModelException

getName

public String getName()

getPuristName

public String getPuristName()

gettMod

public TauModel gettMod()

segmentListAsString

public String segmentListAsString()

compareTo

public int compareTo(ProtoSeismicPhase o)

Specified by:

compareTo in interface Comparable<ProtoSeismicPhase>