obspy.taup.tau_branch.TauBranch

class TauBranch(top_depth=0, bot_depth=0, is_p_wave=False)[source]

Bases: object

Provides storage and methods for distance, time and tau increments for a branch. A branch is a group of layers bounded by discontinuities or reversals in slowness gradient.

Public Methods

calc_time_dist

create_branch

Calculates tau for this branch, between slowness layers top_layer_num and bot_layer_num, inclusive.

difference

Generates a new tau branch by "subtracting" the given tau branch from this tau branch (self).

insert

Inserts the distance, time, and tau increment for the slowness sample given to the branch.

path

Called from TauPPath to calculate ray paths.

Private Methods

Warning

Private methods are mainly for internal/developer use and their API might change without notice.

static TauBranch._from_array(arr)[source]

Create instance object from a structured array used in serialization.

TauBranch._to_array()[source]

Store all attributes for serialization in a structured array.

Special Methods

TauBranch.__delattr__(name, /)

Implement delattr(self, name).

TauBranch.__dir__()

Default dir() implementation.

TauBranch.__eq__(other)[source]
TauBranch.__format__(format_spec, /)

Default object formatter.

TauBranch.__ge__(value, /)

Return self>=value.

TauBranch.__getattribute__(name, /)

Return getattr(self, name).

TauBranch.__gt__(value, /)

Return self>value.

TauBranch.__init__(top_depth=0, bot_depth=0, is_p_wave=False)[source]
TauBranch.__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

TauBranch.__le__(value, /)

Return self<=value.

TauBranch.__lt__(value, /)

Return self<value.

TauBranch.__ne__(value, /)

Return self!=value.

TauBranch.__new__(**kwargs)
TauBranch.__reduce__()

Helper for pickle.

TauBranch.__reduce_ex__(protocol, /)

Helper for pickle.

TauBranch.__repr__()

Return repr(self).

TauBranch.__setattr__(name, value, /)

Implement setattr(self, name, value).

TauBranch.__sizeof__()

Size of object in memory, in bytes.

TauBranch.__str__()[source]
TauBranch.__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).