pyrocko.gf.targets

Data structures representing the receivers for seismogram synthesis.

Functions

component_orientation(source, target, component)

Get component and azimuth for standard components R, T, Z, N, and E.

Classes

Filter(**kwargs)	Undocumented.
GNSSCampaignTarget(*args, **kwargs)	Undocumented.
KiteSceneTarget(scene, **kwargs)	Undocumented.
OptimizationMethod(...)	Any str out of ['enable', 'disable'].
SatelliteTarget(*args, **kwargs)	A computation request for a spatial multi-location target of static/geodetic quantities measured from a satellite instrument.
StaticTarget(*args, **kwargs)	A computation request for a spatial multi-location target of static/geodetic quantities.
Target(**kwargs)	A seismogram computation request for a single component, including its post-processing parmeters.

class Filter(**kwargs)

Bases: Object

Undocumented.

class OptimizationMethod(...) → str

Bases: StringChoice

Any str out of ['enable', 'disable'].

Variables:

• choices – Allowed choices (list of str).

• ignore_case – Whether to behave case-insensitive (bool, default: False).

component_orientation(source, target, component)

Get component and azimuth for standard components R, T, Z, N, and E.

Parameters:

• source – pyrocko.model.location.Location object

• target – pyrocko.model.location.Location object

• component – string 'R', 'T', 'Z', 'N' or 'E'

class Target(**kwargs)

Bases: Receiver

A seismogram computation request for a single component, including its post-processing parmeters.

♦ quantity

str (pyrocko.gf.meta.QuantityType), optional

Measurement quantity type. If not given, it is guessed from the channel code. For some common cases, derivatives of the stored quantities are supported by using finite difference approximations (e.g. displacement to velocity or acceleration). 4th order central FD schemes are used.

♦ codes

tuple of 4 str objects, default: ('', 'STA', '', 'Z')

network, station, location and channel codes to be set on the response trace.

♦ elevation

float, default: 0.0

station surface elevation in [m]

♦ store_id

str (pyrocko.gf.meta.StringID), optional

ID of Green’s function store to use for the computation. If not given, the processor may use a system default.

♦ sample_rate

float, optional

sample rate to produce. If not given the GF store’s default sample rate is used. GF store specific restrictions may apply.

♦ interpolation

str (pyrocko.gf.meta.InterpolationMethod), default: 'nearest_neighbor'

Interpolation method between Green’s functions. Supported are nearest_neighbor and multilinear

♦ optimization

str (OptimizationMethod), optional, default: 'enable'

disable/enable optimizations in weight-delay-and-sum operation

♦ tmin

pyrocko.util.get_time_float (pyrocko.guts.Timestamp), optional

time of first sample to request in [s]. If not given, it is determined from the Green’s functions.

♦ tmax

pyrocko.util.get_time_float (pyrocko.guts.Timestamp), optional

time of last sample to request in [s]. If not given, it is determined from the Green’s functions.

♦ azimuth

float, optional

azimuth of sensor component in [deg], clockwise from north. If not given, it is guessed from the channel code.

♦ dip

float, optional

dip of sensor component in [deg], measured downward from horizontal. If not given, it is guessed from the channel code.

♦ filter

Filter, optional

frequency response filter.

class StaticTarget(*args, **kwargs)

Bases: MultiLocation

A computation request for a spatial multi-location target of static/geodetic quantities.

♦ quantity

str (pyrocko.gf.meta.QuantityType), optional, default: 'displacement'

Measurement quantity type, for now only displacement issupported.

♦ interpolation

str (pyrocko.gf.meta.InterpolationMethod), default: 'nearest_neighbor'

Interpolation method between Green’s functions. Supported are nearest_neighbor and multilinear

♦ tsnapshot

pyrocko.util.get_time_float (pyrocko.guts.Timestamp), optional

time of the desired snapshot in [s], If not given, the first sample is taken. If the desired sample exceeds the length of the Green’s function store, the last sample is taken.

♦ store_id

str (pyrocko.gf.meta.StringID), optional

ID of Green’s function store to use for the computation. If not given, the processor may use a system default.

property ntargets

Number of targets held by instance.

get_targets()

Discretizes the multilocation target into a list of Target objects.

Returns:

Individual point locations.

Return type:

list of Target

class SatelliteTarget(*args, **kwargs)

Bases: StaticTarget

A computation request for a spatial multi-location target of static/geodetic quantities measured from a satellite instrument. The line of sight angles are provided and projecting post-processing is applied.

♦ theta

numpy.ndarray (pyrocko.guts_array.Array)

Horizontal angle towards satellite’s line of sight in radians.

Important

is east and is north.

♦ phi

numpy.ndarray (pyrocko.guts_array.Array)

Theta is look vector elevation angle towards satellite from horizon in radians. Matrix of theta towards satellite’s line of sight.

Important

is down and is up.

class KiteSceneTarget(scene, **kwargs)

Bases: SatelliteTarget

Undocumented.

♦ shape

tuple of 2 int objects, default: (None, None)

Shape of the displacement vectors.

class GNSSCampaignTarget(*args, **kwargs)

Bases: StaticTarget

Undocumented.