seiscomp.datamodel

Base Objects

• Object

• PublicObject

• Notifier

Domain Overview

EventParameters

EventParameters object connections from parent to child.

EventParameters object connections from parent to child including attributes and elements.

Config

Config object connections from parent to child including attributes and elements.

QualityControl

QualityControl object connections from parent to child including attributes and elements.

Inventory

Inventory object connections from parent to child.

Inventory object connections from parent to child including attributes and elements.

Routing

Routing object connections from parent to child including attributes and elements.

Journaling

Journaling object connections from parent to child including attributes and elements.

ArclinkLog

ArclinkLog object connections from parent to child including attributes and elements.

DataAvailability

DataAvailability object connections from parent to child including attributes and elements.

Enumerations

• DataUsedWaveType

• EvaluationMode

• EvaluationStatus

• EventDescriptionType

• EventType

• EventTypeCertainty

• MomentTensorMethod

• MomentTensorStatus

• OriginDepthType

• OriginType

• OriginUncertaintyDescription

• PickOnset

• PickPolarity

• SourceTimeFunctionType

• StationGroupType

DataUsedWaveType

ID	Numeric value	String value
BODY_WAVES	0	body waves
P_BODY_WAVES	1	P body waves
LONG_PERIOD_BODY_WAVES	2	long-period body waves
SURFACE_WAVES	3	surface waves
INTERMEDIATE_PERIOD_SURFACE_WAVES	4	intermediate-period surface waves
LONG_PERIOD_MANTLE_WAVES	5	long-period mantle waves
UNKNOWN_WAVETYPE	6	unknown

Used by:

• DataUsed.waveType()

EvaluationMode

ID	Numeric value	String value
MANUAL	0	manual
AUTOMATIC	1	automatic

Used by:

• Amplitude.evaluationMode()

• FocalMechanism.evaluationMode()

• Origin.evaluationMode()

• Pick.evaluationMode()

EvaluationStatus

ID	Numeric value	String value
PRELIMINARY	0	preliminary
CONFIRMED	1	confirmed
REVIEWED	2	reviewed
FINAL	3	final
REJECTED	4	rejected
REPORTED	5	reported

Used by:

• FocalMechanism.evaluationStatus()

• Magnitude.evaluationStatus()

• Origin.evaluationStatus()

• Pick.evaluationStatus()

EventDescriptionType

ID	Numeric value	String value
FELT_REPORT	0	felt report
FLINN_ENGDAHL_REGION	1	Flinn-Engdahl region
LOCAL_TIME	2	local time
TECTONIC_SUMMARY	3	tectonic summary
NEAREST_CITIES	4	nearest cities
EARTHQUAKE_NAME	5	earthquake name
REGION_NAME	6	region name

Used by:

• EventDescription.type()

EventType

ID	Numeric value	String value
NOT_EXISTING	0	not existing
NOT_LOCATABLE	1	not locatable
OUTSIDE_OF_NETWORK_INTEREST	2	outside of network interest
EARTHQUAKE	3	earthquake
INDUCED_EARTHQUAKE	4	induced earthquake
QUARRY_BLAST	5	quarry blast
EXPLOSION	6	explosion
CHEMICAL_EXPLOSION	7	chemical explosion
NUCLEAR_EXPLOSION	8	nuclear explosion
LANDSLIDE	9	landslide
ROCKSLIDE	10	rockslide
SNOW_AVALANCHE	11	snow avalanche
DEBRIS_AVALANCHE	12	debris avalanche
MINE_COLLAPSE	13	mine collapse
BUILDING_COLLAPSE	14	building collapse
VOLCANIC_ERUPTION	15	volcanic eruption
METEOR_IMPACT	16	meteor impact
PLANE_CRASH	17	plane crash
SONIC_BOOM	18	sonic boom
DUPLICATE	19	duplicate
OTHER_EVENT	20	other
NOT_REPORTED	21	not reported
ANTHROPOGENIC_EVENT	22	anthropogenic event
COLLAPSE	23	collapse
CAVITY_COLLAPSE	24	cavity collapse
ACCIDENTAL_EXPLOSION	25	accidental explosion
CONTROLLED_EXPLOSION	26	controlled explosion
EXPERIMENTAL_EXPLOSION	27	experimental explosion
INDUSTRIAL_EXPLOSION	28	industrial explosion
MINING_EXPLOSION	29	mining explosion
ROAD_CUT	30	road cut
BLASTING_LEVEE	31	blasting levee
INDUCED_OR_TRIGGERED_EVENT	32	induced or triggered event
ROCK_BURST	33	rock burst
RESERVOIR_LOADING	34	reservoir loading
FLUID_INJECTION	35	fluid injection
FLUID_EXTRACTION	36	fluid extraction
CRASH	37	crash
TRAIN_CRASH	38	train crash
BOAT_CRASH	39	boat crash
ATMOSPHERIC_EVENT	40	atmospheric event
SONIC_BLAST	41	sonic blast
ACOUSTIC_NOISE	42	acoustic noise
THUNDER	43	thunder
AVALANCHE	44	avalanche
HYDROACOUSTIC_EVENT	45	hydroacoustic event
ICE_QUAKE	46	ice quake
SLIDE	47	slide
METEORITE	48	meteorite
CALVING	49	calving
FROST_QUAKE	50	frost quake
TREMOR_PULSE	51	tremor pulse
SUBMARINE_LANDSLIDE	52	submarine landslide
ROCKET_LAUNCH	53	rocket launch
ROCKET	54	rocket
ROCKET_IMPACT	55	rocket impact
ARTILLERY_STRIKE	56	artillery strike
BOMB_DETONATION	57	bomb detonation
MOVING_AIRCRAFT	58	moving aircraft
ATMOSPHERIC_METEOR_EXPLOSION	59	atmospheric meteor explosion
VOLCANO_TECTONIC	60	volcano-tectonic
VOLCANIC_LONG_PERIOD	61	volcanic long-period
VOLCANIC_VERY_LONG_PERIOD	62	volcanic very-long-period
VOLCANIC_HYBRID	63	volcanic hybrid
VOLCANIC_ROCKFALL	64	volcanic rockfall
VOLCANIC_TREMOR	65	volcanic tremor
PYROCLASTIC_FLOW	66	pyroclastic flow
LAHAR	67	lahar

Used by:

• Event.type()

EventTypeCertainty

ID	Numeric value	String value
KNOWN	0	known
SUSPECTED	1	suspected
DAMAGING	2	damaging
FELT	3	felt

Used by:

• Event.typeCertainty()

MomentTensorMethod

ID	Numeric value	String value
CMT_0	0	CMT - general moment tensor
CMT_1	1	CMT - moment tensor with zero trace
CMT_2	2	CMT - double-couple source
TELESEISMIC	3	teleseismic
REGIONAL	4	regional

Used by:

• MomentTensor.method()

MomentTensorStatus

ID	Numeric value	String value
CMT_S	0	standard CMT solution
CMT_Q	1	quick CMT solution

Used by:

• MomentTensor.status()

OriginDepthType

ID	Numeric value	String value
FROM_LOCATION	0	from location
FROM_MOMENT_TENSOR_INVERSION	1	from moment tensor inversion
BROAD_BAND_P_WAVEFORMS	2	from modeling of broad-band P waveforms
CONSTRAINED_BY_DEPTH_PHASES	3	constrained by depth phases
CONSTRAINED_BY_DIRECT_PHASES	4	constrained by direct phases
OPERATOR_ASSIGNED	5	operator assigned
OTHER_ORIGIN_DEPTH	6	other

Used by:

• Origin.depthType()

OriginType

ID	Numeric value	String value
HYPOCENTER	0	hypocenter
CENTROID	1	centroid
AMPLITUDE	2	amplitude
MACROSEISMIC	3	macroseismic
RUPTURE_START	4	rupture start
RUPTURE_END	5	rupture end

Used by:

• Origin.type()

OriginUncertaintyDescription

ID	Numeric value	String value
HORIZONTAL	0	horizontal uncertainty
ELLIPSE	1	uncertainty ellipse
ELLIPSOID	2	confidence ellipsoid
PDF	3	probability density function

Used by:

• OriginUncertainty.preferredDescription()

PickOnset

ID	Numeric value	String value
EMERGENT	0	emergent
IMPULSIVE	1	impulsive
QUESTIONABLE	2	questionable

Used by:

• Pick.onset()

PickPolarity

ID	Numeric value	String value
POSITIVE	0	positive
NEGATIVE	1	negative
UNDECIDABLE	2	undecidable

Used by:

• Pick.polarity()

SourceTimeFunctionType

ID	Numeric value	String value
BOX_CAR	0	box car
TRIANGLE	1	triangle
TRAPEZOID	2	trapezoid
UNKNOWN_FUNCTION	3	unknown

Used by:

• SourceTimeFunction.type()

StationGroupType

ID	Numeric value	String value
DEPLOYMENT	0	deployment
ARRAY	1	array

Used by:

• StationGroup.type()

Reference

Object

class seiscomp.datamodel.Object

parent()

Return type:

PublicObject

Returns the PublicObject parent object is available, None otherwise.

setParent(parent)

Parameters:

parent – A PublicObject.

Return type:

A Boolean flag indicating success with True, False otherwise.

Sets the parent to PublicObject. This is an internal method and should not be called from applications. Instead a class should be derived from Object which calls this method internally when children are being added or removed.

update()

Creates an update notifier for this object ignoring its children. If an attribute of an object is changed this methods needs to be called manually since attribute changes are not tracked automatically by the notifier framework. Only hierarchy modifications such as add and remove child objects.

assign(other)

Parameters:

other – A Object.

Return type:

A Boolean flag indicating success with True, False otherwise.

Assign the metadata of ‘other’ to ‘this’ without others children. Returns True, if ‘this’ and ‘other’ are of same type, False otherwise.

clone()

Return type:

A Object.

Clones an object. If the clonee is a PublicObject it is not registered in the global instance pool but receives exactly the same publicID like ‘this’.

attachTo(parent)

Return type:

A Boolean flag indicating success with True, False otherwise.

Adds the object to a parent. If it has already a parent or is of wrong type, False is returned.

detachFrom(parent)

Return type:

A Boolean flag indicating success with True, False otherwise.

Removes the object from a parent. If it has another or no parent, False is returned.

detach()

Return type:

A Boolean flag indicating success with True, False otherwise.

Removes the object from its parent object if a parent is set.

accept(visitor)

Parameters:

visitor – A visitor.

PublicObject

class seiscomp.datamodel.PublicObject

Inherits Object.

setPublicID(id)

Sets the publicID of the object.

publicID()

Returns the publicID of the object.

Notifier

class seiscomp.datamodel.Notifier(parentID, operation, object)

Class to represent a change in the object tree. A notifier takes a parentID, an operation to apply and a child object. The child object is without children.

static Enable()

Enables the notifier pool. If enabled, notifiers are automatically created if the object tree is being changed.

static Enable()

Disables the notifier pool.

static SetEnabled(enable)

Sets the state of the notifier pool.

static IsEnabled()

Returns the notification pool state. The default is TRUE.

static SetCheckEnabled(enable)

Enables/disables checking previous inserted notifiers when a new notifiers is about to be queued. When enabled, and OP_ADD and OP_UPDATE of the same object results in only one OP_ADD notifier.

static IsCheckEnabled()

Returns the current ‘check’ state.

static GetMessage(allNotifier=True)

Parameters:

allNotifier – Defines whether to return one message including all notifiers or one message including one notifier.

Return type:

A NotifierMessage object if there is one. If each notifier is being send by its own message, this method should be called until it returns None.

Returns a message holding all notifications since the last call. All stored notifications will be removed from the notification pool.

static Size()

Return type:

Integer value.

Returns the size of the notifier objects currently stored.

static Clear()

Clears all buffered notifiers.

static Create(parentID, operation, object)

Parameters:

• parentID – The publicID of the parent object that is target of the operation.

• operation – The operation applied to the parent object.

• object – The object that is the operation’s “operand”.

Return type:

The Notifier object.

Creates a notifier object managed by the global notifier pool. If the notifier pool is disabled no notifier instance will be created and None is being returned.

static Create(parent, operation, object)

:param parent The parent object that is target of the operation. :param operation: The operation applied to the parent object. :param object: The object that is the operation’s “operand”. :rtype: The Notifier object.

Creates a notifier object managed by the global notifier pool. If the notifier pool is disabled no notifier instance will be created and None is being returned.

apply()

Return type:

A flag indicating success with True, False otherwise.

Applies the notifier to the local object tree.

Access

class seiscomp.datamodel.Access

Inherits Object.

This type describes an ArcLink access rule

Parents:

• routing – Routing

Attributes:

• networkCode – string

• stationCode – string

• locationCode – string

• streamCode – string

• user – string

• start – seiscomp.core.Time

• end – seiscomp.core.Time (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Access if the cast was successful, None otherwise.

Cast an arbitrary object to Access if the internal wrapped representation is an Access object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type Access to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type AccessIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – Access

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setNetworkCode(networkCode)

Parameters:

networkCode – string

Network code

networkCode()

Return type:

string

setStationCode(stationCode)

Parameters:

stationCode – string

Station code (empty for any station)

stationCode()

Return type:

string

setLocationCode(locationCode)

Parameters:

locationCode – string

Location code (empty for any location)

locationCode()

Return type:

string

setStreamCode(streamCode)

Parameters:

streamCode – string

Stream (Channel) code (empty for any stream)

streamCode()

Return type:

string

setUser(user)

Parameters:

user – string

Username (e-mail) or part of it (must match the end)

user()

Return type:

string

setStart(start)

Parameters:

start – seiscomp.core.Time

Start of validity

start()

Return type:

seiscomp.core.Time

setEnd(end)

Parameters:

end – seiscomp.core.Time

End of validity

end()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

routing()

Return type:

Routing

Returns the parent Routing if available. Returns None if the parent is not a Routing. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Access.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Amplitude

class seiscomp.datamodel.Amplitude

Inherits PublicObject.

This class represents a quantification of the waveform anomaly, usually a single amplitude measurement or a measurement of the visible signal duration for duration magnitudes.

Parents:

• eventParameters – EventParameters

Children:

• comment – Comment

Attributes:

• publicID: string

• type – string

• amplitude – RealQuantity (optional)

• timeWindow – TimeWindow (optional)

• period – RealQuantity (optional)

• snr – float (optional)

• unit – string

• pickID – string

• waveformID – WaveformStreamID (optional)

• filterID – string

• methodID – string

• scalingTime – TimeQuantity (optional)

• magnitudeHint – string

• evaluationMode – EvaluationMode (optional)

• creationInfo – CreationInfo (optional)

Referenced by:

• AmplitudeReference.amplitudeID()

• StationMagnitude.amplitudeID()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Amplitude if the cast was successful, None otherwise.

Cast an arbitrary object to Amplitude if the internal wrapped representation is an Amplitude object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type Amplitude.

Creates and registers (if enabled) a Amplitude instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type Amplitude.

Creates and registers (if enabled) a Amplitude instance with passed publicID.

equal(other)

Parameters:

other – Another object of type Amplitude to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setType(type)

Parameters:

type – string

String that describes the type of amplitude using the nomenclature from Storchak et al. (2003). Possible values include unspecified amplitude reading (A), amplitude reading for local magnitude (ML), amplitude reading for body wave magnitude (MB), amplitude reading for surface wave magnitude (MS), and time of visible end of record for duration magnitude (MD). It has a maximum length of 16 characters.

type()

Return type:

string

setAmplitude(amplitude)

Parameters:

amplitude – RealQuantity

Measured amplitude value for the given waveformID. Note that this attribute can describe different physical quantities, depending on the type of the amplitude. These can be, e.g., displacement, velocity, or a period. If the only amplitude information is a period, it has to specified here, not in the period attribute. The latter can be used if the amplitude measurement contains information on, e.g., displacement and an additional period. Since the physical quantity described by this attribute is not fixed, the unit of measurement cannot be defined in advance. However, the quantity has to be specified in SI base units. The enumeration given in attribute unit provides the most likely units that could be needed here. For clarity, using the optional unit attribute is highly encouraged.

amplitude()

Return type:

RealQuantity

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setTimeWindow(timeWindow)

Parameters:

timeWindow – TimeWindow

Description of the time window used for amplitude measurement. Recommended for duration magnitudes.

timeWindow()

Return type:

TimeWindow

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setPeriod(period)

Parameters:

period – RealQuantity

Dominant period in the timeWindow in case of amplitude measurements. Not used for duration magnitude. The unit is seconds.

period()

Return type:

RealQuantity

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setSnr(snr)

Parameters:

snr – float

Signal-to-noise ratio of the spectrogram at the location the amplitude was measured.

snr()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setUnit(unit)

Parameters:

unit – string

This attribute provides the most likely measurement units for the physical quantity described in the amplitude attribute. Possible values are specified as combinations of SI base units.

unit()

Return type:

string

setPickID(pickID)

Parameters:

pickID – string

Refers to the publicID of an associated Pick object.

pickID()

Return type:

string

setWaveformID(waveformID)

Parameters:

waveformID – WaveformStreamID

Identifies the waveform stream on which the amplitude was measured.

waveformID()

Return type:

WaveformStreamID

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setFilterID(filterID)

Parameters:

filterID – string

Identifies the filter or filter setup used for filtering the waveform stream referenced by waveformID.

filterID()

Return type:

string

setMethodID(methodID)

Parameters:

methodID – string

methodID()

Return type:

string

setScalingTime(scalingTime)

Parameters:

scalingTime – TimeQuantity

Scaling time for amplitude measurement.

scalingTime()

Return type:

TimeQuantity

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setMagnitudeHint(magnitudeHint)

Parameters:

magnitudeHint – string

Type of magnitude the amplitude measurement is used for. For valid values see class Magnitude. String value with a maximum length of 16 characters.

magnitudeHint()

Return type:

string

setEvaluationMode(evaluationMode)

Parameters:

evaluationMode – EvaluationMode

Evaluation mode of Amplitude.

evaluationMode()

Return type:

EvaluationMode

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setCreationInfo(creationInfo)

Parameters:

creationInfo – CreationInfo

CreationInfo for the Amplitude object.

creationInfo()

Return type:

CreationInfo

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Comment object to Amplitude. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Comment object from Amplitude.

removeComment(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeComment(commentIndex);

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

commentCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Comment child objects.

comment(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Comment.

Returns the Comment at index idx.

comment(commentIndex)

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

Object of type Comment.

Returns the Comment at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

eventParameters()

Return type:

EventParameters

Returns the parent EventParameters if available. Returns None if the parent is not a EventParameters. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Amplitude.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

AmplitudeReference

class seiscomp.datamodel.AmplitudeReference

Inherits Object.

Parents:

• reading – Reading

Attributes:

• amplitudeID – string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type AmplitudeReference if the cast was successful, None otherwise.

Cast an arbitrary object to AmplitudeReference if the internal wrapped representation is an AmplitudeReference object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type AmplitudeReference to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type AmplitudeReferenceIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – AmplitudeReference

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setAmplitudeID(amplitudeID)

Parameters:

amplitudeID – string

amplitudeID()

Return type:

string

reading()

Return type:

Reading

Returns the parent Reading if available. Returns None if the parent is not a Reading. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned AmplitudeReference.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

ArclinkLog

class seiscomp.datamodel.ArclinkLog

Inherits PublicObject.

Children:

• arclinkRequest – ArclinkRequest

• arclinkUser – ArclinkUser

Attributes:

• publicID: string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type ArclinkLog if the cast was successful, None otherwise.

Cast an arbitrary object to ArclinkLog if the internal wrapped representation is an ArclinkLog object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type ArclinkLog to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

add(arclinkRequest)

Parameters:

arclinkRequest – Object of type ArclinkRequest

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a ArclinkRequest object to ArclinkLog. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(arclinkUser)

Parameters:

arclinkUser – Object of type ArclinkUser

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a ArclinkUser object to ArclinkLog. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(arclinkRequest)

Parameters:

arclinkRequest – Object of type ArclinkRequest

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added ArclinkRequest object from ArclinkLog.

remove(arclinkUser)

Parameters:

arclinkUser – Object of type ArclinkUser

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added ArclinkUser object from ArclinkLog.

removeArclinkRequest(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeArclinkRequest(arclinkRequestIndex);

Parameters:

arclinkRequestIndex – The index of the object to be removed of type ArclinkRequestIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeArclinkUser(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeArclinkUser(arclinkUserIndex);

Parameters:

arclinkUserIndex – The index of the object to be removed of type ArclinkUserIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

arclinkRequestCount()

Return type:

integer value indicating the number of child objects.

Returns the number of ArclinkRequest child objects.

arclinkUserCount()

Return type:

integer value indicating the number of child objects.

Returns the number of ArclinkUser child objects.

arclinkRequest(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type ArclinkRequest.

Returns the ArclinkRequest at index idx.

arclinkRequest(arclinkRequestIndex)

Parameters:

arclinkRequestIndex – The index of the object to be removed of type ArclinkRequestIndex.

Return type:

Object of type ArclinkRequest.

Returns the ArclinkRequest at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

arclinkUser(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type ArclinkUser.

Returns the ArclinkUser at index idx.

arclinkUser(arclinkUserIndex)

Parameters:

arclinkUserIndex – The index of the object to be removed of type ArclinkUserIndex.

Return type:

Object of type ArclinkUser.

Returns the ArclinkUser at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

findArclinkRequest(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type ArclinkRequest.

Returns the child object with a certain publicID, None otherwise.

findArclinkUser(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type ArclinkUser.

Returns the child object with a certain publicID, None otherwise.

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned ArclinkLog.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

ArclinkRequest

class seiscomp.datamodel.ArclinkRequest

Inherits PublicObject.

Parents:

• arclinkLog – ArclinkLog

Children:

• arclinkStatusLine – ArclinkStatusLine

• arclinkRequestLine – ArclinkRequestLine

Attributes:

• publicID: string

• requestID – string

• userID – string

• userIP – string

• clientID – string

• clientIP – string

• type – string

• created – seiscomp.core.Time

• status – string

• message – string

• label – string

• header – string

• summary – ArclinkRequestSummary (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type ArclinkRequest if the cast was successful, None otherwise.

Cast an arbitrary object to ArclinkRequest if the internal wrapped representation is an ArclinkRequest object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type ArclinkRequest.

Creates and registers (if enabled) a ArclinkRequest instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type ArclinkRequest.

Creates and registers (if enabled) a ArclinkRequest instance with passed publicID.

equal(other)

Parameters:

other – Another object of type ArclinkRequest to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type ArclinkRequestIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – ArclinkRequest

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setRequestID(requestID)

Parameters:

requestID – string

requestID()

Return type:

string

setUserID(userID)

Parameters:

userID – string

userID()

Return type:

string

setUserIP(userIP)

Parameters:

userIP – string

userIP()

Return type:

string

setClientID(clientID)

Parameters:

clientID – string

clientID()

Return type:

string

setClientIP(clientIP)

Parameters:

clientIP – string

clientIP()

Return type:

string

setType(type)

Parameters:

type – string

type()

Return type:

string

setCreated(created)

Parameters:

created – seiscomp.core.Time

created()

Return type:

seiscomp.core.Time

setStatus(status)

Parameters:

status – string

status()

Return type:

string

setMessage(message)

Parameters:

message – string

message()

Return type:

string

setLabel(label)

Parameters:

label – string

label()

Return type:

string

setHeader(header)

Parameters:

header – string

header()

Return type:

string

setSummary(summary)

Parameters:

summary – ArclinkRequestSummary

summary()

Return type:

ArclinkRequestSummary

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(arclinkStatusLine)

Parameters:

arclinkStatusLine – Object of type ArclinkStatusLine

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a ArclinkStatusLine object to ArclinkRequest. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(arclinkRequestLine)

Parameters:

arclinkRequestLine – Object of type ArclinkRequestLine

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a ArclinkRequestLine object to ArclinkRequest. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(arclinkStatusLine)

Parameters:

arclinkStatusLine – Object of type ArclinkStatusLine

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added ArclinkStatusLine object from ArclinkRequest.

remove(arclinkRequestLine)

Parameters:

arclinkRequestLine – Object of type ArclinkRequestLine

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added ArclinkRequestLine object from ArclinkRequest.

removeArclinkStatusLine(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeArclinkStatusLine(arclinkStatusLineIndex);

Parameters:

arclinkStatusLineIndex – The index of the object to be removed of type ArclinkStatusLineIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeArclinkRequestLine(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeArclinkRequestLine(arclinkRequestLineIndex);

Parameters:

arclinkRequestLineIndex – The index of the object to be removed of type ArclinkRequestLineIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

arclinkStatusLineCount()

Return type:

integer value indicating the number of child objects.

Returns the number of ArclinkStatusLine child objects.

arclinkRequestLineCount()

Return type:

integer value indicating the number of child objects.

Returns the number of ArclinkRequestLine child objects.

arclinkStatusLine(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type ArclinkStatusLine.

Returns the ArclinkStatusLine at index idx.

arclinkStatusLine(arclinkStatusLineIndex)

Parameters:

arclinkStatusLineIndex – The index of the object to be removed of type ArclinkStatusLineIndex.

Return type:

Object of type ArclinkStatusLine.

Returns the ArclinkStatusLine at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

arclinkRequestLine(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type ArclinkRequestLine.

Returns the ArclinkRequestLine at index idx.

arclinkRequestLine(arclinkRequestLineIndex)

Parameters:

arclinkRequestLineIndex – The index of the object to be removed of type ArclinkRequestLineIndex.

Return type:

Object of type ArclinkRequestLine.

Returns the ArclinkRequestLine at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

arclinkLog()

Return type:

ArclinkLog

Returns the parent ArclinkLog if available. Returns None if the parent is not a ArclinkLog. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned ArclinkRequest.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

ArclinkRequestLine

class seiscomp.datamodel.ArclinkRequestLine

Inherits Object.

Parents:

• arclinkRequest – ArclinkRequest

Attributes:

• start – seiscomp.core.Time

• end – seiscomp.core.Time

• streamID – WaveformStreamID

• restricted – boolean (optional)

• shared – boolean (optional)

• netClass – string

• constraints – string

• status – ArclinkStatusLine

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type ArclinkRequestLine if the cast was successful, None otherwise.

Cast an arbitrary object to ArclinkRequestLine if the internal wrapped representation is an ArclinkRequestLine object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type ArclinkRequestLine to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type ArclinkRequestLineIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – ArclinkRequestLine

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setStart(start)

Parameters:

start – seiscomp.core.Time

start()

Return type:

seiscomp.core.Time

setEnd(end)

Parameters:

end – seiscomp.core.Time

end()

Return type:

seiscomp.core.Time

setStreamID(streamID)

Parameters:

streamID – WaveformStreamID

streamID()

Return type:

WaveformStreamID

setRestricted(restricted)

Parameters:

restricted – boolean

restricted()

Return type:

boolean

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setShared(shared)

Parameters:

shared – boolean

shared()

Return type:

boolean

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setNetClass(netClass)

Parameters:

netClass – string

netClass()

Return type:

string

setConstraints(constraints)

Parameters:

constraints – string

constraints()

Return type:

string

setStatus(status)

Parameters:

status – ArclinkStatusLine

status()

Return type:

ArclinkStatusLine

arclinkRequest()

Return type:

ArclinkRequest

Returns the parent ArclinkRequest if available. Returns None if the parent is not a ArclinkRequest. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned ArclinkRequestLine.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

ArclinkRequestSummary

class seiscomp.datamodel.ArclinkRequestSummary

Inherits Object.

Attributes:

• okLineCount – int

• totalLineCount – int

• averageTimeWindow – int

Used by:

• ArclinkRequest.summary()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type ArclinkRequestSummary if the cast was successful, None otherwise.

Cast an arbitrary object to ArclinkRequestSummary if the internal wrapped representation is an ArclinkRequestSummary object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type ArclinkRequestSummary to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setOkLineCount(okLineCount)

Parameters:

okLineCount – int

okLineCount()

Return type:

int

setTotalLineCount(totalLineCount)

Parameters:

totalLineCount – int

totalLineCount()

Return type:

int

setAverageTimeWindow(averageTimeWindow)

Parameters:

averageTimeWindow – int

averageTimeWindow()

Return type:

int

ArclinkStatusLine

class seiscomp.datamodel.ArclinkStatusLine

Inherits Object.

Parents:

• arclinkRequest – ArclinkRequest

Attributes:

• type – string

• status – string

• size – int (optional)

• message – string

• volumeID – string

Used by:

• ArclinkRequestLine.status()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type ArclinkStatusLine if the cast was successful, None otherwise.

Cast an arbitrary object to ArclinkStatusLine if the internal wrapped representation is an ArclinkStatusLine object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type ArclinkStatusLine to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type ArclinkStatusLineIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – ArclinkStatusLine

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setType(type)

Parameters:

type – string

type()

Return type:

string

setStatus(status)

Parameters:

status – string

status()

Return type:

string

setSize(size)

Parameters:

size – int

size()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setMessage(message)

Parameters:

message – string

message()

Return type:

string

setVolumeID(volumeID)

Parameters:

volumeID – string

volumeID()

Return type:

string

arclinkRequest()

Return type:

ArclinkRequest

Returns the parent ArclinkRequest if available. Returns None if the parent is not a ArclinkRequest. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned ArclinkStatusLine.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

ArclinkUser

class seiscomp.datamodel.ArclinkUser

Inherits PublicObject.

Parents:

• arclinkLog – ArclinkLog

Attributes:

• publicID: string

• name – string

• email – string

• password – string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type ArclinkUser if the cast was successful, None otherwise.

Cast an arbitrary object to ArclinkUser if the internal wrapped representation is an ArclinkUser object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type ArclinkUser.

Creates and registers (if enabled) a ArclinkUser instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type ArclinkUser.

Creates and registers (if enabled) a ArclinkUser instance with passed publicID.

equal(other)

Parameters:

other – Another object of type ArclinkUser to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type ArclinkUserIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – ArclinkUser

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setName(name)

Parameters:

name – string

name()

Return type:

string

setEmail(email)

Parameters:

email – string

email()

Return type:

string

setPassword(password)

Parameters:

password – string

password()

Return type:

string

arclinkLog()

Return type:

ArclinkLog

Returns the parent ArclinkLog if available. Returns None if the parent is not a ArclinkLog. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned ArclinkUser.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Arrival

class seiscomp.datamodel.Arrival

Inherits Object.

Successful association of a pick with an origin qualifies this pick as an arrival. An arrival thus connects a pick with an origin and provides additional attributes that describe this relationship. Usually qualification of a pick as an arrival for a given origin is a hypothesis, which is based on assumptions about the type of arrival (phase) as well as observed and (on the basis of an earth model) computed arrival times, or the residual, respectively. Additional pick attributes like the horizontal slowness and backazimuth of the observed wave-especially if derived from array data-may further constrain the nature of the arrival.

Parents:

• origin – Origin

Attributes:

• pickID – string

• phase – Phase

• timeCorrection – float (optional)

• azimuth – float (optional)

• distance – float (optional)

• takeOffAngle – float (optional)

• timeResidual – float (optional)

• horizontalSlownessResidual – float (optional)

• backazimuthResidual – float (optional)

• timeUsed – boolean (optional)

• horizontalSlownessUsed – boolean (optional)

• backazimuthUsed – boolean (optional)

• weight – float (optional)

• earthModelID – string

• preliminary – boolean (optional)

• creationInfo – CreationInfo (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Arrival if the cast was successful, None otherwise.

Cast an arbitrary object to Arrival if the internal wrapped representation is an Arrival object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type Arrival to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type ArrivalIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – Arrival

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setPickID(pickID)

Parameters:

pickID – string

Refers to a publicID of a Pick.

pickID()

Return type:

string

setPhase(phase)

Parameters:

phase – Phase

Phase identification. For possible values, please refer to the description of the Phase type.

phase()

Return type:

Phase

setTimeCorrection(timeCorrection)

Parameters:

timeCorrection – float

Time correction value. Usually, a value characteristic for the station at which the pick was detected, sometimes also characteristic for the phase type or the slowness in seconds.

timeCorrection()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setAzimuth(azimuth)

Parameters:

azimuth – float

Azimuth of station as seen from the epicenter in degrees.

azimuth()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDistance(distance)

Parameters:

distance – float

Epicentral distance in degrees.

distance()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setTakeOffAngle(takeOffAngle)

Parameters:

takeOffAngle – float

Angle of emerging ray at the source, measured against the downward normal direction in degrees.

takeOffAngle()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setTimeResidual(timeResidual)

Parameters:

timeResidual – float

Residual between observed and expected arrival time assuming proper phase identification and given the earthModelID of the Origin, taking into account the timeCorrection in seconds.

timeResidual()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setHorizontalSlownessResidual(horizontalSlownessResidual)

Parameters:

horizontalSlownessResidual – float

Residual of horizontal slowness and the expected slowness given the current origin (refers to attribute horizontalSlowness of class Pick) in s/deg.

horizontalSlownessResidual()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setBackazimuthResidual(backazimuthResidual)

Parameters:

backazimuthResidual – float

Residual of backazimuth and the backazimuth computed for the current origin (refers to attribute backazimuth of class Pick) in degrees.

backazimuthResidual()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setTimeUsed(timeUsed)

Parameters:

timeUsed – boolean

timeUsed()

Return type:

boolean

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setHorizontalSlownessUsed(horizontalSlownessUsed)

Parameters:

horizontalSlownessUsed – boolean

Weight of the horizontal slowness for computation of the associated Origin. Note that the sum of all weights is not required to be unity.

horizontalSlownessUsed()

Return type:

boolean

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setBackazimuthUsed(backazimuthUsed)

Parameters:

backazimuthUsed – boolean

backazimuthUsed()

Return type:

boolean

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setWeight(weight)

Parameters:

weight – float

Weight of the arrival time for computation of the associated Origin. Note that the sum of all weights is not required to be unity.

weight()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setEarthModelID(earthModelID)

Parameters:

earthModelID – string

Earth model which is used for the association of Arrival to Pick and computation of the residuals.

earthModelID()

Return type:

string

setPreliminary(preliminary)

Parameters:

preliminary – boolean

Indicates if the arrival is preliminary.

preliminary()

Return type:

boolean

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setCreationInfo(creationInfo)

Parameters:

creationInfo – CreationInfo

CreationInfo for the Arrival object.

creationInfo()

Return type:

CreationInfo

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

origin()

Return type:

Origin

Returns the parent Origin if available. Returns None if the parent is not a Origin. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Arrival.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

AuxDevice

class seiscomp.datamodel.AuxDevice

Inherits PublicObject.

This type describes an auxiliary device

Parents:

• inventory – Inventory

Children:

• auxSource – AuxSource

Attributes:

• publicID: string

• name – string

• description – string

• model – string

• manufacturer – string

• remark – Blob (optional)

Referenced by:

• AuxStream.device()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type AuxDevice if the cast was successful, None otherwise.

Cast an arbitrary object to AuxDevice if the internal wrapped representation is an AuxDevice object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type AuxDevice.

Creates and registers (if enabled) a AuxDevice instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type AuxDevice.

Creates and registers (if enabled) a AuxDevice instance with passed publicID.

equal(other)

Parameters:

other – Another object of type AuxDevice to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type AuxDeviceIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – AuxDevice

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setName(name)

Parameters:

name – string

Unique device name

name()

Return type:

string

setDescription(description)

Parameters:

description – string

Device description

description()

Return type:

string

setModel(model)

Parameters:

model – string

Device model

model()

Return type:

string

setManufacturer(manufacturer)

Parameters:

manufacturer – string

Device manufacturer

manufacturer()

Return type:

string

setRemark(remark)

Parameters:

remark – Blob

remark()

Return type:

Blob

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(auxSource)

Parameters:

auxSource – Object of type AuxSource

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a AuxSource object to AuxDevice. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(auxSource)

Parameters:

auxSource – Object of type AuxSource

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added AuxSource object from AuxDevice.

removeAuxSource(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeAuxSource(auxSourceIndex);

Parameters:

auxSourceIndex – The index of the object to be removed of type AuxSourceIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

auxSourceCount()

Return type:

integer value indicating the number of child objects.

Returns the number of AuxSource child objects.

auxSource(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type AuxSource.

Returns the AuxSource at index idx.

auxSource(auxSourceIndex)

Parameters:

auxSourceIndex – The index of the object to be removed of type AuxSourceIndex.

Return type:

Object of type AuxSource.

Returns the AuxSource at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

inventory()

Return type:

Inventory

Returns the parent Inventory if available. Returns None if the parent is not a Inventory. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned AuxDevice.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

AuxSource

class seiscomp.datamodel.AuxSource

Inherits Object.

This type describes a channel of an auxiliary device

Parents:

• auxDevice – AuxDevice

Attributes:

• name – string

• description – string

• unit – string

• conversion – string

• sampleRateNumerator – int (optional)

• sampleRateDenominator – int (optional)

• remark – Blob (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type AuxSource if the cast was successful, None otherwise.

Cast an arbitrary object to AuxSource if the internal wrapped representation is an AuxSource object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type AuxSource to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type AuxSourceIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – AuxSource

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setName(name)

Parameters:

name – string

Referred from network/station/auxStream/@source

name()

Return type:

string

setDescription(description)

Parameters:

description – string

Description

description()

Return type:

string

setUnit(unit)

Parameters:

unit – string

Unit of mesurement

unit()

Return type:

string

setConversion(conversion)

Parameters:

conversion – string

Conversion formula from counts to unit of measurement

conversion()

Return type:

string

setSampleRateNumerator(sampleRateNumerator)

Parameters:

sampleRateNumerator – int

Output sample rate (numerator); referred from network/station/AuxStream/@sampleRateNumerator

sampleRateNumerator()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setSampleRateDenominator(sampleRateDenominator)

Parameters:

sampleRateDenominator – int

Output sample rate (denominator); referred from network/station/AuxStream/@sampleRateDenominator

sampleRateDenominator()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setRemark(remark)

Parameters:

remark – Blob

remark()

Return type:

Blob

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

auxDevice()

Return type:

AuxDevice

Returns the parent AuxDevice if available. Returns None if the parent is not a AuxDevice. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned AuxSource.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

AuxStream

class seiscomp.datamodel.AuxStream

Inherits Object.

This type describes a stream (channel) without defined frequency response

Parents:

• sensorLocation – SensorLocation

Attributes:

• code – string

• start – seiscomp.core.Time

• end – seiscomp.core.Time (optional)

• device – string

• deviceSerialNumber – string

• source – string

• format – string

• flags – string

• restricted – boolean (optional)

• shared – boolean (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type AuxStream if the cast was successful, None otherwise.

Cast an arbitrary object to AuxStream if the internal wrapped representation is an AuxStream object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type AuxStream to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type AuxStreamIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – AuxStream

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setCode(code)

Parameters:

code – string

Stream code (52.04)

code()

Return type:

string

setStart(start)

Parameters:

start – seiscomp.core.Time

Start of epoch in ISO datetime format (52.22)

start()

Return type:

seiscomp.core.Time

setEnd(end)

Parameters:

end – seiscomp.core.Time

End of epoch (52.23)

end()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDevice(device)

Parameters:

device – string

Reference to auxDevice/@publicID

device()

Return type:

string

setDeviceSerialNumber(deviceSerialNumber)

Parameters:

deviceSerialNumber – string

Serial number of device

deviceSerialNumber()

Return type:

string

setSource(source)

Parameters:

source – string

Reference to auxSource/@name

source()

Return type:

string

setFormat(format)

Parameters:

format – string

Data format, eg.: "steim1", "steim2", "mseedN" (N = encoding format in blockette 1000)

format()

Return type:

string

setFlags(flags)

Parameters:

flags – string

Channel flags (52.21)

flags()

Return type:

string

setRestricted(restricted)

Parameters:

restricted – boolean

Whether the stream is "restricted"

restricted()

Return type:

boolean

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setShared(shared)

Parameters:

shared – boolean

Whether the metadata is synchronized with other datacenters

shared()

Return type:

boolean

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

sensorLocation()

Return type:

SensorLocation

Returns the parent SensorLocation if available. Returns None if the parent is not a SensorLocation. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned AuxStream.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Axis

class seiscomp.datamodel.Axis

Inherits Object.

This class describes an eigenvector of a moment tensor expressed in its principal-axes system. It uses the angles azimuth, plunge, and the eigenvalue length.

Attributes:

• azimuth – RealQuantity

• plunge – RealQuantity

• length – RealQuantity

Used by:

• PrincipalAxes.tAxis()

• PrincipalAxes.pAxis()

• PrincipalAxes.nAxis()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Axis if the cast was successful, None otherwise.

Cast an arbitrary object to Axis if the internal wrapped representation is an Axis object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type Axis to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setAzimuth(azimuth)

Parameters:

azimuth – RealQuantity

Azimuth of eigenvector of moment tensor expressed in principal-axes system. Measured clockwise from South-North direction at epicenter in degrees.

azimuth()

Return type:

RealQuantity

setPlunge(plunge)

Parameters:

plunge – RealQuantity

Plunge of eigenvector of moment tensor expressed in principal-axes system. Measured against downward vertical direction at epicenter in degrees.

plunge()

Return type:

RealQuantity

setLength(length)

Parameters:

length – RealQuantity

Eigenvalue of moment tensor expressed in principal-axes system in Nm.

length()

Return type:

RealQuantity

Blob

class seiscomp.datamodel.Blob

Inherits Object.

Attributes:

• content – string

Used by:

• AuxDevice.remark()

• AuxSource.remark()

• Datalogger.remark()

• DataloggerCalibration.remark()

• Decimation.analogueFilterChain()

• Decimation.digitalFilterChain()

• Network.remark()

• ResponseFAP.remark()

• ResponseFIR.remark()

• ResponseIIR.remark()

• ResponsePAZ.remark()

• ResponsePolynomial.remark()

• Sensor.remark()

• SensorCalibration.remark()

• Station.remark()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Blob if the cast was successful, None otherwise.

Cast an arbitrary object to Blob if the internal wrapped representation is an Blob object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type Blob to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setContent(content)

Parameters:

content – string

content()

Return type:

string

Comment

class seiscomp.datamodel.Comment

Inherits Object.

Comment holds information on comments to a resource as well as author and creation time information.

Parents:

• momentTensor – MomentTensor

• focalMechanism – FocalMechanism

• amplitude – Amplitude

• magnitude – Magnitude

• stationMagnitude – StationMagnitude

• pick – Pick

• event – Event

• origin – Origin

• parameter – Parameter

• parameterSet – ParameterSet

• stream – Stream

• sensorLocation – SensorLocation

• station – Station

• network – Network

Attributes:

• text – string

• id – string

• start – seiscomp.core.Time (optional)

• end – seiscomp.core.Time (optional)

• creationInfo – CreationInfo (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Comment if the cast was successful, None otherwise.

Cast an arbitrary object to Comment if the internal wrapped representation is an Comment object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type Comment to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type CommentIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – Comment

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setText(text)

Parameters:

text – string

Text of comment.

text()

Return type:

string

setId(id)

Parameters:

id – string

Identifier of comment, possibly in QuakeML RI format.

id()

Return type:

string

setStart(start)

Parameters:

start – seiscomp.core.Time

Start of epoch in ISO datetime format

start()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setEnd(end)

Parameters:

end – seiscomp.core.Time

End of epoch (empty if the comment epoch is open)

end()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setCreationInfo(creationInfo)

Parameters:

creationInfo – CreationInfo

CreationInfo for the Comment object.

creationInfo()

Return type:

CreationInfo

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

momentTensor()

Return type:

MomentTensor

Returns the parent MomentTensor if available. Returns None if the parent is not a MomentTensor. This is a convenience wrapper for parent().

focalMechanism()

Return type:

FocalMechanism

Returns the parent FocalMechanism if available. Returns None if the parent is not a FocalMechanism. This is a convenience wrapper for parent().

amplitude()

Return type:

Amplitude

Returns the parent Amplitude if available. Returns None if the parent is not a Amplitude. This is a convenience wrapper for parent().

magnitude()

Return type:

Magnitude

Returns the parent Magnitude if available. Returns None if the parent is not a Magnitude. This is a convenience wrapper for parent().

stationMagnitude()

Return type:

StationMagnitude

Returns the parent StationMagnitude if available. Returns None if the parent is not a StationMagnitude. This is a convenience wrapper for parent().

pick()

Return type:

Pick

Returns the parent Pick if available. Returns None if the parent is not a Pick. This is a convenience wrapper for parent().

event()

Return type:

Event

Returns the parent Event if available. Returns None if the parent is not a Event. This is a convenience wrapper for parent().

origin()

Return type:

Origin

Returns the parent Origin if available. Returns None if the parent is not a Origin. This is a convenience wrapper for parent().

parameter()

Return type:

Parameter

Returns the parent Parameter if available. Returns None if the parent is not a Parameter. This is a convenience wrapper for parent().

parameterSet()

Return type:

ParameterSet

Returns the parent ParameterSet if available. Returns None if the parent is not a ParameterSet. This is a convenience wrapper for parent().

stream()

Return type:

Stream

Returns the parent Stream if available. Returns None if the parent is not a Stream. This is a convenience wrapper for parent().

sensorLocation()

Return type:

SensorLocation

Returns the parent SensorLocation if available. Returns None if the parent is not a SensorLocation. This is a convenience wrapper for parent().

station()

Return type:

Station

Returns the parent Station if available. Returns None if the parent is not a Station. This is a convenience wrapper for parent().

network()

Return type:

Network

Returns the parent Network if available. Returns None if the parent is not a Network. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Comment.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

ComplexArray

class seiscomp.datamodel.ComplexArray

Inherits Object.

Attributes:

• content – complex (optional)

Used by:

• ResponsePAZ.zeros()

• ResponsePAZ.poles()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type ComplexArray if the cast was successful, None otherwise.

Cast an arbitrary object to ComplexArray if the internal wrapped representation is an ComplexArray object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type ComplexArray to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setContent(content)

Parameters:

content – complex

content()

Return type:

complex

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

CompositeTime

class seiscomp.datamodel.CompositeTime

Inherits Object.

Focal times differ significantly in their precision. While focal times of instrumentally located earthquakes are estimated precisely down to seconds, historic events have only incomplete time descriptions. Sometimes, even contradictory information about the rupture time exist. The CompositeTime type allows for such complex descriptions. If the specification is given with no greater accuracy than days (i.e., no time components are given), the date refers to local time. However, if time components are given, they have to refer to UTC. As an example, consider a historic earthquake in California, e.g., on 28 February 1730, with no time information given. Expressed in UTC, this day extends from 1730-02-28T08:00:00Z until 1730-03-01T08:00:00Z. Such a specification would be against intuition. Therefore, for date-time specifications without time components, local time is used. In the example, the CompositeTime attributes are simply year 1730, month 2, and day 28. In the corresponding time attribute of the origin, however, UTC has to be used. If the unknown time components are assumed to be zero, the value is 1730-02-28T08:00:00Z.

Parents:

• origin – Origin

Attributes:

• year – IntegerQuantity (optional)

• month – IntegerQuantity (optional)

• day – IntegerQuantity (optional)

• hour – IntegerQuantity (optional)

• minute – IntegerQuantity (optional)

• second – RealQuantity (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type CompositeTime if the cast was successful, None otherwise.

Cast an arbitrary object to CompositeTime if the internal wrapped representation is an CompositeTime object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type CompositeTime to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setYear(year)

Parameters:

year – IntegerQuantity

Year or range of years of the event’s focal time.

year()

Return type:

IntegerQuantity

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setMonth(month)

Parameters:

month – IntegerQuantity

Month or range of months of the event’s focal time.

month()

Return type:

IntegerQuantity

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDay(day)

Parameters:

day – IntegerQuantity

Day or range of days of the event’s focal time.

day()

Return type:

IntegerQuantity

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setHour(hour)

Parameters:

hour – IntegerQuantity

Hour or range of hours of the event’s focal time.

hour()

Return type:

IntegerQuantity

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setMinute(minute)

Parameters:

minute – IntegerQuantity

Minute or range of minutes of the event’s focal time.

minute()

Return type:

IntegerQuantity

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setSecond(second)

Parameters:

second – RealQuantity

Second and fraction of seconds or range of seconds with fraction of the event’s focal time.

second()

Return type:

RealQuantity

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

origin()

Return type:

Origin

Returns the parent Origin if available. Returns None if the parent is not a Origin. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned CompositeTime.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

ConfidenceEllipsoid

class seiscomp.datamodel.ConfidenceEllipsoid

Inherits Object.

This class represents a description of the location uncertainty as a confidence ellipsoid with arbitrary orientation in space. The orientation of a rigid body in three-dimensional Euclidean space can be described by three parameters. We use the convention of Euler angles, which can be interpreted as a composition of three elemental rotations (i.e., rotations around a single axis). In the special case of Euler angles we use here, the angles are referred to as Tait-Bryan (or Cardan) angles. These angles may be familiar to the reader from their application in flight dynamics, and are referred to as heading (yaw, psi), elevation (attitude, pitch, phi), and bank (roll, theta). For a definition of the angles, see Figure 4. Through the three elemental rotations, a Cartesian system (x, y, z) centered at the epicenter, with the South-North direction x, the West-East direction y, and the downward vertical direction z, is transferred into a different Cartesian system (X, Y , Z) centered on the confidence ellipsoid. Here, X denotes the direction of the major axis, and Y denotes the direction of the minor axis of the ellipsoid. Note that Figure 4 can be interpreted as a hypothetical view from the interior of the Earth to the inner face of a shell representing Earth’s surface. The three Tait-Bryan rotations are performed as follows: (i) a rotation about the Z axis with angle psi (heading, or azimuth); (ii) a rotation about the Y axis with angle phi (elevation, or plunge); and (iii) a rotation about the X axis with angle theta (bank). Note that in the case of Tait-Bryan angles, the rotations are performed about the ellipsoid’s axes, not about the axes of the fixed (x, y, z) Cartesian system. In the following list the correspondence of the attributes of class ConfidenceEllipsoid to the respective Tait-Bryan angles is listed: majorAxisPlunge: elevation (pitch, phi), majorAxisAzimuth: heading (yaw, psi), majorAxisRotation: bank (roll, theta)

Attributes:

• semiMajorAxisLength – float

• semiMinorAxisLength – float

• semiIntermediateAxisLength – float

• majorAxisPlunge – float

• majorAxisAzimuth – float

• majorAxisRotation – float

Used by:

• OriginUncertainty.confidenceEllipsoid()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type ConfidenceEllipsoid if the cast was successful, None otherwise.

Cast an arbitrary object to ConfidenceEllipsoid if the internal wrapped representation is an ConfidenceEllipsoid object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type ConfidenceEllipsoid to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setSemiMajorAxisLength(semiMajorAxisLength)

Parameters:

semiMajorAxisLength – float

Largest uncertainty, corresponding to the semi-major axis of the confidence ellipsoid in meter.

semiMajorAxisLength()

Return type:

float

setSemiMinorAxisLength(semiMinorAxisLength)

Parameters:

semiMinorAxisLength – float

Smallest uncertainty, corresponding to the semi-minor axis of the confidence ellipsoid in meter.

semiMinorAxisLength()

Return type:

float

setSemiIntermediateAxisLength(semiIntermediateAxisLength)

Parameters:

semiIntermediateAxisLength – float

Uncertainty in direction orthogonal to major and minor axes of the confidence ellipsoid in meter.

semiIntermediateAxisLength()

Return type:

float

setMajorAxisPlunge(majorAxisPlunge)

Parameters:

majorAxisPlunge – float

Plunge angle of major axis of confidence ellipsoid. Corresponds to Tait-Bryan angle phi in degrees.

majorAxisPlunge()

Return type:

float

setMajorAxisAzimuth(majorAxisAzimuth)

Parameters:

majorAxisAzimuth – float

Azimuth angle of major axis of confidence ellipsoid. Corresponds to Tait-Bryan angle psi in degrees.

majorAxisAzimuth()

Return type:

float

setMajorAxisRotation(majorAxisRotation)

Parameters:

majorAxisRotation – float

This angle describes a rotation about the confidence ellipsoid’s major axis which is required to define the direction of the ellipsoid’s minor axis. Corresponds to Tait-Bryan angle theta in degrees.

majorAxisRotation()

Return type:

float

Config

class seiscomp.datamodel.Config

Inherits PublicObject.

Children:

• parameterSet – ParameterSet

• configModule – ConfigModule

Attributes:

• publicID: string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Config if the cast was successful, None otherwise.

Cast an arbitrary object to Config if the internal wrapped representation is an Config object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type Config to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

add(parameterSet)

Parameters:

parameterSet – Object of type ParameterSet

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a ParameterSet object to Config. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(configModule)

Parameters:

configModule – Object of type ConfigModule

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a ConfigModule object to Config. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(parameterSet)

Parameters:

parameterSet – Object of type ParameterSet

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added ParameterSet object from Config.

remove(configModule)

Parameters:

configModule – Object of type ConfigModule

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added ConfigModule object from Config.

removeParameterSet(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeConfigModule(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

parameterSetCount()

Return type:

integer value indicating the number of child objects.

Returns the number of ParameterSet child objects.

configModuleCount()

Return type:

integer value indicating the number of child objects.

Returns the number of ConfigModule child objects.

parameterSet(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type ParameterSet.

Returns the ParameterSet at index idx.

configModule(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type ConfigModule.

Returns the ConfigModule at index idx.

findParameterSet(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type ParameterSet.

Returns the child object with a certain publicID, None otherwise.

findConfigModule(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type ConfigModule.

Returns the child object with a certain publicID, None otherwise.

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Config.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

ConfigModule

class seiscomp.datamodel.ConfigModule

Inherits PublicObject.

Parents:

• config – Config

Children:

• configStation – ConfigStation

Attributes:

• publicID: string

• name – string

• parameterSetID – string

• enabled – boolean

Referenced by:

• ParameterSet.moduleID()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type ConfigModule if the cast was successful, None otherwise.

Cast an arbitrary object to ConfigModule if the internal wrapped representation is an ConfigModule object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type ConfigModule.

Creates and registers (if enabled) a ConfigModule instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type ConfigModule.

Creates and registers (if enabled) a ConfigModule instance with passed publicID.

equal(other)

Parameters:

other – Another object of type ConfigModule to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setName(name)

Parameters:

name – string

name()

Return type:

string

setParameterSetID(parameterSetID)

Parameters:

parameterSetID – string

parameterSetID()

Return type:

string

setEnabled(enabled)

Parameters:

enabled – boolean

enabled()

Return type:

boolean

add(configStation)

Parameters:

configStation – Object of type ConfigStation

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a ConfigStation object to ConfigModule. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(configStation)

Parameters:

configStation – Object of type ConfigStation

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added ConfigStation object from ConfigModule.

removeConfigStation(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeConfigStation(configStationIndex);

Parameters:

configStationIndex – The index of the object to be removed of type ConfigStationIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

configStationCount()

Return type:

integer value indicating the number of child objects.

Returns the number of ConfigStation child objects.

configStation(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type ConfigStation.

Returns the ConfigStation at index idx.

configStation(configStationIndex)

Parameters:

configStationIndex – The index of the object to be removed of type ConfigStationIndex.

Return type:

Object of type ConfigStation.

Returns the ConfigStation at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

findConfigStation(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type ConfigStation.

Returns the child object with a certain publicID, None otherwise.

config()

Return type:

Config

Returns the parent Config if available. Returns None if the parent is not a Config. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned ConfigModule.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

ConfigStation

class seiscomp.datamodel.ConfigStation

Inherits PublicObject.

Parents:

• configModule – ConfigModule

Children:

• setup – Setup

Attributes:

• publicID: string

• networkCode – string

• stationCode – string

• enabled – boolean

• creationInfo – CreationInfo (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type ConfigStation if the cast was successful, None otherwise.

Cast an arbitrary object to ConfigStation if the internal wrapped representation is an ConfigStation object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type ConfigStation.

Creates and registers (if enabled) a ConfigStation instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type ConfigStation.

Creates and registers (if enabled) a ConfigStation instance with passed publicID.

equal(other)

Parameters:

other – Another object of type ConfigStation to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type ConfigStationIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – ConfigStation

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setNetworkCode(networkCode)

Parameters:

networkCode – string

networkCode()

Return type:

string

setStationCode(stationCode)

Parameters:

stationCode – string

stationCode()

Return type:

string

setEnabled(enabled)

Parameters:

enabled – boolean

enabled()

Return type:

boolean

setCreationInfo(creationInfo)

Parameters:

creationInfo – CreationInfo

CreationInfo for the ConfigStation object.

creationInfo()

Return type:

CreationInfo

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(setup)

Parameters:

setup – Object of type Setup

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Setup object to ConfigStation. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(setup)

Parameters:

setup – Object of type Setup

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Setup object from ConfigStation.

removeSetup(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeSetup(setupIndex);

Parameters:

setupIndex – The index of the object to be removed of type SetupIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

setupCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Setup child objects.

setup(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Setup.

Returns the Setup at index idx.

setup(setupIndex)

Parameters:

setupIndex – The index of the object to be removed of type SetupIndex.

Return type:

Object of type Setup.

Returns the Setup at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

configModule()

Return type:

ConfigModule

Returns the parent ConfigModule if available. Returns None if the parent is not a ConfigModule. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned ConfigStation.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

CreationInfo

class seiscomp.datamodel.CreationInfo

Inherits Object.

CreationInfo is used to describe creation metadata (author, version, and creation time) of a resource.

Attributes:

• agencyID – string

• agencyURI – string

• author – string

• authorURI – string

• creationTime – seiscomp.core.Time (optional)

• modificationTime – seiscomp.core.Time (optional)

• version – string

Used by:

• Amplitude.creationInfo()

• Arrival.creationInfo()

• Comment.creationInfo()

• ConfigStation.creationInfo()

• Event.creationInfo()

• FocalMechanism.creationInfo()

• Magnitude.creationInfo()

• MomentTensor.creationInfo()

• Origin.creationInfo()

• Pick.creationInfo()

• StationMagnitude.creationInfo()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type CreationInfo if the cast was successful, None otherwise.

Cast an arbitrary object to CreationInfo if the internal wrapped representation is an CreationInfo object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type CreationInfo to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setAgencyID(agencyID)

Parameters:

agencyID – string

Designation of agency that published a resource. The string has a maximum length of 64 characters.

agencyID()

Return type:

string

setAgencyURI(agencyURI)

Parameters:

agencyURI – string

RI of the agency that published a resource.

agencyURI()

Return type:

string

setAuthor(author)

Parameters:

author – string

Name describing the author of a resource. The string has a maximum length of 128 characters.

author()

Return type:

string

setAuthorURI(authorURI)

Parameters:

authorURI – string

RI of the author of a resource.

authorURI()

Return type:

string

setCreationTime(creationTime)

Parameters:

creationTime – seiscomp.core.Time

Time of creation of a resource, in ISO 8601 format. It has to be given in UTC.

creationTime()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setModificationTime(modificationTime)

Parameters:

modificationTime – seiscomp.core.Time

Time of last modification of a resource, in ISO 8601 format. It has to be given in UTC.

modificationTime()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setVersion(version)

Parameters:

version – string

Version string of a resource.

version()

Return type:

string

DataAttributeExtent

class seiscomp.datamodel.DataAttributeExtent

Inherits Object.

Parents:

• dataExtent – DataExtent

Attributes:

• start – seiscomp.core.Time

• end – seiscomp.core.Time

• sampleRate – double

• quality – string

• updated – seiscomp.core.Time

• segmentCount – int

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type DataAttributeExtent if the cast was successful, None otherwise.

Cast an arbitrary object to DataAttributeExtent if the internal wrapped representation is an DataAttributeExtent object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type DataAttributeExtent to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type DataAttributeExtentIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – DataAttributeExtent

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setStart(start)

Parameters:

start – seiscomp.core.Time

Time of first sample of data attribute extent.

start()

Return type:

seiscomp.core.Time

setEnd(end)

Parameters:

end – seiscomp.core.Time

Time after last sample of data attribute extent.

end()

Return type:

seiscomp.core.Time

setSampleRate(sampleRate)

Parameters:

sampleRate – double

Sample rate of the current data attribute extent.

sampleRate()

Return type:

double

setQuality(quality)

Parameters:

quality – string

Quality indicator of current data attribute extent.

quality()

Return type:

string

setUpdated(updated)

Parameters:

updated – seiscomp.core.Time

The time of the last update or creation of this data attribute extent.

updated()

Return type:

seiscomp.core.Time

setSegmentCount(segmentCount)

Parameters:

segmentCount – int

Number of data segments covered by this data attribute extent.

segmentCount()

Return type:

int

dataExtent()

Return type:

DataExtent

Returns the parent DataExtent if available. Returns None if the parent is not a DataExtent. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned DataAttributeExtent.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

DataAvailability

class seiscomp.datamodel.DataAvailability

Inherits PublicObject.

This type can hold data availability related objects (extent and segment).

Children:

• dataExtent – DataExtent

Attributes:

• publicID: string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type DataAvailability if the cast was successful, None otherwise.

Cast an arbitrary object to DataAvailability if the internal wrapped representation is an DataAvailability object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type DataAvailability to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

add(dataExtent)

Parameters:

dataExtent – Object of type DataExtent

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a DataExtent object to DataAvailability. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(dataExtent)

Parameters:

dataExtent – Object of type DataExtent

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added DataExtent object from DataAvailability.

removeDataExtent(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeDataExtent(dataExtentIndex);

Parameters:

dataExtentIndex – The index of the object to be removed of type DataExtentIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

dataExtentCount()

Return type:

integer value indicating the number of child objects.

Returns the number of DataExtent child objects.

dataExtent(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type DataExtent.

Returns the DataExtent at index idx.

dataExtent(dataExtentIndex)

Parameters:

dataExtentIndex – The index of the object to be removed of type DataExtentIndex.

Return type:

Object of type DataExtent.

Returns the DataExtent at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

findDataExtent(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type DataExtent.

Returns the child object with a certain publicID, None otherwise.

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned DataAvailability.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

DataExtent

class seiscomp.datamodel.DataExtent

Inherits PublicObject.

Parents:

• dataAvailability – DataAvailability

Children:

• dataSegment – DataSegment

• dataAttributeExtent – DataAttributeExtent

Attributes:

• publicID: string

• waveformID – WaveformStreamID

• start – seiscomp.core.Time

• end – seiscomp.core.Time

• updated – seiscomp.core.Time

• lastScan – seiscomp.core.Time

• segmentOverflow – boolean

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type DataExtent if the cast was successful, None otherwise.

Cast an arbitrary object to DataExtent if the internal wrapped representation is an DataExtent object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type DataExtent.

Creates and registers (if enabled) a DataExtent instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type DataExtent.

Creates and registers (if enabled) a DataExtent instance with passed publicID.

equal(other)

Parameters:

other – Another object of type DataExtent to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type DataExtentIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – DataExtent

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setWaveformID(waveformID)

Parameters:

waveformID – WaveformStreamID

waveformID()

Return type:

WaveformStreamID

setStart(start)

Parameters:

start – seiscomp.core.Time

Time of first sample of data available

start()

Return type:

seiscomp.core.Time

setEnd(end)

Parameters:

end – seiscomp.core.Time

Time after last sample of data available

end()

Return type:

seiscomp.core.Time

setUpdated(updated)

Parameters:

updated – seiscomp.core.Time

The time of the last update or creation of this segment

updated()

Return type:

seiscomp.core.Time

setLastScan(lastScan)

Parameters:

lastScan – seiscomp.core.Time

The time of the last waveform archive scan

lastScan()

Return type:

seiscomp.core.Time

setSegmentOverflow(segmentOverflow)

Parameters:

segmentOverflow – boolean

Flags the stream to be to fragmented for processing.

segmentOverflow()

Return type:

boolean

add(dataSegment)

Parameters:

dataSegment – Object of type DataSegment

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a DataSegment object to DataExtent. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(dataAttributeExtent)

Parameters:

dataAttributeExtent – Object of type DataAttributeExtent

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a DataAttributeExtent object to DataExtent. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(dataSegment)

Parameters:

dataSegment – Object of type DataSegment

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added DataSegment object from DataExtent.

remove(dataAttributeExtent)

Parameters:

dataAttributeExtent – Object of type DataAttributeExtent

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added DataAttributeExtent object from DataExtent.

removeDataSegment(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeDataSegment(dataSegmentIndex);

Parameters:

dataSegmentIndex – The index of the object to be removed of type DataSegmentIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeDataAttributeExtent(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeDataAttributeExtent(dataAttributeExtentIndex);

Parameters:

dataAttributeExtentIndex – The index of the object to be removed of type DataAttributeExtentIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

dataSegmentCount()

Return type:

integer value indicating the number of child objects.

Returns the number of DataSegment child objects.

dataAttributeExtentCount()

Return type:

integer value indicating the number of child objects.

Returns the number of DataAttributeExtent child objects.

dataSegment(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type DataSegment.

Returns the DataSegment at index idx.

dataSegment(dataSegmentIndex)

Parameters:

dataSegmentIndex – The index of the object to be removed of type DataSegmentIndex.

Return type:

Object of type DataSegment.

Returns the DataSegment at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

dataAttributeExtent(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type DataAttributeExtent.

Returns the DataAttributeExtent at index idx.

dataAttributeExtent(dataAttributeExtentIndex)

Parameters:

dataAttributeExtentIndex – The index of the object to be removed of type DataAttributeExtentIndex.

Return type:

Object of type DataAttributeExtent.

Returns the DataAttributeExtent at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

dataAvailability()

Return type:

DataAvailability

Returns the parent DataAvailability if available. Returns None if the parent is not a DataAvailability. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned DataExtent.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

DataSegment

class seiscomp.datamodel.DataSegment

Inherits Object.

Parents:

• dataExtent – DataExtent

Attributes:

• start – seiscomp.core.Time

• end – seiscomp.core.Time

• updated – seiscomp.core.Time

• sampleRate – double

• quality – string

• outOfOrder – boolean

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type DataSegment if the cast was successful, None otherwise.

Cast an arbitrary object to DataSegment if the internal wrapped representation is an DataSegment object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type DataSegment to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type DataSegmentIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – DataSegment

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setStart(start)

Parameters:

start – seiscomp.core.Time

Time of first sample of data segment.

start()

Return type:

seiscomp.core.Time

setEnd(end)

Parameters:

end – seiscomp.core.Time

Time after last sample of data segment.

end()

Return type:

seiscomp.core.Time

setUpdated(updated)

Parameters:

updated – seiscomp.core.Time

The time of the last update or creation of this data segment.

updated()

Return type:

seiscomp.core.Time

setSampleRate(sampleRate)

Parameters:

sampleRate – double

Sample rate of the current data segment.

sampleRate()

Return type:

double

setQuality(quality)

Parameters:

quality – string

Quality indicator of current data segment.

quality()

Return type:

string

setOutOfOrder(outOfOrder)

Parameters:

outOfOrder – boolean

Whether this segment is an out-of-order segment or not.

outOfOrder()

Return type:

boolean

dataExtent()

Return type:

DataExtent

Returns the parent DataExtent if available. Returns None if the parent is not a DataExtent. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned DataSegment.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

DataUsed

class seiscomp.datamodel.DataUsed

Inherits Object.

The DataUsed class describes the type of data that has been used for a moment-tensor inversion.

Parents:

• momentTensor – MomentTensor

Attributes:

• waveType – DataUsedWaveType

• stationCount – int

• componentCount – int

• shortestPeriod – float (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type DataUsed if the cast was successful, None otherwise.

Cast an arbitrary object to DataUsed if the internal wrapped representation is an DataUsed object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type DataUsed to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setWaveType(waveType)

Parameters:

waveType – DataUsedWaveType

Type of waveform data.

waveType()

Return type:

DataUsedWaveType

setStationCount(stationCount)

Parameters:

stationCount – int

Number of stations that have contributed data of the type given in waveType.

stationCount()

Return type:

int

setComponentCount(componentCount)

Parameters:

componentCount – int

Number of data components of the type given in waveType.

componentCount()

Return type:

int

setShortestPeriod(shortestPeriod)

Parameters:

shortestPeriod – float

Shortest period present in data in seconds.

shortestPeriod()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

momentTensor()

Return type:

MomentTensor

Returns the parent MomentTensor if available. Returns None if the parent is not a MomentTensor. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned DataUsed.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Datalogger

class seiscomp.datamodel.Datalogger

Inherits PublicObject.

This type describes a datalogger (digitizer and recorder)

Parents:

• inventory – Inventory

Children:

• dataloggerCalibration – DataloggerCalibration

• decimation – Decimation

Attributes:

• publicID: string

• name – string

• description – string

• digitizerModel – string

• digitizerManufacturer – string

• recorderModel – string

• recorderManufacturer – string

• clockModel – string

• clockManufacturer – string

• clockType – string

• gain – float (optional)

• maxClockDrift – float (optional)

• remark – Blob (optional)

Referenced by:

• Stream.datalogger()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Datalogger if the cast was successful, None otherwise.

Cast an arbitrary object to Datalogger if the internal wrapped representation is an Datalogger object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type Datalogger.

Creates and registers (if enabled) a Datalogger instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type Datalogger.

Creates and registers (if enabled) a Datalogger instance with passed publicID.

equal(other)

Parameters:

other – Another object of type Datalogger to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type DataloggerIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – Datalogger

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setName(name)

Parameters:

name – string

Unique datalogger name

name()

Return type:

string

setDescription(description)

Parameters:

description – string

Datalogger description

description()

Return type:

string

setDigitizerModel(digitizerModel)

Parameters:

digitizerModel – string

Digitizer model

digitizerModel()

Return type:

string

setDigitizerManufacturer(digitizerManufacturer)

Parameters:

digitizerManufacturer – string

Digitizer manufacturer

digitizerManufacturer()

Return type:

string

setRecorderModel(recorderModel)

Parameters:

recorderModel – string

Recorder model

recorderModel()

Return type:

string

setRecorderManufacturer(recorderManufacturer)

Parameters:

recorderManufacturer – string

Recorder manufacturer

recorderManufacturer()

Return type:

string

setClockModel(clockModel)

Parameters:

clockModel – string

Clock model (mostly unused)

clockModel()

Return type:

string

setClockManufacturer(clockManufacturer)

Parameters:

clockManufacturer – string

Clock manufacturer (mostly unused)

clockManufacturer()

Return type:

string

setClockType(clockType)

Parameters:

clockType – string

Clock type (mostly unused)

clockType()

Return type:

string

setGain(gain)

Parameters:

gain – float

Sensitivity of digitizer, counts/V (48.05/58.04)

gain()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setMaxClockDrift(maxClockDrift)

Parameters:

maxClockDrift – float

Max clock drift, seconds/second (not identical to 52.19, which is seconds/sample)

maxClockDrift()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setRemark(remark)

Parameters:

remark – Blob

remark()

Return type:

Blob

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(dataloggerCalibration)

Parameters:

dataloggerCalibration – Object of type DataloggerCalibration

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a DataloggerCalibration object to Datalogger. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(decimation)

Parameters:

decimation – Object of type Decimation

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Decimation object to Datalogger. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(dataloggerCalibration)

Parameters:

dataloggerCalibration – Object of type DataloggerCalibration

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added DataloggerCalibration object from Datalogger.

remove(decimation)

Parameters:

decimation – Object of type Decimation

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Decimation object from Datalogger.

removeDataloggerCalibration(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeDataloggerCalibration(dataloggerCalibrationIndex);

Parameters:

dataloggerCalibrationIndex – The index of the object to be removed of type DataloggerCalibrationIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeDecimation(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeDecimation(decimationIndex);

Parameters:

decimationIndex – The index of the object to be removed of type DecimationIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

dataloggerCalibrationCount()

Return type:

integer value indicating the number of child objects.

Returns the number of DataloggerCalibration child objects.

decimationCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Decimation child objects.

dataloggerCalibration(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type DataloggerCalibration.

Returns the DataloggerCalibration at index idx.

dataloggerCalibration(dataloggerCalibrationIndex)

Parameters:

dataloggerCalibrationIndex – The index of the object to be removed of type DataloggerCalibrationIndex.

Return type:

Object of type DataloggerCalibration.

Returns the DataloggerCalibration at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

decimation(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Decimation.

Returns the Decimation at index idx.

decimation(decimationIndex)

Parameters:

decimationIndex – The index of the object to be removed of type DecimationIndex.

Return type:

Object of type Decimation.

Returns the Decimation at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

inventory()

Return type:

Inventory

Returns the parent Inventory if available. Returns None if the parent is not a Inventory. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Datalogger.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

DataloggerCalibration

class seiscomp.datamodel.DataloggerCalibration

Inherits Object.

This type describes a datalogger calibration

Parents:

• datalogger – Datalogger

Attributes:

• serialNumber – string

• channel – int

• start – seiscomp.core.Time

• end – seiscomp.core.Time (optional)

• gain – float (optional)

• gainFrequency – float (optional)

• remark – Blob (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type DataloggerCalibration if the cast was successful, None otherwise.

Cast an arbitrary object to DataloggerCalibration if the internal wrapped representation is an DataloggerCalibration object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type DataloggerCalibration to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type DataloggerCalibrationIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – DataloggerCalibration

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setSerialNumber(serialNumber)

Parameters:

serialNumber – string

Referred from network/station/Stream/@dataloggerSerialNumber

serialNumber()

Return type:

string

setChannel(channel)

Parameters:

channel – int

Referred from network/station/Stream/@dataloggerChannel

channel()

Return type:

int

setStart(start)

Parameters:

start – seiscomp.core.Time

Start of validity

start()

Return type:

seiscomp.core.Time

setEnd(end)

Parameters:

end – seiscomp.core.Time

End of validity

end()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setGain(gain)

Parameters:

gain – float

Overrides nominal gain of calibrated datalogger (48.05/58.04)

gain()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setGainFrequency(gainFrequency)

Parameters:

gainFrequency – float

Gain frequency (48.06/58.05)

gainFrequency()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setRemark(remark)

Parameters:

remark – Blob

remark()

Return type:

Blob

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

datalogger()

Return type:

Datalogger

Returns the parent Datalogger if available. Returns None if the parent is not a Datalogger. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned DataloggerCalibration.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Decimation

class seiscomp.datamodel.Decimation

Inherits Object.

This type describes a decimation to a certain sample rate

Parents:

• datalogger – Datalogger

Attributes:

• sampleRateNumerator – int

• sampleRateDenominator – int

• analogueFilterChain – Blob (optional)

• digitalFilterChain – Blob (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Decimation if the cast was successful, None otherwise.

Cast an arbitrary object to Decimation if the internal wrapped representation is an Decimation object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type Decimation to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type DecimationIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – Decimation

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setSampleRateNumerator(sampleRateNumerator)

Parameters:

sampleRateNumerator – int

Output sample rate (numerator); referred from network/station/Stream/@sampleRateNumerator

sampleRateNumerator()

Return type:

int

setSampleRateDenominator(sampleRateDenominator)

Parameters:

sampleRateDenominator – int

Output sample rate (denominator); referred from network/station/Stream/@sampleRateDenominator

sampleRateDenominator()

Return type:

int

setAnalogueFilterChain(analogueFilterChain)

Parameters:

analogueFilterChain – Blob

Specifies analogue filters between seismometer and digitizer. Each element (separated by space) references responsePAZ/@publicID

analogueFilterChain()

Return type:

Blob

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDigitalFilterChain(digitalFilterChain)

Parameters:

digitalFilterChain – Blob

Specifies digital filters (decimation, gain removal). Each element (separated by space) references responsePAZ@publicID or responseFIR/@publicID

digitalFilterChain()

Return type:

Blob

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

datalogger()

Return type:

Datalogger

Returns the parent Datalogger if available. Returns None if the parent is not a Datalogger. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Decimation.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Event

class seiscomp.datamodel.Event

Inherits PublicObject.

The class Event describes a seismic event which does not necessarily need to be a tectonic earthquake. An event is usually associated with one or more origins, which contain information about focal time and geographical location of the event. Multiple origins can cover automatic and manual locations, a set of location from different agencies, locations generated with different location programs and earth models, etc. Furthermore, an event is usually associated with one or more magnitudes, and with one or more focal mechanism determinations.

Parents:

• eventParameters – EventParameters

Children:

• eventDescription – EventDescription

• comment – Comment

• originReference – OriginReference

• focalMechanismReference – FocalMechanismReference

Attributes:

• publicID: string

• preferredOriginID – string

• preferredMagnitudeID – string

• preferredFocalMechanismID – string

• type – EventType (optional)

• typeCertainty – EventTypeCertainty (optional)

• creationInfo – CreationInfo (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Event if the cast was successful, None otherwise.

Cast an arbitrary object to Event if the internal wrapped representation is an Event object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type Event.

Creates and registers (if enabled) a Event instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type Event.

Creates and registers (if enabled) a Event instance with passed publicID.

equal(other)

Parameters:

other – Another object of type Event to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setPreferredOriginID(preferredOriginID)

Parameters:

preferredOriginID – string

Refers to the publicID of the preferred Origin object.

preferredOriginID()

Return type:

string

setPreferredMagnitudeID(preferredMagnitudeID)

Parameters:

preferredMagnitudeID – string

Refers to the publicID of the preferred Magnitude object.

preferredMagnitudeID()

Return type:

string

setPreferredFocalMechanismID(preferredFocalMechanismID)

Parameters:

preferredFocalMechanismID – string

Refers to the publicID of the preferred FocalMechanism object.

preferredFocalMechanismID()

Return type:

string

setType(type)

Parameters:

type – EventType

Describes the type of an event (Storchak et al. 2012).

type()

Return type:

EventType

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setTypeCertainty(typeCertainty)

Parameters:

typeCertainty – EventTypeCertainty

Denotes how certain the information on event type is (Storchak et al. 2012).

typeCertainty()

Return type:

EventTypeCertainty

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setCreationInfo(creationInfo)

Parameters:

creationInfo – CreationInfo

CreationInfo for the Event object.

creationInfo()

Return type:

CreationInfo

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(eventDescription)

Parameters:

eventDescription – Object of type EventDescription

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a EventDescription object to Event. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Comment object to Event. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(originReference)

Parameters:

originReference – Object of type OriginReference

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a OriginReference object to Event. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(focalMechanismReference)

Parameters:

focalMechanismReference – Object of type FocalMechanismReference

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a FocalMechanismReference object to Event. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(eventDescription)

Parameters:

eventDescription – Object of type EventDescription

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added EventDescription object from Event.

remove(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Comment object from Event.

remove(originReference)

Parameters:

originReference – Object of type OriginReference

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added OriginReference object from Event.

remove(focalMechanismReference)

Parameters:

focalMechanismReference – Object of type FocalMechanismReference

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added FocalMechanismReference object from Event.

removeEventDescription(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeEventDescription(eventDescriptionIndex);

Parameters:

eventDescriptionIndex – The index of the object to be removed of type EventDescriptionIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeComment(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeComment(commentIndex);

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeOriginReference(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeOriginReference(originReferenceIndex);

Parameters:

originReferenceIndex – The index of the object to be removed of type OriginReferenceIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeFocalMechanismReference(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeFocalMechanismReference(focalMechanismReferenceIndex);

Parameters:

focalMechanismReferenceIndex – The index of the object to be removed of type FocalMechanismReferenceIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

eventDescriptionCount()

Return type:

integer value indicating the number of child objects.

Returns the number of EventDescription child objects.

commentCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Comment child objects.

originReferenceCount()

Return type:

integer value indicating the number of child objects.

Returns the number of OriginReference child objects.

focalMechanismReferenceCount()

Return type:

integer value indicating the number of child objects.

Returns the number of FocalMechanismReference child objects.

eventDescription(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type EventDescription.

Returns the EventDescription at index idx.

eventDescription(eventDescriptionIndex)

Parameters:

eventDescriptionIndex – The index of the object to be removed of type EventDescriptionIndex.

Return type:

Object of type EventDescription.

Returns the EventDescription at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

comment(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Comment.

Returns the Comment at index idx.

comment(commentIndex)

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

Object of type Comment.

Returns the Comment at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

originReference(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type OriginReference.

Returns the OriginReference at index idx.

originReference(originReferenceIndex)

Parameters:

originReferenceIndex – The index of the object to be removed of type OriginReferenceIndex.

Return type:

Object of type OriginReference.

Returns the OriginReference at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

focalMechanismReference(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type FocalMechanismReference.

Returns the FocalMechanismReference at index idx.

focalMechanismReference(focalMechanismReferenceIndex)

Parameters:

focalMechanismReferenceIndex – The index of the object to be removed of type FocalMechanismReferenceIndex.

Return type:

Object of type FocalMechanismReference.

Returns the FocalMechanismReference at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

eventParameters()

Return type:

EventParameters

Returns the parent EventParameters if available. Returns None if the parent is not a EventParameters. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Event.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

EventDescription

class seiscomp.datamodel.EventDescription

Inherits Object.

Free-form string with additional event description. This can be a well-known name, like 1906 San Francisco Earthquake. A number of categories can be given in type.

Parents:

• event – Event

Attributes:

• text – string

• type – EventDescriptionType

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type EventDescription if the cast was successful, None otherwise.

Cast an arbitrary object to EventDescription if the internal wrapped representation is an EventDescription object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type EventDescription to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type EventDescriptionIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – EventDescription

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setText(text)

Parameters:

text – string

Free-form text with earthquake description.

text()

Return type:

string

setType(type)

Parameters:

type – EventDescriptionType

Category of earthquake description.

type()

Return type:

EventDescriptionType

event()

Return type:

Event

Returns the parent Event if available. Returns None if the parent is not a Event. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned EventDescription.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

EventParameters

class seiscomp.datamodel.EventParameters

Inherits PublicObject.

This type can hold objects of type Event, Origin, Magnitude, StationMagnitude, FocalMechanism, Reading, Amplitude, and Pick.

Children:

• pick – Pick

• amplitude – Amplitude

• reading – Reading

• origin – Origin

• focalMechanism – FocalMechanism

• event – Event

Attributes:

• publicID: string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type EventParameters if the cast was successful, None otherwise.

Cast an arbitrary object to EventParameters if the internal wrapped representation is an EventParameters object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type EventParameters to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

add(pick)

Parameters:

pick – Object of type Pick

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Pick object to EventParameters. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(amplitude)

Parameters:

amplitude – Object of type Amplitude

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Amplitude object to EventParameters. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(reading)

Parameters:

reading – Object of type Reading

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Reading object to EventParameters. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(origin)

Parameters:

origin – Object of type Origin

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Origin object to EventParameters. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(focalMechanism)

Parameters:

focalMechanism – Object of type FocalMechanism

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a FocalMechanism object to EventParameters. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(event)

Parameters:

event – Object of type Event

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Event object to EventParameters. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(pick)

Parameters:

pick – Object of type Pick

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Pick object from EventParameters.

remove(amplitude)

Parameters:

amplitude – Object of type Amplitude

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Amplitude object from EventParameters.

remove(reading)

Parameters:

reading – Object of type Reading

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Reading object from EventParameters.

remove(origin)

Parameters:

origin – Object of type Origin

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Origin object from EventParameters.

remove(focalMechanism)

Parameters:

focalMechanism – Object of type FocalMechanism

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added FocalMechanism object from EventParameters.

remove(event)

Parameters:

event – Object of type Event

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Event object from EventParameters.

removePick(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeAmplitude(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeReading(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeOrigin(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeFocalMechanism(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeEvent(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

pickCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Pick child objects.

amplitudeCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Amplitude child objects.

readingCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Reading child objects.

originCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Origin child objects.

focalMechanismCount()

Return type:

integer value indicating the number of child objects.

Returns the number of FocalMechanism child objects.

eventCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Event child objects.

pick(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Pick.

Returns the Pick at index idx.

amplitude(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Amplitude.

Returns the Amplitude at index idx.

reading(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Reading.

Returns the Reading at index idx.

origin(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Origin.

Returns the Origin at index idx.

focalMechanism(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type FocalMechanism.

Returns the FocalMechanism at index idx.

event(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Event.

Returns the Event at index idx.

findPick(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type Pick.

Returns the child object with a certain publicID, None otherwise.

findAmplitude(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type Amplitude.

Returns the child object with a certain publicID, None otherwise.

findReading(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type Reading.

Returns the child object with a certain publicID, None otherwise.

findOrigin(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type Origin.

Returns the child object with a certain publicID, None otherwise.

findFocalMechanism(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type FocalMechanism.

Returns the child object with a certain publicID, None otherwise.

findEvent(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type Event.

Returns the child object with a certain publicID, None otherwise.

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned EventParameters.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

FocalMechanism

class seiscomp.datamodel.FocalMechanism

Inherits PublicObject.

This class describes the focal mechanism of an event. It includes different descriptions like nodal planes, principal axes, and a moment tensor. The moment tensor description is provided by objects of the class MomentTensor which can be specified as child elements of FocalMechanism.

Parents:

• eventParameters – EventParameters

Children:

• comment – Comment

• momentTensor – MomentTensor

Attributes:

• publicID: string

• triggeringOriginID – string

• nodalPlanes – NodalPlanes (optional)

• principalAxes – PrincipalAxes (optional)

• azimuthalGap – float (optional)

• stationPolarityCount – int (optional)

• misfit – float (optional)

• stationDistributionRatio – float (optional)

• methodID – string

• evaluationMode – EvaluationMode (optional)

• evaluationStatus – EvaluationStatus (optional)

• creationInfo – CreationInfo (optional)

Referenced by:

• Event.preferredFocalMechanismID()

• FocalMechanismReference.focalMechanismID()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type FocalMechanism if the cast was successful, None otherwise.

Cast an arbitrary object to FocalMechanism if the internal wrapped representation is an FocalMechanism object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type FocalMechanism.

Creates and registers (if enabled) a FocalMechanism instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type FocalMechanism.

Creates and registers (if enabled) a FocalMechanism instance with passed publicID.

equal(other)

Parameters:

other – Another object of type FocalMechanism to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setTriggeringOriginID(triggeringOriginID)

Parameters:

triggeringOriginID – string

Refers to the publicID of the triggering origin.

triggeringOriginID()

Return type:

string

setNodalPlanes(nodalPlanes)

Parameters:

nodalPlanes – NodalPlanes

Nodal planes of the focal mechanism.

nodalPlanes()

Return type:

NodalPlanes

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setPrincipalAxes(principalAxes)

Parameters:

principalAxes – PrincipalAxes

Principal axes of the focal mechanism.

principalAxes()

Return type:

PrincipalAxes

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setAzimuthalGap(azimuthalGap)

Parameters:

azimuthalGap – float

Largest azimuthal gap in distribution of stations used for determination of focal mechanism in degrees.

azimuthalGap()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setStationPolarityCount(stationPolarityCount)

Parameters:

stationPolarityCount – int

Number of station polarities used for determination of focal mechanism.

stationPolarityCount()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setMisfit(misfit)

Parameters:

misfit – float

Fraction of misfit polarities in a first-motion focal mechanism determination. Decimal fraction between 0 and 1.

misfit()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setStationDistributionRatio(stationDistributionRatio)

Parameters:

stationDistributionRatio – float

Station distribution ratio (STDR) parameter. Indicates how the stations are distributed about the focal sphere (Reasenberg and Oppenheimer 1985). Decimal fraction between 0 and 1.

stationDistributionRatio()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setMethodID(methodID)

Parameters:

methodID – string

Resource identifier of the method used for determination of the focal mechanism.

methodID()

Return type:

string

setEvaluationMode(evaluationMode)

Parameters:

evaluationMode – EvaluationMode

Evaluation mode of FocalMechanism.

evaluationMode()

Return type:

EvaluationMode

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setEvaluationStatus(evaluationStatus)

Parameters:

evaluationStatus – EvaluationStatus

Evaluation status of FocalMechanism.

evaluationStatus()

Return type:

EvaluationStatus

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setCreationInfo(creationInfo)

Parameters:

creationInfo – CreationInfo

creationInfo()

Return type:

CreationInfo

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Comment object to FocalMechanism. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(momentTensor)

Parameters:

momentTensor – Object of type MomentTensor

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a MomentTensor object to FocalMechanism. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Comment object from FocalMechanism.

remove(momentTensor)

Parameters:

momentTensor – Object of type MomentTensor

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added MomentTensor object from FocalMechanism.

removeComment(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeComment(commentIndex);

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeMomentTensor(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

commentCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Comment child objects.

momentTensorCount()

Return type:

integer value indicating the number of child objects.

Returns the number of MomentTensor child objects.

comment(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Comment.

Returns the Comment at index idx.

comment(commentIndex)

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

Object of type Comment.

Returns the Comment at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

momentTensor(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type MomentTensor.

Returns the MomentTensor at index idx.

findMomentTensor(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type MomentTensor.

Returns the child object with a certain publicID, None otherwise.

eventParameters()

Return type:

EventParameters

Returns the parent EventParameters if available. Returns None if the parent is not a EventParameters. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned FocalMechanism.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

FocalMechanismReference

class seiscomp.datamodel.FocalMechanismReference

Inherits Object.

Parents:

• event – Event

Attributes:

• focalMechanismID – string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type FocalMechanismReference if the cast was successful, None otherwise.

Cast an arbitrary object to FocalMechanismReference if the internal wrapped representation is an FocalMechanismReference object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type FocalMechanismReference to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type FocalMechanismReferenceIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – FocalMechanismReference

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setFocalMechanismID(focalMechanismID)

Parameters:

focalMechanismID – string

focalMechanismID()

Return type:

string

event()

Return type:

Event

Returns the parent Event if available. Returns None if the parent is not a Event. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned FocalMechanismReference.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

IntegerQuantity

class seiscomp.datamodel.IntegerQuantity

Inherits Object.

Physical quantities expressed as integers are represented by their measured or computed values and optional values for symmetric or upper and lower uncertainties. The interpretation of these uncertainties is not defined in the standard. They can contain statistically well-defined error measures, but the mechanism can also be used to simply describe a possible value range. If the confidence level of the uncertainty is known, it can be listed in the optional attribute confidenceLevel. Note that uncertainty, upperUncertainty, and lowerUncertainty are given as absolute values of the deviation from the main value.

Attributes:

• value – int

• uncertainty – int (optional)

• lowerUncertainty – int (optional)

• upperUncertainty – int (optional)

• confidenceLevel – float (optional)

Used by:

• CompositeTime.year()

• CompositeTime.month()

• CompositeTime.day()

• CompositeTime.hour()

• CompositeTime.minute()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type IntegerQuantity if the cast was successful, None otherwise.

Cast an arbitrary object to IntegerQuantity if the internal wrapped representation is an IntegerQuantity object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type IntegerQuantity to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setValue(value)

Parameters:

value – int

Value of the quantity. The unit is implicitly defined and depends on the context.

value()

Return type:

int

setUncertainty(uncertainty)

Parameters:

uncertainty – int

Uncertainty as the absolute value of symmetric deviation from the main value.

uncertainty()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setLowerUncertainty(lowerUncertainty)

Parameters:

lowerUncertainty – int

Uncertainty as the absolute value of deviation from the main value towards smaller values.

lowerUncertainty()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setUpperUncertainty(upperUncertainty)

Parameters:

upperUncertainty – int

Uncertainty as the absolute value of deviation from the main value towards larger values.

upperUncertainty()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setConfidenceLevel(confidenceLevel)

Parameters:

confidenceLevel – float

Confidence level of the uncertainty, given in percent.

confidenceLevel()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

Inventory

class seiscomp.datamodel.Inventory

Inherits PublicObject.

Children:

• stationGroup – StationGroup

• auxDevice – AuxDevice

• sensor – Sensor

• datalogger – Datalogger

• responsePAZ – ResponsePAZ

• responseFIR – ResponseFIR

• responseIIR – ResponseIIR

• responsePolynomial – ResponsePolynomial

• responseFAP – ResponseFAP

• network – Network

Attributes:

• publicID: string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Inventory if the cast was successful, None otherwise.

Cast an arbitrary object to Inventory if the internal wrapped representation is an Inventory object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type Inventory to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

add(stationGroup)

Parameters:

stationGroup – Object of type StationGroup

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a StationGroup object to Inventory. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(auxDevice)

Parameters:

auxDevice – Object of type AuxDevice

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a AuxDevice object to Inventory. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(sensor)

Parameters:

sensor – Object of type Sensor

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Sensor object to Inventory. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(datalogger)

Parameters:

datalogger – Object of type Datalogger

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Datalogger object to Inventory. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(responsePAZ)

Parameters:

responsePAZ – Object of type ResponsePAZ

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a ResponsePAZ object to Inventory. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(responseFIR)

Parameters:

responseFIR – Object of type ResponseFIR

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a ResponseFIR object to Inventory. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(responseIIR)

Parameters:

responseIIR – Object of type ResponseIIR

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a ResponseIIR object to Inventory. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(responsePolynomial)

Parameters:

responsePolynomial – Object of type ResponsePolynomial

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a ResponsePolynomial object to Inventory. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(responseFAP)

Parameters:

responseFAP – Object of type ResponseFAP

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a ResponseFAP object to Inventory. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(network)

Parameters:

network – Object of type Network

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Network object to Inventory. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(stationGroup)

Parameters:

stationGroup – Object of type StationGroup

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added StationGroup object from Inventory.

remove(auxDevice)

Parameters:

auxDevice – Object of type AuxDevice

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added AuxDevice object from Inventory.

remove(sensor)

Parameters:

sensor – Object of type Sensor

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Sensor object from Inventory.

remove(datalogger)

Parameters:

datalogger – Object of type Datalogger

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Datalogger object from Inventory.

remove(responsePAZ)

Parameters:

responsePAZ – Object of type ResponsePAZ

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added ResponsePAZ object from Inventory.

remove(responseFIR)

Parameters:

responseFIR – Object of type ResponseFIR

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added ResponseFIR object from Inventory.

remove(responseIIR)

Parameters:

responseIIR – Object of type ResponseIIR

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added ResponseIIR object from Inventory.

remove(responsePolynomial)

Parameters:

responsePolynomial – Object of type ResponsePolynomial

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added ResponsePolynomial object from Inventory.

remove(responseFAP)

Parameters:

responseFAP – Object of type ResponseFAP

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added ResponseFAP object from Inventory.

remove(network)

Parameters:

network – Object of type Network

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Network object from Inventory.

removeStationGroup(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeStationGroup(stationGroupIndex);

Parameters:

stationGroupIndex – The index of the object to be removed of type StationGroupIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeAuxDevice(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeAuxDevice(auxDeviceIndex);

Parameters:

auxDeviceIndex – The index of the object to be removed of type AuxDeviceIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeSensor(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeSensor(sensorIndex);

Parameters:

sensorIndex – The index of the object to be removed of type SensorIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeDatalogger(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeDatalogger(dataloggerIndex);

Parameters:

dataloggerIndex – The index of the object to be removed of type DataloggerIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeResponsePAZ(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeResponsePAZ(responsePAZIndex);

Parameters:

responsePAZIndex – The index of the object to be removed of type ResponsePAZIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeResponseFIR(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeResponseFIR(responseFIRIndex);

Parameters:

responseFIRIndex – The index of the object to be removed of type ResponseFIRIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeResponseIIR(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeResponseIIR(responseIIRIndex);

Parameters:

responseIIRIndex – The index of the object to be removed of type ResponseIIRIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeResponsePolynomial(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeResponsePolynomial(responsePolynomialIndex);

Parameters:

responsePolynomialIndex – The index of the object to be removed of type ResponsePolynomialIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeResponseFAP(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeResponseFAP(responseFAPIndex);

Parameters:

responseFAPIndex – The index of the object to be removed of type ResponseFAPIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeNetwork(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeNetwork(networkIndex);

Parameters:

networkIndex – The index of the object to be removed of type NetworkIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

stationGroupCount()

Return type:

integer value indicating the number of child objects.

Returns the number of StationGroup child objects.

auxDeviceCount()

Return type:

integer value indicating the number of child objects.

Returns the number of AuxDevice child objects.

sensorCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Sensor child objects.

dataloggerCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Datalogger child objects.

responsePAZCount()

Return type:

integer value indicating the number of child objects.

Returns the number of ResponsePAZ child objects.

responseFIRCount()

Return type:

integer value indicating the number of child objects.

Returns the number of ResponseFIR child objects.

responseIIRCount()

Return type:

integer value indicating the number of child objects.

Returns the number of ResponseIIR child objects.

responsePolynomialCount()

Return type:

integer value indicating the number of child objects.

Returns the number of ResponsePolynomial child objects.

responseFAPCount()

Return type:

integer value indicating the number of child objects.

Returns the number of ResponseFAP child objects.

networkCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Network child objects.

stationGroup(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type StationGroup.

Returns the StationGroup at index idx.

stationGroup(stationGroupIndex)

Parameters:

stationGroupIndex – The index of the object to be removed of type StationGroupIndex.

Return type:

Object of type StationGroup.

Returns the StationGroup at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

auxDevice(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type AuxDevice.

Returns the AuxDevice at index idx.

auxDevice(auxDeviceIndex)

Parameters:

auxDeviceIndex – The index of the object to be removed of type AuxDeviceIndex.

Return type:

Object of type AuxDevice.

Returns the AuxDevice at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

sensor(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Sensor.

Returns the Sensor at index idx.

sensor(sensorIndex)

Parameters:

sensorIndex – The index of the object to be removed of type SensorIndex.

Return type:

Object of type Sensor.

Returns the Sensor at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

datalogger(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Datalogger.

Returns the Datalogger at index idx.

datalogger(dataloggerIndex)

Parameters:

dataloggerIndex – The index of the object to be removed of type DataloggerIndex.

Return type:

Object of type Datalogger.

Returns the Datalogger at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

responsePAZ(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type ResponsePAZ.

Returns the ResponsePAZ at index idx.

responsePAZ(responsePAZIndex)

Parameters:

responsePAZIndex – The index of the object to be removed of type ResponsePAZIndex.

Return type:

Object of type ResponsePAZ.

Returns the ResponsePAZ at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

responseFIR(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type ResponseFIR.

Returns the ResponseFIR at index idx.

responseFIR(responseFIRIndex)

Parameters:

responseFIRIndex – The index of the object to be removed of type ResponseFIRIndex.

Return type:

Object of type ResponseFIR.

Returns the ResponseFIR at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

responseIIR(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type ResponseIIR.

Returns the ResponseIIR at index idx.

responseIIR(responseIIRIndex)

Parameters:

responseIIRIndex – The index of the object to be removed of type ResponseIIRIndex.

Return type:

Object of type ResponseIIR.

Returns the ResponseIIR at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

responsePolynomial(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type ResponsePolynomial.

Returns the ResponsePolynomial at index idx.

responsePolynomial(responsePolynomialIndex)

Parameters:

responsePolynomialIndex – The index of the object to be removed of type ResponsePolynomialIndex.

Return type:

Object of type ResponsePolynomial.

Returns the ResponsePolynomial at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

responseFAP(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type ResponseFAP.

Returns the ResponseFAP at index idx.

responseFAP(responseFAPIndex)

Parameters:

responseFAPIndex – The index of the object to be removed of type ResponseFAPIndex.

Return type:

Object of type ResponseFAP.

Returns the ResponseFAP at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

network(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Network.

Returns the Network at index idx.

network(networkIndex)

Parameters:

networkIndex – The index of the object to be removed of type NetworkIndex.

Return type:

Object of type Network.

Returns the Network at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

findStationGroup(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type StationGroup.

Returns the child object with a certain publicID, None otherwise.

findAuxDevice(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type AuxDevice.

Returns the child object with a certain publicID, None otherwise.

findSensor(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type Sensor.

Returns the child object with a certain publicID, None otherwise.

findDatalogger(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type Datalogger.

Returns the child object with a certain publicID, None otherwise.

findResponsePAZ(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type ResponsePAZ.

Returns the child object with a certain publicID, None otherwise.

findResponseFIR(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type ResponseFIR.

Returns the child object with a certain publicID, None otherwise.

findResponseIIR(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type ResponseIIR.

Returns the child object with a certain publicID, None otherwise.

findResponsePolynomial(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type ResponsePolynomial.

Returns the child object with a certain publicID, None otherwise.

findResponseFAP(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type ResponseFAP.

Returns the child object with a certain publicID, None otherwise.

findNetwork(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type Network.

Returns the child object with a certain publicID, None otherwise.

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Inventory.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

JournalEntry

class seiscomp.datamodel.JournalEntry

Inherits Object.

Parents:

• journaling – Journaling

Attributes:

• created – seiscomp.core.Time (optional)

• objectID – string

• sender – string

• action – string

• parameters – string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type JournalEntry if the cast was successful, None otherwise.

Cast an arbitrary object to JournalEntry if the internal wrapped representation is an JournalEntry object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type JournalEntry to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setCreated(created)

Parameters:

created – seiscomp.core.Time

created()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setObjectID(objectID)

Parameters:

objectID – string

objectID()

Return type:

string

setSender(sender)

Parameters:

sender – string

sender()

Return type:

string

setAction(action)

Parameters:

action – string

action()

Return type:

string

setParameters(parameters)

Parameters:

parameters – string

parameters()

Return type:

string

journaling()

Return type:

Journaling

Returns the parent Journaling if available. Returns None if the parent is not a Journaling. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned JournalEntry.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Journaling

class seiscomp.datamodel.Journaling

Inherits PublicObject.

Children:

• journalEntry – JournalEntry

Attributes:

• publicID: string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Journaling if the cast was successful, None otherwise.

Cast an arbitrary object to Journaling if the internal wrapped representation is an Journaling object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type Journaling to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

add(journalEntry)

Parameters:

journalEntry – Object of type JournalEntry

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a JournalEntry object to Journaling. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(journalEntry)

Parameters:

journalEntry – Object of type JournalEntry

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added JournalEntry object from Journaling.

removeJournalEntry(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

journalEntryCount()

Return type:

integer value indicating the number of child objects.

Returns the number of JournalEntry child objects.

journalEntry(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type JournalEntry.

Returns the JournalEntry at index idx.

findJournalEntry(journalEntry)

Parameters:

journalEntry – Reference object of type JournalEntry.

Return type:

Object of type JournalEntry.

Returns the child object with equals the passed object, None otherwise.

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Journaling.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Magnitude

class seiscomp.datamodel.Magnitude

Inherits PublicObject.

Describes a magnitude which can, but does not need to be associated with an origin. Association with an origin is expressed with the optional attribute originID. It is either a combination of different magnitude estimations, or it represents the reported magnitude for the given event.

Parents:

• origin – Origin

Children:

• comment – Comment

• stationMagnitudeContribution – StationMagnitudeContribution

Attributes:

• publicID: string

• magnitude – RealQuantity

• type – string

• originID – string

• methodID – string

• stationCount – int (optional)

• azimuthalGap – float (optional)

• evaluationStatus – EvaluationStatus (optional)

• creationInfo – CreationInfo (optional)

Referenced by:

• Event.preferredMagnitudeID()

• MomentTensor.momentMagnitudeID()

• StationMagnitudeContribution.stationMagnitudeID()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Magnitude if the cast was successful, None otherwise.

Cast an arbitrary object to Magnitude if the internal wrapped representation is an Magnitude object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type Magnitude.

Creates and registers (if enabled) a Magnitude instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type Magnitude.

Creates and registers (if enabled) a Magnitude instance with passed publicID.

equal(other)

Parameters:

other – Another object of type Magnitude to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setMagnitude(magnitude)

Parameters:

magnitude – RealQuantity

Resulting magnitude value from combining values of type StationMagnitude. If no estimations are available, this value can represent the reported magnitude.

magnitude()

Return type:

RealQuantity

setType(type)

Parameters:

type – string

Describes the type of magnitude. This is a free-text field because it is impossible to cover all existing magnitude type designations with an enumeration. Possible values are unspecified magnitude (M), local magnitude (ML), body wave magnitude (Mb), surface wave magnitude (MS), moment magnitude (Mw), duration magnitude (Md), coda magnitude (Mc), MH, Mwp, M50, M100, etc.

type()

Return type:

string

setOriginID(originID)

Parameters:

originID – string

Reference to an origin’s publicID if the magnitude has an associated Origin.

originID()

Return type:

string

setMethodID(methodID)

Parameters:

methodID – string

Identifies the method of magnitude estimation. Users should avoid to give contradictory information in methodID and type.

methodID()

Return type:

string

setStationCount(stationCount)

Parameters:

stationCount – int

Number of used stations for this magnitude computation.

stationCount()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setAzimuthalGap(azimuthalGap)

Parameters:

azimuthalGap – float

Azimuthal gap for this magnitude computation in degrees.

azimuthalGap()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setEvaluationStatus(evaluationStatus)

Parameters:

evaluationStatus – EvaluationStatus

Evaluation status of Magnitude.

evaluationStatus()

Return type:

EvaluationStatus

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setCreationInfo(creationInfo)

Parameters:

creationInfo – CreationInfo

CreationInfo for the Magnitude object.

creationInfo()

Return type:

CreationInfo

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Comment object to Magnitude. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(stationMagnitudeContribution)

Parameters:

stationMagnitudeContribution – Object of type StationMagnitudeContribution

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a StationMagnitudeContribution object to Magnitude. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Comment object from Magnitude.

remove(stationMagnitudeContribution)

Parameters:

stationMagnitudeContribution – Object of type StationMagnitudeContribution

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added StationMagnitudeContribution object from Magnitude.

removeComment(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeComment(commentIndex);

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeStationMagnitudeContribution(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeStationMagnitudeContribution(stationMagnitudeContributionIndex);

Parameters:

stationMagnitudeContributionIndex – The index of the object to be removed of type StationMagnitudeContributionIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

commentCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Comment child objects.

stationMagnitudeContributionCount()

Return type:

integer value indicating the number of child objects.

Returns the number of StationMagnitudeContribution child objects.

comment(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Comment.

Returns the Comment at index idx.

comment(commentIndex)

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

Object of type Comment.

Returns the Comment at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

stationMagnitudeContribution(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type StationMagnitudeContribution.

Returns the StationMagnitudeContribution at index idx.

stationMagnitudeContribution(stationMagnitudeContributionIndex)

Parameters:

stationMagnitudeContributionIndex – The index of the object to be removed of type StationMagnitudeContributionIndex.

Return type:

Object of type StationMagnitudeContribution.

Returns the StationMagnitudeContribution at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

origin()

Return type:

Origin

Returns the parent Origin if available. Returns None if the parent is not a Origin. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Magnitude.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

MomentTensor

class seiscomp.datamodel.MomentTensor

Inherits PublicObject.

This class represents a moment tensor solution for an event. It is an optional part of a FocalMechanism description.

Parents:

• focalMechanism – FocalMechanism

Children:

• comment – Comment

• dataUsed – DataUsed

• momentTensorPhaseSetting – MomentTensorPhaseSetting

• momentTensorStationContribution – MomentTensorStationContribution

Attributes:

• publicID: string

• derivedOriginID – string

• momentMagnitudeID – string

• scalarMoment – RealQuantity (optional)

• tensor – Tensor (optional)

• variance – float (optional)

• varianceReduction – float (optional)

• doubleCouple – float (optional)

• clvd – float (optional)

• iso – float (optional)

• greensFunctionID – string

• filterID – string

• sourceTimeFunction – SourceTimeFunction (optional)

• methodID – string

• method – MomentTensorMethod (optional)

• status – MomentTensorStatus (optional)

• cmtName – string

• cmtVersion – string

• creationInfo – CreationInfo (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type MomentTensor if the cast was successful, None otherwise.

Cast an arbitrary object to MomentTensor if the internal wrapped representation is an MomentTensor object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type MomentTensor.

Creates and registers (if enabled) a MomentTensor instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type MomentTensor.

Creates and registers (if enabled) a MomentTensor instance with passed publicID.

equal(other)

Parameters:

other – Another object of type MomentTensor to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setDerivedOriginID(derivedOriginID)

Parameters:

derivedOriginID – string

Refers to the publicID of the Origin derived in the moment tensor inversion.

derivedOriginID()

Return type:

string

setMomentMagnitudeID(momentMagnitudeID)

Parameters:

momentMagnitudeID – string

Refers to the publicID of the Magnitude object which represents the derived moment magnitude.

momentMagnitudeID()

Return type:

string

setScalarMoment(scalarMoment)

Parameters:

scalarMoment – RealQuantity

Scalar moment as derived in moment tensor inversion in Nm.

scalarMoment()

Return type:

RealQuantity

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setTensor(tensor)

Parameters:

tensor – Tensor

Tensor object holding the moment tensor elements.

tensor()

Return type:

Tensor

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setVariance(variance)

Parameters:

variance – float

Variance of moment tensor inversion.

variance()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setVarianceReduction(varianceReduction)

Parameters:

varianceReduction – float

Variance reduction of moment tensor inversion, given in percent (Dreger 2003). This is a goodness-of-fit measure.

varianceReduction()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDoubleCouple(doubleCouple)

Parameters:

doubleCouple – float

Double couple parameter obtained from moment tensor inversion (decimal fraction between 0 and 1).

doubleCouple()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setClvd(clvd)

Parameters:

clvd – float

CLVD (compensated linear vector dipole) parameter obtained from moment tensor inversion (decimal fraction between 0 and 1).

clvd()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setIso(iso)

Parameters:

iso – float

Isotropic part obtained from moment tensor inversion (decimal fraction between 0 and 1).

iso()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setGreensFunctionID(greensFunctionID)

Parameters:

greensFunctionID – string

Resource identifier of the Green’s function used in moment tensor inversion.

greensFunctionID()

Return type:

string

setFilterID(filterID)

Parameters:

filterID – string

Resource identifier of the filter setup used in moment tensor inversion.

filterID()

Return type:

string

setSourceTimeFunction(sourceTimeFunction)

Parameters:

sourceTimeFunction – SourceTimeFunction

Source time function used in moment-tensor inversion.

sourceTimeFunction()

Return type:

SourceTimeFunction

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setMethodID(methodID)

Parameters:

methodID – string

Resource identifier of the method used for moment-tensor inversion.

methodID()

Return type:

string

setMethod(method)

Parameters:

method – MomentTensorMethod

Moment tensor method used.

method()

Return type:

MomentTensorMethod

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setStatus(status)

Parameters:

status – MomentTensorStatus

Status of moment tensor.

status()

Return type:

MomentTensorStatus

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setCmtName(cmtName)

Parameters:

cmtName – string

cmtName()

Return type:

string

setCmtVersion(cmtVersion)

Parameters:

cmtVersion – string

cmtVersion()

Return type:

string

setCreationInfo(creationInfo)

Parameters:

creationInfo – CreationInfo

CreationInfo for the MomentTensor object.

creationInfo()

Return type:

CreationInfo

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Comment object to MomentTensor. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(dataUsed)

Parameters:

dataUsed – Object of type DataUsed

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a DataUsed object to MomentTensor. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(momentTensorPhaseSetting)

Parameters:

momentTensorPhaseSetting – Object of type MomentTensorPhaseSetting

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a MomentTensorPhaseSetting object to MomentTensor. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(momentTensorStationContribution)

Parameters:

momentTensorStationContribution – Object of type MomentTensorStationContribution

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a MomentTensorStationContribution object to MomentTensor. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Comment object from MomentTensor.

remove(dataUsed)

Parameters:

dataUsed – Object of type DataUsed

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added DataUsed object from MomentTensor.

remove(momentTensorPhaseSetting)

Parameters:

momentTensorPhaseSetting – Object of type MomentTensorPhaseSetting

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added MomentTensorPhaseSetting object from MomentTensor.

remove(momentTensorStationContribution)

Parameters:

momentTensorStationContribution – Object of type MomentTensorStationContribution

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added MomentTensorStationContribution object from MomentTensor.

removeComment(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeComment(commentIndex);

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeDataUsed(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeMomentTensorPhaseSetting(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeMomentTensorPhaseSetting(momentTensorPhaseSettingIndex);

Parameters:

momentTensorPhaseSettingIndex – The index of the object to be removed of type MomentTensorPhaseSettingIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeMomentTensorStationContribution(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

commentCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Comment child objects.

dataUsedCount()

Return type:

integer value indicating the number of child objects.

Returns the number of DataUsed child objects.

momentTensorPhaseSettingCount()

Return type:

integer value indicating the number of child objects.

Returns the number of MomentTensorPhaseSetting child objects.

momentTensorStationContributionCount()

Return type:

integer value indicating the number of child objects.

Returns the number of MomentTensorStationContribution child objects.

comment(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Comment.

Returns the Comment at index idx.

comment(commentIndex)

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

Object of type Comment.

Returns the Comment at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

dataUsed(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type DataUsed.

Returns the DataUsed at index idx.

momentTensorPhaseSetting(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type MomentTensorPhaseSetting.

Returns the MomentTensorPhaseSetting at index idx.

momentTensorPhaseSetting(momentTensorPhaseSettingIndex)

Parameters:

momentTensorPhaseSettingIndex – The index of the object to be removed of type MomentTensorPhaseSettingIndex.

Return type:

Object of type MomentTensorPhaseSetting.

Returns the MomentTensorPhaseSetting at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

momentTensorStationContribution(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type MomentTensorStationContribution.

Returns the MomentTensorStationContribution at index idx.

findDataUsed(dataUsed)

Parameters:

dataUsed – Reference object of type DataUsed.

Return type:

Object of type DataUsed.

Returns the child object with equals the passed object, None otherwise.

findMomentTensorStationContribution(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type MomentTensorStationContribution.

Returns the child object with a certain publicID, None otherwise.

focalMechanism()

Return type:

FocalMechanism

Returns the parent FocalMechanism if available. Returns None if the parent is not a FocalMechanism. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned MomentTensor.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

MomentTensorComponentContribution

class seiscomp.datamodel.MomentTensorComponentContribution

Inherits Object.

Parents:

• momentTensorStationContribution – MomentTensorStationContribution

Attributes:

• phaseCode – string

• component – int

• active – boolean

• weight – float

• timeShift – float

• dataTimeWindow – float

• misfit – float (optional)

• snr – float (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type MomentTensorComponentContribution if the cast was successful, None otherwise.

Cast an arbitrary object to MomentTensorComponentContribution if the internal wrapped representation is an MomentTensorComponentContribution object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type MomentTensorComponentContribution to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type MomentTensorComponentContributionIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – MomentTensorComponentContribution

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setPhaseCode(phaseCode)

Parameters:

phaseCode – string

phaseCode()

Return type:

string

setComponent(component)

Parameters:

component – int

component()

Return type:

int

setActive(active)

Parameters:

active – boolean

active()

Return type:

boolean

setWeight(weight)

Parameters:

weight – float

weight()

Return type:

float

setTimeShift(timeShift)

Parameters:

timeShift – float

timeShift()

Return type:

float

setDataTimeWindow(dataTimeWindow)

Parameters:

dataTimeWindow – float

dataTimeWindow()

Return type:

float

setMisfit(misfit)

Parameters:

misfit – float

misfit()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setSnr(snr)

Parameters:

snr – float

snr()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

momentTensorStationContribution()

Return type:

MomentTensorStationContribution

Returns the parent MomentTensorStationContribution if available. Returns None if the parent is not a MomentTensorStationContribution. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned MomentTensorComponentContribution.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

MomentTensorPhaseSetting

class seiscomp.datamodel.MomentTensorPhaseSetting

Inherits Object.

Parents:

• momentTensor – MomentTensor

Attributes:

• code – string

• lowerPeriod – float

• upperPeriod – float

• minimumSNR – float (optional)

• maximumTimeShift – float (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type MomentTensorPhaseSetting if the cast was successful, None otherwise.

Cast an arbitrary object to MomentTensorPhaseSetting if the internal wrapped representation is an MomentTensorPhaseSetting object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type MomentTensorPhaseSetting to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type MomentTensorPhaseSettingIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – MomentTensorPhaseSetting

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setCode(code)

Parameters:

code – string

code()

Return type:

string

setLowerPeriod(lowerPeriod)

Parameters:

lowerPeriod – float

lowerPeriod()

Return type:

float

setUpperPeriod(upperPeriod)

Parameters:

upperPeriod – float

upperPeriod()

Return type:

float

setMinimumSNR(minimumSNR)

Parameters:

minimumSNR – float

minimumSNR()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setMaximumTimeShift(maximumTimeShift)

Parameters:

maximumTimeShift – float

maximumTimeShift()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

momentTensor()

Return type:

MomentTensor

Returns the parent MomentTensor if available. Returns None if the parent is not a MomentTensor. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned MomentTensorPhaseSetting.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

MomentTensorStationContribution

class seiscomp.datamodel.MomentTensorStationContribution

Inherits PublicObject.

Parents:

• momentTensor – MomentTensor

Children:

• momentTensorComponentContribution – MomentTensorComponentContribution

Attributes:

• publicID: string

• active – boolean

• waveformID – WaveformStreamID (optional)

• weight – float (optional)

• timeShift – float (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type MomentTensorStationContribution if the cast was successful, None otherwise.

Cast an arbitrary object to MomentTensorStationContribution if the internal wrapped representation is an MomentTensorStationContribution object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type MomentTensorStationContribution.

Creates and registers (if enabled) a MomentTensorStationContribution instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type MomentTensorStationContribution.

Creates and registers (if enabled) a MomentTensorStationContribution instance with passed publicID.

equal(other)

Parameters:

other – Another object of type MomentTensorStationContribution to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setActive(active)

Parameters:

active – boolean

active()

Return type:

boolean

setWaveformID(waveformID)

Parameters:

waveformID – WaveformStreamID

waveformID()

Return type:

WaveformStreamID

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setWeight(weight)

Parameters:

weight – float

weight()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setTimeShift(timeShift)

Parameters:

timeShift – float

timeShift()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(momentTensorComponentContribution)

Parameters:

momentTensorComponentContribution – Object of type MomentTensorComponentContribution

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a MomentTensorComponentContribution object to MomentTensorStationContribution. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(momentTensorComponentContribution)

Parameters:

momentTensorComponentContribution – Object of type MomentTensorComponentContribution

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added MomentTensorComponentContribution object from MomentTensorStationContribution.

removeMomentTensorComponentContribution(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeMomentTensorComponentContribution(momentTensorComponentContributionIndex);

Parameters:

momentTensorComponentContributionIndex – The index of the object to be removed of type MomentTensorComponentContributionIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

momentTensorComponentContributionCount()

Return type:

integer value indicating the number of child objects.

Returns the number of MomentTensorComponentContribution child objects.

momentTensorComponentContribution(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type MomentTensorComponentContribution.

Returns the MomentTensorComponentContribution at index idx.

momentTensorComponentContribution(momentTensorComponentContributionIndex)

Parameters:

momentTensorComponentContributionIndex – The index of the object to be removed of type MomentTensorComponentContributionIndex.

Return type:

Object of type MomentTensorComponentContribution.

Returns the MomentTensorComponentContribution at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

momentTensor()

Return type:

MomentTensor

Returns the parent MomentTensor if available. Returns None if the parent is not a MomentTensor. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned MomentTensorStationContribution.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Network

class seiscomp.datamodel.Network

Inherits PublicObject.

This type describes a network of seismic stations

Parents:

• inventory – Inventory

Children:

• comment – Comment

• station – Station

Attributes:

• publicID: string

• code – string

• start – seiscomp.core.Time

• end – seiscomp.core.Time (optional)

• description – string

• institutions – string

• region – string

• type – string

• netClass – string

• archive – string

• restricted – boolean (optional)

• shared – boolean (optional)

• remark – Blob (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Network if the cast was successful, None otherwise.

Cast an arbitrary object to Network if the internal wrapped representation is an Network object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type Network.

Creates and registers (if enabled) a Network instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type Network.

Creates and registers (if enabled) a Network instance with passed publicID.

equal(other)

Parameters:

other – Another object of type Network to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type NetworkIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – Network

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setCode(code)

Parameters:

code – string

Network code (50.16)

code()

Return type:

string

setStart(start)

Parameters:

start – seiscomp.core.Time

Start of network epoch in ISO datetime format. Needed primarily to identifytemorary networks that re-use network codes

start()

Return type:

seiscomp.core.Time

setEnd(end)

Parameters:

end – seiscomp.core.Time

End of station epoch. Empty string if the station is open

end()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDescription(description)

Parameters:

description – string

Network description (50.10)

description()

Return type:

string

setInstitutions(institutions)

Parameters:

institutions – string

Institution(s) operating the network

institutions()

Return type:

string

setRegion(region)

Parameters:

region – string

Region of the network (eg., euromed, global)

region()

Return type:

string

setType(type)

Parameters:

type – string

Type of the network (eg., VBB, SP)

type()

Return type:

string

setNetClass(netClass)

Parameters:

netClass – string

‘;p’; for permanent, ‘;t’; for temporary

netClass()

Return type:

string

setArchive(archive)

Parameters:

archive – string

Archive/Datacenter ID (metadata authority)

archive()

Return type:

string

setRestricted(restricted)

Parameters:

restricted – boolean

Whether the network is "restricted"

restricted()

Return type:

boolean

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setShared(shared)

Parameters:

shared – boolean

Whether the metadata is synchronized with other datacenters

shared()

Return type:

boolean

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setRemark(remark)

Parameters:

remark – Blob

Any notes

remark()

Return type:

Blob

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Comment object to Network. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(station)

Parameters:

station – Object of type Station

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Station object to Network. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Comment object from Network.

remove(station)

Parameters:

station – Object of type Station

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Station object from Network.

removeComment(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeComment(commentIndex);

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeStation(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeStation(stationIndex);

Parameters:

stationIndex – The index of the object to be removed of type StationIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

commentCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Comment child objects.

stationCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Station child objects.

comment(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Comment.

Returns the Comment at index idx.

comment(commentIndex)

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

Object of type Comment.

Returns the Comment at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

station(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Station.

Returns the Station at index idx.

station(stationIndex)

Parameters:

stationIndex – The index of the object to be removed of type StationIndex.

Return type:

Object of type Station.

Returns the Station at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

findStation(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type Station.

Returns the child object with a certain publicID, None otherwise.

inventory()

Return type:

Inventory

Returns the parent Inventory if available. Returns None if the parent is not a Inventory. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Network.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

NodalPlane

class seiscomp.datamodel.NodalPlane

Inherits Object.

This class describes a nodal plane using the attributes strike, dip, and rake. For a definition of the angles see Aki and Richards (1980).

Attributes:

• strike – RealQuantity

• dip – RealQuantity

• rake – RealQuantity

Used by:

• NodalPlanes.nodalPlane1()

• NodalPlanes.nodalPlane2()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type NodalPlane if the cast was successful, None otherwise.

Cast an arbitrary object to NodalPlane if the internal wrapped representation is an NodalPlane object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type NodalPlane to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setStrike(strike)

Parameters:

strike – RealQuantity

Strike angle of nodal plane in degrees.

strike()

Return type:

RealQuantity

setDip(dip)

Parameters:

dip – RealQuantity

Dip angle of nodal plane in degrees.

dip()

Return type:

RealQuantity

setRake(rake)

Parameters:

rake – RealQuantity

Rake angle of nodal plane in degrees.

rake()

Return type:

RealQuantity

NodalPlanes

class seiscomp.datamodel.NodalPlanes

Inherits Object.

This class describes the nodal planes of a double-couple moment-tensor solution. The attribute preferredPlane can be used to define which plane is the preferred one.

Attributes:

• nodalPlane1 – NodalPlane (optional)

• nodalPlane2 – NodalPlane (optional)

• preferredPlane – int (optional)

Used by:

• FocalMechanism.nodalPlanes()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type NodalPlanes if the cast was successful, None otherwise.

Cast an arbitrary object to NodalPlanes if the internal wrapped representation is an NodalPlanes object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type NodalPlanes to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setNodalPlane1(nodalPlane1)

Parameters:

nodalPlane1 – NodalPlane

First nodal plane of double-couple moment tensor solution.

nodalPlane1()

Return type:

NodalPlane

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setNodalPlane2(nodalPlane2)

Parameters:

nodalPlane2 – NodalPlane

Second nodal plane of double-couple moment tensor solution.

nodalPlane2()

Return type:

NodalPlane

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setPreferredPlane(preferredPlane)

Parameters:

preferredPlane – int

Indicator for preferred nodal plane of moment tensor solution. It can take integer values 1 or 2.

preferredPlane()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

Origin

class seiscomp.datamodel.Origin

Inherits PublicObject.

This class represents the focal time and geographical location of an earthquake hypocenter, as well as additional meta-information. Origin can have objects of type OriginUncertainty and Arrival as child elements.

Parents:

• eventParameters – EventParameters

Children:

• comment – Comment

• compositeTime – CompositeTime

• arrival – Arrival

• stationMagnitude – StationMagnitude

• magnitude – Magnitude

Attributes:

• publicID: string

• time – TimeQuantity

• latitude – RealQuantity

• longitude – RealQuantity

• depth – RealQuantity (optional)

• depthType – OriginDepthType (optional)

• timeFixed – boolean (optional)

• epicenterFixed – boolean (optional)

• referenceSystemID – string

• methodID – string

• earthModelID – string

• quality – OriginQuality (optional)

• uncertainty – OriginUncertainty (optional)

• type – OriginType (optional)

• evaluationMode – EvaluationMode (optional)

• evaluationStatus – EvaluationStatus (optional)

• creationInfo – CreationInfo (optional)

Referenced by:

• Event.preferredOriginID()

• FocalMechanism.triggeringOriginID()

• Magnitude.originID()

• MomentTensor.derivedOriginID()

• OriginReference.originID()

• StationMagnitude.originID()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Origin if the cast was successful, None otherwise.

Cast an arbitrary object to Origin if the internal wrapped representation is an Origin object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type Origin.

Creates and registers (if enabled) a Origin instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type Origin.

Creates and registers (if enabled) a Origin instance with passed publicID.

equal(other)

Parameters:

other – Another object of type Origin to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setTime(time)

Parameters:

time – TimeQuantity

Focal time as TimeQuantity.

time()

Return type:

TimeQuantity

setLatitude(latitude)

Parameters:

latitude – RealQuantity

Hypocenter latitude with respect to the World Geodetic System 1984 (WGS84) reference system (National Imagery and Mapping Agency 2000) in degrees. Uncertainties are given in kilometers.

latitude()

Return type:

RealQuantity

setLongitude(longitude)

Parameters:

longitude – RealQuantity

Hypocenter longitude with respect to the World Geodetic System 1984 (WGS84) reference system (National Imagery and Mapping Agency 2000) in degrees. Uncertainties are given in kilometers.

longitude()

Return type:

RealQuantity

setDepth(depth)

Parameters:

depth – RealQuantity

Depth of hypocenter with respect to the nominal sea level given by the WGS84 geoid (Earth Gravitational Model, EGM96, Lemoine et al. 1998). Positive values indicate hypocenters below sea level. For shallow hypocenters, the depth value can be negative. The depth is defined in km.

depth()

Return type:

RealQuantity

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDepthType(depthType)

Parameters:

depthType – OriginDepthType

Type of depth determination.

depthType()

Return type:

OriginDepthType

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setTimeFixed(timeFixed)

Parameters:

timeFixed – boolean

Boolean flag. True if focal time was kept fixed for computation of the Origin.

timeFixed()

Return type:

boolean

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setEpicenterFixed(epicenterFixed)

Parameters:

epicenterFixed – boolean

Boolean flag. True if epicenter was kept fixed for computation of Origin.

epicenterFixed()

Return type:

boolean

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setReferenceSystemID(referenceSystemID)

Parameters:

referenceSystemID – string

Identifies the reference system used for hypocenter determination. This is only necessary if a modified version of the standard (with local extensions) is used that provides a non-standard coordinate system.

referenceSystemID()

Return type:

string

setMethodID(methodID)

Parameters:

methodID – string

Identifies the method used for locating the event.

methodID()

Return type:

string

setEarthModelID(earthModelID)

Parameters:

earthModelID – string

Identifies the earth model used in methodID.

earthModelID()

Return type:

string

setQuality(quality)

Parameters:

quality – OriginQuality

Additional parameters describing the quality of an Origin determination.

quality()

Return type:

OriginQuality

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setUncertainty(uncertainty)

Parameters:

uncertainty – OriginUncertainty

Additional parameters describing the uncertainty of an Origin determination.

uncertainty()

Return type:

OriginUncertainty

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setType(type)

Parameters:

type – OriginType

Describes the Origin type.

type()

Return type:

OriginType

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setEvaluationMode(evaluationMode)

Parameters:

evaluationMode – EvaluationMode

Evaluation mode of Origin.

evaluationMode()

Return type:

EvaluationMode

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setEvaluationStatus(evaluationStatus)

Parameters:

evaluationStatus – EvaluationStatus

Evaluation status of Origin.

evaluationStatus()

Return type:

EvaluationStatus

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setCreationInfo(creationInfo)

Parameters:

creationInfo – CreationInfo

CreationInfo for the Origin object.

creationInfo()

Return type:

CreationInfo

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Comment object to Origin. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(compositeTime)

Parameters:

compositeTime – Object of type CompositeTime

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a CompositeTime object to Origin. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(arrival)

Parameters:

arrival – Object of type Arrival

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Arrival object to Origin. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(stationMagnitude)

Parameters:

stationMagnitude – Object of type StationMagnitude

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a StationMagnitude object to Origin. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(magnitude)

Parameters:

magnitude – Object of type Magnitude

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Magnitude object to Origin. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Comment object from Origin.

remove(compositeTime)

Parameters:

compositeTime – Object of type CompositeTime

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added CompositeTime object from Origin.

remove(arrival)

Parameters:

arrival – Object of type Arrival

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Arrival object from Origin.

remove(stationMagnitude)

Parameters:

stationMagnitude – Object of type StationMagnitude

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added StationMagnitude object from Origin.

remove(magnitude)

Parameters:

magnitude – Object of type Magnitude

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Magnitude object from Origin.

removeComment(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeComment(commentIndex);

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeCompositeTime(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeArrival(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeArrival(arrivalIndex);

Parameters:

arrivalIndex – The index of the object to be removed of type ArrivalIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeStationMagnitude(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeMagnitude(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

commentCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Comment child objects.

compositeTimeCount()

Return type:

integer value indicating the number of child objects.

Returns the number of CompositeTime child objects.

arrivalCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Arrival child objects.

stationMagnitudeCount()

Return type:

integer value indicating the number of child objects.

Returns the number of StationMagnitude child objects.

magnitudeCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Magnitude child objects.

comment(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Comment.

Returns the Comment at index idx.

comment(commentIndex)

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

Object of type Comment.

Returns the Comment at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

compositeTime(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type CompositeTime.

Returns the CompositeTime at index idx.

arrival(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Arrival.

Returns the Arrival at index idx.

arrival(arrivalIndex)

Parameters:

arrivalIndex – The index of the object to be removed of type ArrivalIndex.

Return type:

Object of type Arrival.

Returns the Arrival at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

stationMagnitude(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type StationMagnitude.

Returns the StationMagnitude at index idx.

magnitude(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Magnitude.

Returns the Magnitude at index idx.

findCompositeTime(compositeTime)

Parameters:

compositeTime – Reference object of type CompositeTime.

Return type:

Object of type CompositeTime.

Returns the child object with equals the passed object, None otherwise.

findStationMagnitude(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type StationMagnitude.

Returns the child object with a certain publicID, None otherwise.

findMagnitude(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type Magnitude.

Returns the child object with a certain publicID, None otherwise.

eventParameters()

Return type:

EventParameters

Returns the parent EventParameters if available. Returns None if the parent is not a EventParameters. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Origin.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

OriginQuality

class seiscomp.datamodel.OriginQuality

Inherits Object.

This type contains various attributes commonly used to describe the quality of an origin, e. g., errors, azimuthal coverage, etc. Origin objects have an optional attribute of the type OriginQuality.

Attributes:

• associatedPhaseCount – int (optional)

• usedPhaseCount – int (optional)

• associatedStationCount – int (optional)

• usedStationCount – int (optional)

• depthPhaseCount – int (optional)

• standardError – float (optional)

• azimuthalGap – float (optional)

• secondaryAzimuthalGap – float (optional)

• groundTruthLevel – string

• maximumDistance – float (optional)

• minimumDistance – float (optional)

• medianDistance – float (optional)

Used by:

• Origin.quality()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type OriginQuality if the cast was successful, None otherwise.

Cast an arbitrary object to OriginQuality if the internal wrapped representation is an OriginQuality object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type OriginQuality to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setAssociatedPhaseCount(associatedPhaseCount)

Parameters:

associatedPhaseCount – int

Number of associated phases, regardless of their use for origin computation.

associatedPhaseCount()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setUsedPhaseCount(usedPhaseCount)

Parameters:

usedPhaseCount – int

Number of defining phases, i. e., phase observations that were actually used for computing the origin. Note that there may be more than one defining phase per station.

usedPhaseCount()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setAssociatedStationCount(associatedStationCount)

Parameters:

associatedStationCount – int

Number of stations at which the event was observed.

associatedStationCount()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setUsedStationCount(usedStationCount)

Parameters:

usedStationCount – int

Number of stations from which data was used for origin computation.

usedStationCount()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDepthPhaseCount(depthPhaseCount)

Parameters:

depthPhaseCount – int

Number of depth phases (typically pP, sometimes sP) used in depth computation.

depthPhaseCount()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setStandardError(standardError)

Parameters:

standardError – float

RMS of the travel time residuals of the arrivals used for the origin computation in seconds.

standardError()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setAzimuthalGap(azimuthalGap)

Parameters:

azimuthalGap – float

Largest azimuthal gap in station distribution as seen from epicenter in degrees.

azimuthalGap()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setSecondaryAzimuthalGap(secondaryAzimuthalGap)

Parameters:

secondaryAzimuthalGap – float

Secondary azimuthal gap in station distribution, i. e., the largest azimuthal gap a station closes in degrees.

secondaryAzimuthalGap()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setGroundTruthLevel(groundTruthLevel)

Parameters:

groundTruthLevel – string

String describing ground-truth level, e. g. GT0, GT5, etc. It has a maximum length of 16 characters.

groundTruthLevel()

Return type:

string

setMaximumDistance(maximumDistance)

Parameters:

maximumDistance – float

Epicentral distance of station farthest from the epicenter in degrees.

maximumDistance()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setMinimumDistance(minimumDistance)

Parameters:

minimumDistance – float

Epicentral distance of station closest to the epicenter in degrees.

minimumDistance()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setMedianDistance(medianDistance)

Parameters:

medianDistance – float

Median epicentral distance of used stations in degrees.

medianDistance()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

OriginReference

class seiscomp.datamodel.OriginReference

Inherits Object.

Parents:

• event – Event

Attributes:

• originID – string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type OriginReference if the cast was successful, None otherwise.

Cast an arbitrary object to OriginReference if the internal wrapped representation is an OriginReference object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type OriginReference to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type OriginReferenceIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – OriginReference

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setOriginID(originID)

Parameters:

originID – string

originID()

Return type:

string

event()

Return type:

Event

Returns the parent Event if available. Returns None if the parent is not a Event. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned OriginReference.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

OriginUncertainty

class seiscomp.datamodel.OriginUncertainty

Inherits Object.

This class describes the location uncertainties of an origin. The uncertainty can be described either as a simple circular horizontal uncertainty, an uncertainty ellipse according to IMS1.0, or a confidence ellipsoid. If multiple uncertainty models are given, the preferred variant can be specified in the attribute preferredDescription.

Attributes:

• horizontalUncertainty – float (optional)

• minHorizontalUncertainty – float (optional)

• maxHorizontalUncertainty – float (optional)

• azimuthMaxHorizontalUncertainty – float (optional)

• confidenceEllipsoid – ConfidenceEllipsoid (optional)

• preferredDescription – OriginUncertaintyDescription (optional)

• confidenceLevel – float (optional)

Used by:

• Origin.uncertainty()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type OriginUncertainty if the cast was successful, None otherwise.

Cast an arbitrary object to OriginUncertainty if the internal wrapped representation is an OriginUncertainty object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type OriginUncertainty to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setHorizontalUncertainty(horizontalUncertainty)

Parameters:

horizontalUncertainty – float

Circular confidence region, given by single value of horizontal uncertainty in km.

horizontalUncertainty()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setMinHorizontalUncertainty(minHorizontalUncertainty)

Parameters:

minHorizontalUncertainty – float

Semi-minor axis of confidence ellipse in km.

minHorizontalUncertainty()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setMaxHorizontalUncertainty(maxHorizontalUncertainty)

Parameters:

maxHorizontalUncertainty – float

Semi-major axis of confidence ellipse in km.

maxHorizontalUncertainty()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setAzimuthMaxHorizontalUncertainty(azimuthMaxHorizontalUncertainty)

Parameters:

azimuthMaxHorizontalUncertainty – float

Azimuth of major axis of confidence ellipse. Measured clockwise from South-North direction at epicenter in degrees.

azimuthMaxHorizontalUncertainty()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setConfidenceEllipsoid(confidenceEllipsoid)

Parameters:

confidenceEllipsoid – ConfidenceEllipsoid

Confidence ellipsoid.

confidenceEllipsoid()

Return type:

ConfidenceEllipsoid

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setPreferredDescription(preferredDescription)

Parameters:

preferredDescription – OriginUncertaintyDescription

Preferred uncertainty description.

preferredDescription()

Return type:

OriginUncertaintyDescription

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setConfidenceLevel(confidenceLevel)

Parameters:

confidenceLevel – float

Confidence level of the uncertainty, given in percent.

confidenceLevel()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

Outage

class seiscomp.datamodel.Outage

Inherits Object.

Parents:

• qualityControl – QualityControl

Attributes:

• waveformID – WaveformStreamID

• creatorID – string

• created – seiscomp.core.Time

• start – seiscomp.core.Time

• end – seiscomp.core.Time (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Outage if the cast was successful, None otherwise.

Cast an arbitrary object to Outage if the internal wrapped representation is an Outage object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type Outage to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type OutageIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – Outage

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setWaveformID(waveformID)

Parameters:

waveformID – WaveformStreamID

waveformID()

Return type:

WaveformStreamID

setCreatorID(creatorID)

Parameters:

creatorID – string

creatorID()

Return type:

string

setCreated(created)

Parameters:

created – seiscomp.core.Time

created()

Return type:

seiscomp.core.Time

setStart(start)

Parameters:

start – seiscomp.core.Time

start()

Return type:

seiscomp.core.Time

setEnd(end)

Parameters:

end – seiscomp.core.Time

end()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

qualityControl()

Return type:

QualityControl

Returns the parent QualityControl if available. Returns None if the parent is not a QualityControl. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Outage.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Parameter

class seiscomp.datamodel.Parameter

Inherits PublicObject.

Parents:

• parameterSet – ParameterSet

Children:

• comment – Comment

Attributes:

• publicID: string

• name – string

• value – string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Parameter if the cast was successful, None otherwise.

Cast an arbitrary object to Parameter if the internal wrapped representation is an Parameter object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type Parameter.

Creates and registers (if enabled) a Parameter instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type Parameter.

Creates and registers (if enabled) a Parameter instance with passed publicID.

equal(other)

Parameters:

other – Another object of type Parameter to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setName(name)

Parameters:

name – string

name()

Return type:

string

setValue(value)

Parameters:

value – string

value()

Return type:

string

add(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Comment object to Parameter. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Comment object from Parameter.

removeComment(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeComment(commentIndex);

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

commentCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Comment child objects.

comment(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Comment.

Returns the Comment at index idx.

comment(commentIndex)

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

Object of type Comment.

Returns the Comment at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

parameterSet()

Return type:

ParameterSet

Returns the parent ParameterSet if available. Returns None if the parent is not a ParameterSet. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Parameter.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

ParameterSet

class seiscomp.datamodel.ParameterSet

Inherits PublicObject.

Parents:

• config – Config

Children:

• parameter – Parameter

• comment – Comment

Attributes:

• publicID: string

• baseID – string

• moduleID – string

• created – seiscomp.core.Time (optional)

Referenced by:

• ConfigModule.parameterSetID()

• ParameterSet.baseID()

• Setup.parameterSetID()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type ParameterSet if the cast was successful, None otherwise.

Cast an arbitrary object to ParameterSet if the internal wrapped representation is an ParameterSet object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type ParameterSet.

Creates and registers (if enabled) a ParameterSet instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type ParameterSet.

Creates and registers (if enabled) a ParameterSet instance with passed publicID.

equal(other)

Parameters:

other – Another object of type ParameterSet to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setBaseID(baseID)

Parameters:

baseID – string

baseID()

Return type:

string

setModuleID(moduleID)

Parameters:

moduleID – string

moduleID()

Return type:

string

setCreated(created)

Parameters:

created – seiscomp.core.Time

created()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(parameter)

Parameters:

parameter – Object of type Parameter

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Parameter object to ParameterSet. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Comment object to ParameterSet. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(parameter)

Parameters:

parameter – Object of type Parameter

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Parameter object from ParameterSet.

remove(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Comment object from ParameterSet.

removeParameter(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeComment(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeComment(commentIndex);

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

parameterCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Parameter child objects.

commentCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Comment child objects.

parameter(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Parameter.

Returns the Parameter at index idx.

comment(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Comment.

Returns the Comment at index idx.

comment(commentIndex)

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

Object of type Comment.

Returns the Comment at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

findParameter(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type Parameter.

Returns the child object with a certain publicID, None otherwise.

config()

Return type:

Config

Returns the parent Config if available. Returns None if the parent is not a Config. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned ParameterSet.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Phase

class seiscomp.datamodel.Phase

Inherits Object.

Generic and extensible phase description that currently contains the phase code only.

Attributes:

• code – string

Used by:

• Arrival.phase()

• Pick.phaseHint()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Phase if the cast was successful, None otherwise.

Cast an arbitrary object to Phase if the internal wrapped representation is an Phase object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type Phase to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setCode(code)

Parameters:

code – string

Phase code as given in the IASPEI Standard Seismic Phase List (Storchak et al. 2003). String with a maximum length of 32 characters.

code()

Return type:

string

Pick

class seiscomp.datamodel.Pick

Inherits PublicObject.

A pick is the observation of an amplitude anomaly in a seismogram at a specific point in time. It is not necessarily related to a seismic event.

Parents:

• eventParameters – EventParameters

Children:

• comment – Comment

Attributes:

• publicID: string

• time – TimeQuantity

• waveformID – WaveformStreamID

• filterID – string

• methodID – string

• horizontalSlowness – RealQuantity (optional)

• backazimuth – RealQuantity (optional)

• slownessMethodID – string

• onset – PickOnset (optional)

• phaseHint – Phase (optional)

• polarity – PickPolarity (optional)

• evaluationMode – EvaluationMode (optional)

• evaluationStatus – EvaluationStatus (optional)

• creationInfo – CreationInfo (optional)

Referenced by:

• Amplitude.pickID()

• Arrival.pickID()

• PickReference.pickID()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Pick if the cast was successful, None otherwise.

Cast an arbitrary object to Pick if the internal wrapped representation is an Pick object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type Pick.

Creates and registers (if enabled) a Pick instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type Pick.

Creates and registers (if enabled) a Pick instance with passed publicID.

equal(other)

Parameters:

other – Another object of type Pick to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setTime(time)

Parameters:

time – TimeQuantity

Observed onset time of signal ("pick time").

time()

Return type:

TimeQuantity

setWaveformID(waveformID)

Parameters:

waveformID – WaveformStreamID

Identifes the waveform stream.

waveformID()

Return type:

WaveformStreamID

setFilterID(filterID)

Parameters:

filterID – string

Identifies the filter or filter setup used for filtering the waveform stream referenced by waveformID.

filterID()

Return type:

string

setMethodID(methodID)

Parameters:

methodID – string

Identifies the picker that produced the pick. This can be either a detection software program or a person.

methodID()

Return type:

string

setHorizontalSlowness(horizontalSlowness)

Parameters:

horizontalSlowness – RealQuantity

Observed horizontal slowness of the signal. Most relevant in array measurements in s/deg.

horizontalSlowness()

Return type:

RealQuantity

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setBackazimuth(backazimuth)

Parameters:

backazimuth – RealQuantity

Observed backazimuth of the signal. Most relevant in array measurements in degrees.

backazimuth()

Return type:

RealQuantity

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setSlownessMethodID(slownessMethodID)

Parameters:

slownessMethodID – string

Identifies the method that was used to determine the slowness.

slownessMethodID()

Return type:

string

setOnset(onset)

Parameters:

onset – PickOnset

Flag that roughly categorizes the sharpness of the onset.

onset()

Return type:

PickOnset

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setPhaseHint(phaseHint)

Parameters:

phaseHint – Phase

Tentative phase identification as specified by the picker.

phaseHint()

Return type:

Phase

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setPolarity(polarity)

Parameters:

polarity – PickPolarity

Indicates the polarity of first motion, usually from impulsive onsets.

polarity()

Return type:

PickPolarity

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setEvaluationMode(evaluationMode)

Parameters:

evaluationMode – EvaluationMode

Evaluation mode of Pick.

evaluationMode()

Return type:

EvaluationMode

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setEvaluationStatus(evaluationStatus)

Parameters:

evaluationStatus – EvaluationStatus

Evaluation status of Pick.

evaluationStatus()

Return type:

EvaluationStatus

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setCreationInfo(creationInfo)

Parameters:

creationInfo – CreationInfo

CreationInfo for the Pick object.

creationInfo()

Return type:

CreationInfo

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Comment object to Pick. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Comment object from Pick.

removeComment(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeComment(commentIndex);

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

commentCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Comment child objects.

comment(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Comment.

Returns the Comment at index idx.

comment(commentIndex)

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

Object of type Comment.

Returns the Comment at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

eventParameters()

Return type:

EventParameters

Returns the parent EventParameters if available. Returns None if the parent is not a EventParameters. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Pick.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

PickReference

class seiscomp.datamodel.PickReference

Inherits Object.

Parents:

• reading – Reading

Attributes:

• pickID – string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type PickReference if the cast was successful, None otherwise.

Cast an arbitrary object to PickReference if the internal wrapped representation is an PickReference object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type PickReference to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type PickReferenceIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – PickReference

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setPickID(pickID)

Parameters:

pickID – string

pickID()

Return type:

string

reading()

Return type:

Reading

Returns the parent Reading if available. Returns None if the parent is not a Reading. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned PickReference.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

PrincipalAxes

class seiscomp.datamodel.PrincipalAxes

Inherits Object.

This class describes the principal axes of a double-couple moment tensor solution. tAxis and pAxis are required, while nAxis is optional.

Attributes:

• tAxis – Axis

• pAxis – Axis

• nAxis – Axis (optional)

Used by:

• FocalMechanism.principalAxes()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type PrincipalAxes if the cast was successful, None otherwise.

Cast an arbitrary object to PrincipalAxes if the internal wrapped representation is an PrincipalAxes object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type PrincipalAxes to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setTAxis(tAxis)

Parameters:

tAxis – Axis

T (tension) axis of a double-couple moment tensor solution.

tAxis()

Return type:

Axis

setPAxis(pAxis)

Parameters:

pAxis – Axis

P (pressure) axis of a double-couple moment tensor solution.

pAxis()

Return type:

Axis

setNAxis(nAxis)

Parameters:

nAxis – Axis

N (neutral) axis of a double-couple moment tensor solution.

nAxis()

Return type:

Axis

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

QCLog

class seiscomp.datamodel.QCLog

Inherits PublicObject.

Parents:

• qualityControl – QualityControl

Attributes:

• publicID: string

• waveformID – WaveformStreamID

• creatorID – string

• created – seiscomp.core.Time

• start – seiscomp.core.Time

• end – seiscomp.core.Time

• message – string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type QCLog if the cast was successful, None otherwise.

Cast an arbitrary object to QCLog if the internal wrapped representation is an QCLog object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type QCLog.

Creates and registers (if enabled) a QCLog instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type QCLog.

Creates and registers (if enabled) a QCLog instance with passed publicID.

equal(other)

Parameters:

other – Another object of type QCLog to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type QCLogIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – QCLog

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setWaveformID(waveformID)

Parameters:

waveformID – WaveformStreamID

waveformID()

Return type:

WaveformStreamID

setCreatorID(creatorID)

Parameters:

creatorID – string

creatorID()

Return type:

string

setCreated(created)

Parameters:

created – seiscomp.core.Time

created()

Return type:

seiscomp.core.Time

setStart(start)

Parameters:

start – seiscomp.core.Time

start()

Return type:

seiscomp.core.Time

setEnd(end)

Parameters:

end – seiscomp.core.Time

end()

Return type:

seiscomp.core.Time

setMessage(message)

Parameters:

message – string

message()

Return type:

string

qualityControl()

Return type:

QualityControl

Returns the parent QualityControl if available. Returns None if the parent is not a QualityControl. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned QCLog.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

QualityControl

class seiscomp.datamodel.QualityControl

Inherits PublicObject.

Children:

• qCLog – QCLog

• waveformQuality – WaveformQuality

• outage – Outage

Attributes:

• publicID: string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type QualityControl if the cast was successful, None otherwise.

Cast an arbitrary object to QualityControl if the internal wrapped representation is an QualityControl object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type QualityControl to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

add(qCLog)

Parameters:

qCLog – Object of type QCLog

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a QCLog object to QualityControl. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(waveformQuality)

Parameters:

waveformQuality – Object of type WaveformQuality

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a WaveformQuality object to QualityControl. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(outage)

Parameters:

outage – Object of type Outage

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Outage object to QualityControl. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(qCLog)

Parameters:

qCLog – Object of type QCLog

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added QCLog object from QualityControl.

remove(waveformQuality)

Parameters:

waveformQuality – Object of type WaveformQuality

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added WaveformQuality object from QualityControl.

remove(outage)

Parameters:

outage – Object of type Outage

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Outage object from QualityControl.

removeQCLog(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeQCLog(qCLogIndex);

Parameters:

qCLogIndex – The index of the object to be removed of type QCLogIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeWaveformQuality(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeWaveformQuality(waveformQualityIndex);

Parameters:

waveformQualityIndex – The index of the object to be removed of type WaveformQualityIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeOutage(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeOutage(outageIndex);

Parameters:

outageIndex – The index of the object to be removed of type OutageIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

qCLogCount()

Return type:

integer value indicating the number of child objects.

Returns the number of QCLog child objects.

waveformQualityCount()

Return type:

integer value indicating the number of child objects.

Returns the number of WaveformQuality child objects.

outageCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Outage child objects.

qCLog(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type QCLog.

Returns the QCLog at index idx.

qCLog(qCLogIndex)

Parameters:

qCLogIndex – The index of the object to be removed of type QCLogIndex.

Return type:

Object of type QCLog.

Returns the QCLog at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

waveformQuality(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type WaveformQuality.

Returns the WaveformQuality at index idx.

waveformQuality(waveformQualityIndex)

Parameters:

waveformQualityIndex – The index of the object to be removed of type WaveformQualityIndex.

Return type:

Object of type WaveformQuality.

Returns the WaveformQuality at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

outage(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Outage.

Returns the Outage at index idx.

outage(outageIndex)

Parameters:

outageIndex – The index of the object to be removed of type OutageIndex.

Return type:

Object of type Outage.

Returns the Outage at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

findQCLog(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type QCLog.

Returns the child object with a certain publicID, None otherwise.

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned QualityControl.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Reading

class seiscomp.datamodel.Reading

Inherits PublicObject.

This class groups Pick and Amplitude elements which are thought to belong to the same event, but for which the event identification is not known.

Parents:

• eventParameters – EventParameters

Children:

• pickReference – PickReference

• amplitudeReference – AmplitudeReference

Attributes:

• publicID: string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Reading if the cast was successful, None otherwise.

Cast an arbitrary object to Reading if the internal wrapped representation is an Reading object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type Reading.

Creates and registers (if enabled) a Reading instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type Reading.

Creates and registers (if enabled) a Reading instance with passed publicID.

equal(other)

Parameters:

other – Another object of type Reading to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

add(pickReference)

Parameters:

pickReference – Object of type PickReference

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a PickReference object to Reading. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(amplitudeReference)

Parameters:

amplitudeReference – Object of type AmplitudeReference

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a AmplitudeReference object to Reading. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(pickReference)

Parameters:

pickReference – Object of type PickReference

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added PickReference object from Reading.

remove(amplitudeReference)

Parameters:

amplitudeReference – Object of type AmplitudeReference

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added AmplitudeReference object from Reading.

removePickReference(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removePickReference(pickReferenceIndex);

Parameters:

pickReferenceIndex – The index of the object to be removed of type PickReferenceIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeAmplitudeReference(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeAmplitudeReference(amplitudeReferenceIndex);

Parameters:

amplitudeReferenceIndex – The index of the object to be removed of type AmplitudeReferenceIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

pickReferenceCount()

Return type:

integer value indicating the number of child objects.

Returns the number of PickReference child objects.

amplitudeReferenceCount()

Return type:

integer value indicating the number of child objects.

Returns the number of AmplitudeReference child objects.

pickReference(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type PickReference.

Returns the PickReference at index idx.

pickReference(pickReferenceIndex)

Parameters:

pickReferenceIndex – The index of the object to be removed of type PickReferenceIndex.

Return type:

Object of type PickReference.

Returns the PickReference at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

amplitudeReference(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type AmplitudeReference.

Returns the AmplitudeReference at index idx.

amplitudeReference(amplitudeReferenceIndex)

Parameters:

amplitudeReferenceIndex – The index of the object to be removed of type AmplitudeReferenceIndex.

Return type:

Object of type AmplitudeReference.

Returns the AmplitudeReference at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

eventParameters()

Return type:

EventParameters

Returns the parent EventParameters if available. Returns None if the parent is not a EventParameters. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Reading.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

RealArray

class seiscomp.datamodel.RealArray

Inherits Object.

Attributes:

• content – float (optional)

Used by:

• RealPDF1D.variable()

• RealPDF1D.probability()

• ResponseFAP.tuples()

• ResponseFIR.coefficients()

• ResponseIIR.numerators()

• ResponseIIR.denominators()

• ResponsePolynomial.coefficients()

• TimePDF1D.probability()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type RealArray if the cast was successful, None otherwise.

Cast an arbitrary object to RealArray if the internal wrapped representation is an RealArray object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type RealArray to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setContent(content)

Parameters:

content – float

content()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

RealPDF1D

class seiscomp.datamodel.RealPDF1D

Inherits Object.

A probability density function description. It can be used in three different modes:

1) "raw samples mode"

variable is a list of M values, no probability. The values represent samples, no binning/probabilities made.

2) "implicitly binned PDF"

variable and probabilty arrays have length N. variable values to be interpreted as "bin centers" (or representative values), no bin edges given.

3) "explicitly binned PDF"

variable has length N+1, probability has length N. variable values describe bin edges (upper bin edge is lower edge of next bin).

Attributes:

• variable – RealArray

• probability – RealArray

Used by:

• RealQuantity.pdf()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type RealPDF1D if the cast was successful, None otherwise.

Cast an arbitrary object to RealPDF1D if the internal wrapped representation is an RealPDF1D object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type RealPDF1D to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setVariable(variable)

Parameters:

variable – RealArray

List of values

variable()

Return type:

RealArray

setProbability(probability)

Parameters:

probability – RealArray

List of probabilities

probability()

Return type:

RealArray

RealQuantity

class seiscomp.datamodel.RealQuantity

Inherits Object.

Physical quantities expressed as floating point numbers are represented by their measured or computed values and optional values for symmetric or upper and lower uncertainties. The interpretation of these uncertainties is not defined in the standard. They can contain statistically well-defined error measures, but the mechanism can also be used to simply describe a possible value range. If the confidence level of the uncertainty is known, it can be listed in the optional attribute confidenceLevel. Note that uncertainty, upperUncertainty, and lowerUncertainty are given as absolute values of the deviation from the main value.

Attributes:

• value – float

• uncertainty – float (optional)

• lowerUncertainty – float (optional)

• upperUncertainty – float (optional)

• confidenceLevel – float (optional)

• pdf – RealPDF1D (optional)

Used by:

• Amplitude.amplitude()

• Amplitude.period()

• Axis.azimuth()

• Axis.plunge()

• Axis.length()

• CompositeTime.second()

• Magnitude.magnitude()

• MomentTensor.scalarMoment()

• NodalPlane.strike()

• NodalPlane.dip()

• NodalPlane.rake()

• Origin.latitude()

• Origin.longitude()

• Origin.depth()

• Pick.horizontalSlowness()

• Pick.backazimuth()

• StationMagnitude.magnitude()

• Tensor.Mrr()

• Tensor.Mtt()

• Tensor.Mpp()

• Tensor.Mrt()

• Tensor.Mrp()

• Tensor.Mtp()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type RealQuantity if the cast was successful, None otherwise.

Cast an arbitrary object to RealQuantity if the internal wrapped representation is an RealQuantity object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type RealQuantity to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setValue(value)

Parameters:

value – float

Value of the quantity. The unit is implicitly defined and depends on the context.

value()

Return type:

float

setUncertainty(uncertainty)

Parameters:

uncertainty – float

Uncertainty as the absolute value of symmetric deviation from the main value.

uncertainty()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setLowerUncertainty(lowerUncertainty)

Parameters:

lowerUncertainty – float

Uncertainty as the absolute value of deviation from the main value towards smaller values.

lowerUncertainty()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setUpperUncertainty(upperUncertainty)

Parameters:

upperUncertainty – float

Uncertainty as the absolute value of deviation from the main value towards larger values.

upperUncertainty()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setConfidenceLevel(confidenceLevel)

Parameters:

confidenceLevel – float

Confidence level of the uncertainty, given in percent.

confidenceLevel()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setPdf(pdf)

Parameters:

pdf – RealPDF1D

Probability density function of the quantity.

pdf()

Return type:

RealPDF1D

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

ResponseFAP

class seiscomp.datamodel.ResponseFAP

Inherits PublicObject.

This type describes a sensor response composed of frequency/amplitude/phase angle tuples. According to the SEED manual (blockette 55) this description alone is not an acceptable response description.

Parents:

• inventory – Inventory

Attributes:

• publicID: string

• name – string

• gain – float (optional)

• gainFrequency – float (optional)

• numberOfTuples – int (optional)

• tuples – RealArray (optional)

• remark – Blob (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type ResponseFAP if the cast was successful, None otherwise.

Cast an arbitrary object to ResponseFAP if the internal wrapped representation is an ResponseFAP object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type ResponseFAP.

Creates and registers (if enabled) a ResponseFAP instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type ResponseFAP.

Creates and registers (if enabled) a ResponseFAP instance with passed publicID.

equal(other)

Parameters:

other – Another object of type ResponseFAP to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type ResponseFAPIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – ResponseFAP

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setName(name)

Parameters:

name – string

Unique response name

name()

Return type:

string

setGain(gain)

Parameters:

gain – float

Gain of response (48.05/58.04)

gain()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setGainFrequency(gainFrequency)

Parameters:

gainFrequency – float

Gain frequency (48.06/58.05)

gainFrequency()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setNumberOfTuples(numberOfTuples)

Parameters:

numberOfTuples – int

The number of fap tuples in the response

numberOfTuples()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setTuples(tuples)

Parameters:

tuples – RealArray

The tuples organized as linear array. The array size must be numberOfTuples * 3. Each tuple consists of frequency (in Hz), amplitude and phase angle (in degree).

tuples()

Return type:

RealArray

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setRemark(remark)

Parameters:

remark – Blob

Optional remark

remark()

Return type:

Blob

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

inventory()

Return type:

Inventory

Returns the parent Inventory if available. Returns None if the parent is not a Inventory. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned ResponseFAP.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

ResponseFIR

class seiscomp.datamodel.ResponseFIR

Inherits PublicObject.

This type describes a finite impulse response filter

Parents:

• inventory – Inventory

Attributes:

• publicID: string

• name – string

• gain – float (optional)

• gainFrequency – float (optional)

• decimationFactor – int (optional)

• delay – float (optional)

• correction – float (optional)

• numberOfCoefficients – int (optional)

• symmetry – string

• coefficients – RealArray (optional)

• remark – Blob (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type ResponseFIR if the cast was successful, None otherwise.

Cast an arbitrary object to ResponseFIR if the internal wrapped representation is an ResponseFIR object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type ResponseFIR.

Creates and registers (if enabled) a ResponseFIR instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type ResponseFIR.

Creates and registers (if enabled) a ResponseFIR instance with passed publicID.

equal(other)

Parameters:

other – Another object of type ResponseFIR to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type ResponseFIRIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – ResponseFIR

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setName(name)

Parameters:

name – string

Unique response name

name()

Return type:

string

setGain(gain)

Parameters:

gain – float

Gain of response (48.05/58.04)

gain()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setGainFrequency(gainFrequency)

Parameters:

gainFrequency – float

Gain frequency (48.06/58.05)

gainFrequency()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDecimationFactor(decimationFactor)

Parameters:

decimationFactor – int

Decimation factor (47.06/57.05)

decimationFactor()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDelay(delay)

Parameters:

delay – float

Estimated delay (47.08/57.07)

delay()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setCorrection(correction)

Parameters:

correction – float

Applied correction (47.09/57.08)

correction()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setNumberOfCoefficients(numberOfCoefficients)

Parameters:

numberOfCoefficients – int

Number of coefficients (41.08/61.08)

numberOfCoefficients()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setSymmetry(symmetry)

Parameters:

symmetry – string

Symmetry code (41.05/61.05)

symmetry()

Return type:

string

setCoefficients(coefficients)

Parameters:

coefficients – RealArray

Coefficients normalized to gain=1.0 (41.09/61.09)

coefficients()

Return type:

RealArray

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setRemark(remark)

Parameters:

remark – Blob

remark()

Return type:

Blob

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

inventory()

Return type:

Inventory

Returns the parent Inventory if available. Returns None if the parent is not a Inventory. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned ResponseFIR.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

ResponseIIR

class seiscomp.datamodel.ResponseIIR

Inherits PublicObject.

This type describes a infinite impulse response filter

Parents:

• inventory – Inventory

Attributes:

• publicID: string

• name – string

• type – string

• gain – float (optional)

• gainFrequency – float (optional)

• decimationFactor – int (optional)

• delay – float (optional)

• correction – float (optional)

• numberOfNumerators – int (optional)

• numberOfDenominators – int (optional)

• numerators – RealArray (optional)

• denominators – RealArray (optional)

• remark – Blob (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type ResponseIIR if the cast was successful, None otherwise.

Cast an arbitrary object to ResponseIIR if the internal wrapped representation is an ResponseIIR object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type ResponseIIR.

Creates and registers (if enabled) a ResponseIIR instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type ResponseIIR.

Creates and registers (if enabled) a ResponseIIR instance with passed publicID.

equal(other)

Parameters:

other – Another object of type ResponseIIR to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type ResponseIIRIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – ResponseIIR

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setName(name)

Parameters:

name – string

Unique response name

name()

Return type:

string

setType(type)

Parameters:

type – string

Response type (43.05/53.03/54.03): A - Laplace transform analog response in rad/sec, B - Analog response in Hz, C - Composite (currently undefined), D - Digital (Z - transform)

type()

Return type:

string

setGain(gain)

Parameters:

gain – float

Gain of response (48.05/58.04)

gain()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setGainFrequency(gainFrequency)

Parameters:

gainFrequency – float

Gain frequency (48.06/58.05)

gainFrequency()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDecimationFactor(decimationFactor)

Parameters:

decimationFactor – int

Decimation factor (47.06/57.05)

decimationFactor()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDelay(delay)

Parameters:

delay – float

Estimated delay (47.08/57.07)

delay()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setCorrection(correction)

Parameters:

correction – float

Applied correction (47.09/57.08)

correction()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setNumberOfNumerators(numberOfNumerators)

Parameters:

numberOfNumerators – int

Number of numerators (54.07)

numberOfNumerators()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setNumberOfDenominators(numberOfDenominators)

Parameters:

numberOfDenominators – int

Number of denominators (54.10)

numberOfDenominators()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setNumerators(numerators)

Parameters:

numerators – RealArray

Numerators (54.08-09)

numerators()

Return type:

RealArray

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDenominators(denominators)

Parameters:

denominators – RealArray

Denominators (54.11-12)

denominators()

Return type:

RealArray

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setRemark(remark)

Parameters:

remark – Blob

remark()

Return type:

Blob

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

inventory()

Return type:

Inventory

Returns the parent Inventory if available. Returns None if the parent is not a Inventory. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned ResponseIIR.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

ResponsePAZ

class seiscomp.datamodel.ResponsePAZ

Inherits PublicObject.

This type describes a sensor response using poles and zeros

Parents:

• inventory – Inventory

Attributes:

• publicID: string

• name – string

• type – string

• gain – float (optional)

• gainFrequency – float (optional)

• normalizationFactor – float (optional)

• normalizationFrequency – float (optional)

• numberOfZeros – int (optional)

• numberOfPoles – int (optional)

• zeros – ComplexArray (optional)

• poles – ComplexArray (optional)

• remark – Blob (optional)

• decimationFactor – int (optional)

• delay – float (optional)

• correction – float (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type ResponsePAZ if the cast was successful, None otherwise.

Cast an arbitrary object to ResponsePAZ if the internal wrapped representation is an ResponsePAZ object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type ResponsePAZ.

Creates and registers (if enabled) a ResponsePAZ instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type ResponsePAZ.

Creates and registers (if enabled) a ResponsePAZ instance with passed publicID.

equal(other)

Parameters:

other – Another object of type ResponsePAZ to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type ResponsePAZIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – ResponsePAZ

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setName(name)

Parameters:

name – string

Unique response name

name()

Return type:

string

setType(type)

Parameters:

type – string

Response type (43.05/53.03): A - Laplace transform analog response in rad/sec, B - Analog response in Hz, C - Composite (currently undefined), D - Digital (Z - transform)

type()

Return type:

string

setGain(gain)

Parameters:

gain – float

Gain of response (48.05/58.04)

gain()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setGainFrequency(gainFrequency)

Parameters:

gainFrequency – float

Gain frequency (48.06/58.05)

gainFrequency()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setNormalizationFactor(normalizationFactor)

Parameters:

normalizationFactor – float

A0 normalization factor (43.08/53.07)

normalizationFactor()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setNormalizationFrequency(normalizationFrequency)

Parameters:

normalizationFrequency – float

Normalization frequency (43.09/53.08)

normalizationFrequency()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setNumberOfZeros(numberOfZeros)

Parameters:

numberOfZeros – int

Number of zeros (43.10/53.09)

numberOfZeros()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setNumberOfPoles(numberOfPoles)

Parameters:

numberOfPoles – int

Number of poles (43.15/53.14)

numberOfPoles()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setZeros(zeros)

Parameters:

zeros – ComplexArray

Zeros (43.16-19/53.10-13)

zeros()

Return type:

ComplexArray

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setPoles(poles)

Parameters:

poles – ComplexArray

Poles (43.11-14/53.15-18)

poles()

Return type:

ComplexArray

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setRemark(remark)

Parameters:

remark – Blob

remark()

Return type:

Blob

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDecimationFactor(decimationFactor)

Parameters:

decimationFactor – int

Decimation factor (47.06/57.05)

decimationFactor()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDelay(delay)

Parameters:

delay – float

Estimated delay (47.08/57.07)

delay()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setCorrection(correction)

Parameters:

correction – float

Applied correction (47.09/57.08)

correction()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

inventory()

Return type:

Inventory

Returns the parent Inventory if available. Returns None if the parent is not a Inventory. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned ResponsePAZ.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

ResponsePolynomial

class seiscomp.datamodel.ResponsePolynomial

Inherits PublicObject.

This type describes a sensor response using a polynomial

Parents:

• inventory – Inventory

Attributes:

• publicID: string

• name – string

• gain – float (optional)

• gainFrequency – float (optional)

• frequencyUnit – string

• approximationType – string

• approximationLowerBound – float (optional)

• approximationUpperBound – float (optional)

• approximationError – float (optional)

• numberOfCoefficients – int (optional)

• coefficients – RealArray (optional)

• remark – Blob (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type ResponsePolynomial if the cast was successful, None otherwise.

Cast an arbitrary object to ResponsePolynomial if the internal wrapped representation is an ResponsePolynomial object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type ResponsePolynomial.

Creates and registers (if enabled) a ResponsePolynomial instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type ResponsePolynomial.

Creates and registers (if enabled) a ResponsePolynomial instance with passed publicID.

equal(other)

Parameters:

other – Another object of type ResponsePolynomial to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type ResponsePolynomialIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – ResponsePolynomial

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setName(name)

Parameters:

name – string

Unique response name

name()

Return type:

string

setGain(gain)

Parameters:

gain – float

Gain of response (48.05/58.04)

gain()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setGainFrequency(gainFrequency)

Parameters:

gainFrequency – float

Gain frequency (48.06/58.05)

gainFrequency()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setFrequencyUnit(frequencyUnit)

Parameters:

frequencyUnit – string

A single character describing valid frequency units (42.09/62.08): A - rad/s, B - Hz

frequencyUnit()

Return type:

string

setApproximationType(approximationType)

Parameters:

approximationType – string

A single character describing the type of polynomial approximation (42.08/62.07): M - MacLaurin

approximationType()

Return type:

string

setApproximationLowerBound(approximationLowerBound)

Parameters:

approximationLowerBound – float

Lower bound of approximation (42.12/62.11)

approximationLowerBound()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setApproximationUpperBound(approximationUpperBound)

Parameters:

approximationUpperBound – float

Upper bound of approximation (42.13/62.12)

approximationUpperBound()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setApproximationError(approximationError)

Parameters:

approximationError – float

The maximum absolute error of the polynomial approximation (42.14/62.13; Put 0.0 if the value is unknown or actually zero)

approximationError()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setNumberOfCoefficients(numberOfCoefficients)

Parameters:

numberOfCoefficients – int

The number of coefficients in the polynomial approximation (42.15/62.14; one more than the degree of the polynomial

numberOfCoefficients()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setCoefficients(coefficients)

Parameters:

coefficients – RealArray

The polynomial coefficients, lowest order first (42.16/62.15)

coefficients()

Return type:

RealArray

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setRemark(remark)

Parameters:

remark – Blob

remark()

Return type:

Blob

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

inventory()

Return type:

Inventory

Returns the parent Inventory if available. Returns None if the parent is not a Inventory. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned ResponsePolynomial.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Route

class seiscomp.datamodel.Route

Inherits PublicObject.

This type describes an ArcLink route (collection of servers that provide specific datastreams)

Parents:

• routing – Routing

Children:

• routeArclink – RouteArclink

• routeSeedlink – RouteSeedlink

Attributes:

• publicID: string

• networkCode – string

• stationCode – string

• locationCode – string

• streamCode – string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Route if the cast was successful, None otherwise.

Cast an arbitrary object to Route if the internal wrapped representation is an Route object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type Route.

Creates and registers (if enabled) a Route instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type Route.

Creates and registers (if enabled) a Route instance with passed publicID.

equal(other)

Parameters:

other – Another object of type Route to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type RouteIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – Route

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setNetworkCode(networkCode)

Parameters:

networkCode – string

Network code

networkCode()

Return type:

string

setStationCode(stationCode)

Parameters:

stationCode – string

Station code (empty for any station)

stationCode()

Return type:

string

setLocationCode(locationCode)

Parameters:

locationCode – string

Location code (empty for any location)

locationCode()

Return type:

string

setStreamCode(streamCode)

Parameters:

streamCode – string

Stream (Channel) code (empty for any stream)

streamCode()

Return type:

string

add(routeArclink)

Parameters:

routeArclink – Object of type RouteArclink

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a RouteArclink object to Route. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(routeSeedlink)

Parameters:

routeSeedlink – Object of type RouteSeedlink

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a RouteSeedlink object to Route. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(routeArclink)

Parameters:

routeArclink – Object of type RouteArclink

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added RouteArclink object from Route.

remove(routeSeedlink)

Parameters:

routeSeedlink – Object of type RouteSeedlink

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added RouteSeedlink object from Route.

removeRouteArclink(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeRouteArclink(routeArclinkIndex);

Parameters:

routeArclinkIndex – The index of the object to be removed of type RouteArclinkIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeRouteSeedlink(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeRouteSeedlink(routeSeedlinkIndex);

Parameters:

routeSeedlinkIndex – The index of the object to be removed of type RouteSeedlinkIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

routeArclinkCount()

Return type:

integer value indicating the number of child objects.

Returns the number of RouteArclink child objects.

routeSeedlinkCount()

Return type:

integer value indicating the number of child objects.

Returns the number of RouteSeedlink child objects.

routeArclink(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type RouteArclink.

Returns the RouteArclink at index idx.

routeArclink(routeArclinkIndex)

Parameters:

routeArclinkIndex – The index of the object to be removed of type RouteArclinkIndex.

Return type:

Object of type RouteArclink.

Returns the RouteArclink at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

routeSeedlink(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type RouteSeedlink.

Returns the RouteSeedlink at index idx.

routeSeedlink(routeSeedlinkIndex)

Parameters:

routeSeedlinkIndex – The index of the object to be removed of type RouteSeedlinkIndex.

Return type:

Object of type RouteSeedlink.

Returns the RouteSeedlink at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

routing()

Return type:

Routing

Returns the parent Routing if available. Returns None if the parent is not a Routing. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Route.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

RouteArclink

class seiscomp.datamodel.RouteArclink

Inherits Object.

This type describes an ArcLink route (data source)

Parents:

• route – Route

Attributes:

• address – string

• start – seiscomp.core.Time

• end – seiscomp.core.Time (optional)

• priority – int (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type RouteArclink if the cast was successful, None otherwise.

Cast an arbitrary object to RouteArclink if the internal wrapped representation is an RouteArclink object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type RouteArclink to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type RouteArclinkIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – RouteArclink

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setAddress(address)

Parameters:

address – string

Server address in ip:port format

address()

Return type:

string

setStart(start)

Parameters:

start – seiscomp.core.Time

Start of data

start()

Return type:

seiscomp.core.Time

setEnd(end)

Parameters:

end – seiscomp.core.Time

End of data

end()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setPriority(priority)

Parameters:

priority – int

priority (1 is highest)

priority()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

route()

Return type:

Route

Returns the parent Route if available. Returns None if the parent is not a Route. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned RouteArclink.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

RouteSeedlink

class seiscomp.datamodel.RouteSeedlink

Inherits Object.

This type describes an SeedLink route (data source)

Parents:

• route – Route

Attributes:

• address – string

• priority – int (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type RouteSeedlink if the cast was successful, None otherwise.

Cast an arbitrary object to RouteSeedlink if the internal wrapped representation is an RouteSeedlink object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type RouteSeedlink to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type RouteSeedlinkIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – RouteSeedlink

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setAddress(address)

Parameters:

address – string

Server address in ip:port format

address()

Return type:

string

setPriority(priority)

Parameters:

priority – int

priority (1 is highest)

priority()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

route()

Return type:

Route

Returns the parent Route if available. Returns None if the parent is not a Route. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned RouteSeedlink.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Routing

class seiscomp.datamodel.Routing

Inherits PublicObject.

Children:

• route – Route

• access – Access

Attributes:

• publicID: string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Routing if the cast was successful, None otherwise.

Cast an arbitrary object to Routing if the internal wrapped representation is an Routing object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type Routing to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

add(route)

Parameters:

route – Object of type Route

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Route object to Routing. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(access)

Parameters:

access – Object of type Access

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Access object to Routing. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(route)

Parameters:

route – Object of type Route

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Route object from Routing.

remove(access)

Parameters:

access – Object of type Access

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Access object from Routing.

removeRoute(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeRoute(routeIndex);

Parameters:

routeIndex – The index of the object to be removed of type RouteIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeAccess(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeAccess(accessIndex);

Parameters:

accessIndex – The index of the object to be removed of type AccessIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

routeCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Route child objects.

accessCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Access child objects.

route(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Route.

Returns the Route at index idx.

route(routeIndex)

Parameters:

routeIndex – The index of the object to be removed of type RouteIndex.

Return type:

Object of type Route.

Returns the Route at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

access(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Access.

Returns the Access at index idx.

access(accessIndex)

Parameters:

accessIndex – The index of the object to be removed of type AccessIndex.

Return type:

Object of type Access.

Returns the Access at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

findRoute(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type Route.

Returns the child object with a certain publicID, None otherwise.

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Routing.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Sensor

class seiscomp.datamodel.Sensor

Inherits PublicObject.

This type describes a sensor

Parents:

• inventory – Inventory

Children:

• sensorCalibration – SensorCalibration

Attributes:

• publicID: string

• name – string

• description – string

• model – string

• manufacturer – string

• type – string

• unit – string

• lowFrequency – float (optional)

• highFrequency – float (optional)

• response – string

• remark – Blob (optional)

Referenced by:

• Stream.sensor()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Sensor if the cast was successful, None otherwise.

Cast an arbitrary object to Sensor if the internal wrapped representation is an Sensor object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type Sensor.

Creates and registers (if enabled) a Sensor instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type Sensor.

Creates and registers (if enabled) a Sensor instance with passed publicID.

equal(other)

Parameters:

other – Another object of type Sensor to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type SensorIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – Sensor

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setName(name)

Parameters:

name – string

Unique sensor name

name()

Return type:

string

setDescription(description)

Parameters:

description – string

Sensor description

description()

Return type:

string

setModel(model)

Parameters:

model – string

Sensor model

model()

Return type:

string

setManufacturer(manufacturer)

Parameters:

manufacturer – string

Sensor manufacturer

manufacturer()

Return type:

string

setType(type)

Parameters:

type – string

Sensor type (VBB, BB, SP, SM, OBS)

type()

Return type:

string

setUnit(unit)

Parameters:

unit – string

Unit of measurement (M, M/S, M/S**2, RAD/S, V, A, PA, C)

unit()

Return type:

string

setLowFrequency(lowFrequency)

Parameters:

lowFrequency – float

Lower corner frequency (optional)

lowFrequency()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setHighFrequency(highFrequency)

Parameters:

highFrequency – float

Higher corner frequency (optional)

highFrequency()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setResponse(response)

Parameters:

response – string

Reference to responsePAZ/@publicID or responsePolynomial/@publicID or responseFAP/@publicID

response()

Return type:

string

setRemark(remark)

Parameters:

remark – Blob

remark()

Return type:

Blob

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(sensorCalibration)

Parameters:

sensorCalibration – Object of type SensorCalibration

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a SensorCalibration object to Sensor. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(sensorCalibration)

Parameters:

sensorCalibration – Object of type SensorCalibration

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added SensorCalibration object from Sensor.

removeSensorCalibration(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeSensorCalibration(sensorCalibrationIndex);

Parameters:

sensorCalibrationIndex – The index of the object to be removed of type SensorCalibrationIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

sensorCalibrationCount()

Return type:

integer value indicating the number of child objects.

Returns the number of SensorCalibration child objects.

sensorCalibration(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type SensorCalibration.

Returns the SensorCalibration at index idx.

sensorCalibration(sensorCalibrationIndex)

Parameters:

sensorCalibrationIndex – The index of the object to be removed of type SensorCalibrationIndex.

Return type:

Object of type SensorCalibration.

Returns the SensorCalibration at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

inventory()

Return type:

Inventory

Returns the parent Inventory if available. Returns None if the parent is not a Inventory. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Sensor.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

SensorCalibration

class seiscomp.datamodel.SensorCalibration

Inherits Object.

This type describes a sensor calibration

Parents:

• sensor – Sensor

Attributes:

• serialNumber – string

• channel – int

• start – seiscomp.core.Time

• end – seiscomp.core.Time (optional)

• gain – float (optional)

• gainFrequency – float (optional)

• remark – Blob (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type SensorCalibration if the cast was successful, None otherwise.

Cast an arbitrary object to SensorCalibration if the internal wrapped representation is an SensorCalibration object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type SensorCalibration to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type SensorCalibrationIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – SensorCalibration

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setSerialNumber(serialNumber)

Parameters:

serialNumber – string

Referred from network/station/Stream/@sensorSerialNumber

serialNumber()

Return type:

string

setChannel(channel)

Parameters:

channel – int

Referred from network/station/Stream/@sensorChannel

channel()

Return type:

int

setStart(start)

Parameters:

start – seiscomp.core.Time

Start of validity

start()

Return type:

seiscomp.core.Time

setEnd(end)

Parameters:

end – seiscomp.core.Time

End of validity

end()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setGain(gain)

Parameters:

gain – float

Overrides nominal gain of calibrated sensor (48.05/58.04)

gain()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setGainFrequency(gainFrequency)

Parameters:

gainFrequency – float

Gain frequency (48.06/58.05)

gainFrequency()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setRemark(remark)

Parameters:

remark – Blob

remark()

Return type:

Blob

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

sensor()

Return type:

Sensor

Returns the parent Sensor if available. Returns None if the parent is not a Sensor. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned SensorCalibration.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

SensorLocation

class seiscomp.datamodel.SensorLocation

Inherits PublicObject.

This type describes a sensor location

Parents:

• station – Station

Children:

• comment – Comment

• auxStream – AuxStream

• stream – Stream

Attributes:

• publicID: string

• code – string

• start – seiscomp.core.Time

• end – seiscomp.core.Time (optional)

• latitude – float (optional)

• longitude – float (optional)

• elevation – float (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type SensorLocation if the cast was successful, None otherwise.

Cast an arbitrary object to SensorLocation if the internal wrapped representation is an SensorLocation object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type SensorLocation.

Creates and registers (if enabled) a SensorLocation instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type SensorLocation.

Creates and registers (if enabled) a SensorLocation instance with passed publicID.

equal(other)

Parameters:

other – Another object of type SensorLocation to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type SensorLocationIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – SensorLocation

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setCode(code)

Parameters:

code – string

Station code (52.03)

code()

Return type:

string

setStart(start)

Parameters:

start – seiscomp.core.Time

Start of epoch in ISO datetime format

start()

Return type:

seiscomp.core.Time

setEnd(end)

Parameters:

end – seiscomp.core.Time

End of epoch

end()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setLatitude(latitude)

Parameters:

latitude – float

Sensor latitude (52.10) with respect to the World Geodetic System 1984 (WGS84) reference system (National Imagery and Mapping Agency 2000) in degrees.

latitude()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setLongitude(longitude)

Parameters:

longitude – float

Sensor longitude (52.11) with respect to the World Geodetic System 1984 (WGS84) reference system (National Imagery and Mapping Agency 2000) in degrees.

longitude()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setElevation(elevation)

Parameters:

elevation – float

Sensor elevation (52.12) with respect to the World Geodetic System 1984 (WGS84) reference system (National Imagery and Mapping Agency 2000) in meters.

elevation()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Comment object to SensorLocation. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(auxStream)

Parameters:

auxStream – Object of type AuxStream

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a AuxStream object to SensorLocation. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(stream)

Parameters:

stream – Object of type Stream

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Stream object to SensorLocation. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Comment object from SensorLocation.

remove(auxStream)

Parameters:

auxStream – Object of type AuxStream

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added AuxStream object from SensorLocation.

remove(stream)

Parameters:

stream – Object of type Stream

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Stream object from SensorLocation.

removeComment(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeComment(commentIndex);

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeAuxStream(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeAuxStream(auxStreamIndex);

Parameters:

auxStreamIndex – The index of the object to be removed of type AuxStreamIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeStream(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeStream(streamIndex);

Parameters:

streamIndex – The index of the object to be removed of type StreamIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

commentCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Comment child objects.

auxStreamCount()

Return type:

integer value indicating the number of child objects.

Returns the number of AuxStream child objects.

streamCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Stream child objects.

comment(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Comment.

Returns the Comment at index idx.

comment(commentIndex)

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

Object of type Comment.

Returns the Comment at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

auxStream(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type AuxStream.

Returns the AuxStream at index idx.

auxStream(auxStreamIndex)

Parameters:

auxStreamIndex – The index of the object to be removed of type AuxStreamIndex.

Return type:

Object of type AuxStream.

Returns the AuxStream at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

stream(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Stream.

Returns the Stream at index idx.

stream(streamIndex)

Parameters:

streamIndex – The index of the object to be removed of type StreamIndex.

Return type:

Object of type Stream.

Returns the Stream at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

findStream(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type Stream.

Returns the child object with a certain publicID, None otherwise.

station()

Return type:

Station

Returns the parent Station if available. Returns None if the parent is not a Station. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned SensorLocation.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Setup

class seiscomp.datamodel.Setup

Inherits Object.

Parents:

• configStation – ConfigStation

Attributes:

• name – string

• parameterSetID – string

• enabled – boolean

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Setup if the cast was successful, None otherwise.

Cast an arbitrary object to Setup if the internal wrapped representation is an Setup object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type Setup to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type SetupIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – Setup

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setName(name)

Parameters:

name – string

name()

Return type:

string

setParameterSetID(parameterSetID)

Parameters:

parameterSetID – string

parameterSetID()

Return type:

string

setEnabled(enabled)

Parameters:

enabled – boolean

enabled()

Return type:

boolean

configStation()

Return type:

ConfigStation

Returns the parent ConfigStation if available. Returns None if the parent is not a ConfigStation. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Setup.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

SourceTimeFunction

class seiscomp.datamodel.SourceTimeFunction

Inherits Object.

Source time function used in moment-tensor inversion.

Attributes:

• type – SourceTimeFunctionType

• duration – float

• riseTime – float (optional)

• decayTime – float (optional)

Used by:

• MomentTensor.sourceTimeFunction()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type SourceTimeFunction if the cast was successful, None otherwise.

Cast an arbitrary object to SourceTimeFunction if the internal wrapped representation is an SourceTimeFunction object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type SourceTimeFunction to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setType(type)

Parameters:

type – SourceTimeFunctionType

Type of source time function. Values can be taken from the following: BOX_CAR, TRIANGLE, TRAPEZOID, UNKNOWN_FUNCTION.

type()

Return type:

SourceTimeFunctionType

setDuration(duration)

Parameters:

duration – float

Source time function duration in seconds.

duration()

Return type:

float

setRiseTime(riseTime)

Parameters:

riseTime – float

Source time function rise time in seconds.

riseTime()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDecayTime(decayTime)

Parameters:

decayTime – float

Source time function decay time in seconds.

decayTime()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

Station

class seiscomp.datamodel.Station

Inherits PublicObject.

This type describes a seismic station

Parents:

• network – Network

Children:

• comment – Comment

• sensorLocation – SensorLocation

Attributes:

• publicID: string

• code – string

• start – seiscomp.core.Time

• end – seiscomp.core.Time (optional)

• description – string

• latitude – float (optional)

• longitude – float (optional)

• elevation – float (optional)

• place – string

• country – string

• affiliation – string

• type – string

• archive – string

• archiveNetworkCode – string

• restricted – boolean (optional)

• shared – boolean (optional)

• remark – Blob (optional)

Referenced by:

• StationReference.stationID()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Station if the cast was successful, None otherwise.

Cast an arbitrary object to Station if the internal wrapped representation is an Station object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type Station.

Creates and registers (if enabled) a Station instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type Station.

Creates and registers (if enabled) a Station instance with passed publicID.

equal(other)

Parameters:

other – Another object of type Station to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type StationIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – Station

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setCode(code)

Parameters:

code – string

Station code (50.03)

code()

Return type:

string

setStart(start)

Parameters:

start – seiscomp.core.Time

Start of station epoch in ISO datetime format

start()

Return type:

seiscomp.core.Time

setEnd(end)

Parameters:

end – seiscomp.core.Time

End of station epoch. Empty string if the station is open

end()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDescription(description)

Parameters:

description – string

Station description in ASCII (50.09)

description()

Return type:

string

setLatitude(latitude)

Parameters:

latitude – float

Station latitude (50.04) with respect to the World Geodetic System 1984 (WGS84) reference system (National Imagery and Mapping Agency 2000) in degrees.

latitude()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setLongitude(longitude)

Parameters:

longitude – float

Station longitude (50.05) with respect to the World Geodetic System 1984 (WGS84) reference system (National Imagery and Mapping Agency 2000) in degrees.

longitude()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setElevation(elevation)

Parameters:

elevation – float

Station elevation (50.06) with respect to the World Geodetic System 1984 (WGS84) reference system (National Imagery and Mapping Agency 2000) in meters.

elevation()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setPlace(place)

Parameters:

place – string

Place where the station is located (UTF-8)

place()

Return type:

string

setCountry(country)

Parameters:

country – string

Country where the station is located (UTF-8)

country()

Return type:

string

setAffiliation(affiliation)

Parameters:

affiliation – string

Station affiliation (eg., GEOFON)

affiliation()

Return type:

string

setType(type)

Parameters:

type – string

Type of station (eg., VBB, SP)

type()

Return type:

string

setArchive(archive)

Parameters:

archive – string

Archive/Datacenter ID (metadata authority)

archive()

Return type:

string

setArchiveNetworkCode(archiveNetworkCode)

Parameters:

archiveNetworkCode – string

Internal network code, under which this station is archived

archiveNetworkCode()

Return type:

string

setRestricted(restricted)

Parameters:

restricted – boolean

Whether the station is "restricted"

restricted()

Return type:

boolean

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setShared(shared)

Parameters:

shared – boolean

Whether the metadata is synchronized with other datacenters

shared()

Return type:

boolean

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setRemark(remark)

Parameters:

remark – Blob

Any notes

remark()

Return type:

Blob

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Comment object to Station. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

add(sensorLocation)

Parameters:

sensorLocation – Object of type SensorLocation

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a SensorLocation object to Station. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Comment object from Station.

remove(sensorLocation)

Parameters:

sensorLocation – Object of type SensorLocation

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added SensorLocation object from Station.

removeComment(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeComment(commentIndex);

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

removeSensorLocation(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeSensorLocation(sensorLocationIndex);

Parameters:

sensorLocationIndex – The index of the object to be removed of type SensorLocationIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

commentCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Comment child objects.

sensorLocationCount()

Return type:

integer value indicating the number of child objects.

Returns the number of SensorLocation child objects.

comment(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Comment.

Returns the Comment at index idx.

comment(commentIndex)

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

Object of type Comment.

Returns the Comment at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

sensorLocation(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type SensorLocation.

Returns the SensorLocation at index idx.

sensorLocation(sensorLocationIndex)

Parameters:

sensorLocationIndex – The index of the object to be removed of type SensorLocationIndex.

Return type:

Object of type SensorLocation.

Returns the SensorLocation at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

findSensorLocation(publicID)

Parameters:

publicID – The publicID of the object to find.

Return type:

Object of type SensorLocation.

Returns the child object with a certain publicID, None otherwise.

network()

Return type:

Network

Returns the parent Network if available. Returns None if the parent is not a Network. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Station.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

StationGroup

class seiscomp.datamodel.StationGroup

Inherits PublicObject.

This type describes a group of stations, an array or a virtual network

Parents:

• inventory – Inventory

Children:

• stationReference – StationReference

Attributes:

• publicID: string

• type – StationGroupType (optional)

• code – string

• start – seiscomp.core.Time (optional)

• end – seiscomp.core.Time (optional)

• description – string

• latitude – float (optional)

• longitude – float (optional)

• elevation – float (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type StationGroup if the cast was successful, None otherwise.

Cast an arbitrary object to StationGroup if the internal wrapped representation is an StationGroup object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type StationGroup.

Creates and registers (if enabled) a StationGroup instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type StationGroup.

Creates and registers (if enabled) a StationGroup instance with passed publicID.

equal(other)

Parameters:

other – Another object of type StationGroup to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type StationGroupIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – StationGroup

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setType(type)

Parameters:

type – StationGroupType

ARRAY or DEPLOYMENT

type()

Return type:

StationGroupType

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setCode(code)

Parameters:

code – string

Virtual network code (up to 20 characters)

code()

Return type:

string

setStart(start)

Parameters:

start – seiscomp.core.Time

Start of epoch in ISO datetime format

start()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setEnd(end)

Parameters:

end – seiscomp.core.Time

End of epoch (empty string if the station is open)

end()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDescription(description)

Parameters:

description – string

Station group description

description()

Return type:

string

setLatitude(latitude)

Parameters:

latitude – float

Optional latitude (eg., of the central station) with respect to the World Geodetic System 1984 (WGS84) reference system (National Imagery and Mapping Agency 2000) in degrees. The uncertainties are given in kilometers.

latitude()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setLongitude(longitude)

Parameters:

longitude – float

Optional longitude (eg., of the central station) with respect to the World Geodetic System 1984 (WGS84) reference system (National Imagery and Mapping Agency 2000) in degrees.

longitude()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setElevation(elevation)

Parameters:

elevation – float

Optional elevation (eg., of the central station) with respect to the World Geodetic System 1984 (WGS84) reference system (National Imagery and Mapping Agency 2000) in meters.

elevation()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(stationReference)

Parameters:

stationReference – Object of type StationReference

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a StationReference object to StationGroup. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(stationReference)

Parameters:

stationReference – Object of type StationReference

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added StationReference object from StationGroup.

removeStationReference(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeStationReference(stationReferenceIndex);

Parameters:

stationReferenceIndex – The index of the object to be removed of type StationReferenceIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

stationReferenceCount()

Return type:

integer value indicating the number of child objects.

Returns the number of StationReference child objects.

stationReference(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type StationReference.

Returns the StationReference at index idx.

stationReference(stationReferenceIndex)

Parameters:

stationReferenceIndex – The index of the object to be removed of type StationReferenceIndex.

Return type:

Object of type StationReference.

Returns the StationReference at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

inventory()

Return type:

Inventory

Returns the parent Inventory if available. Returns None if the parent is not a Inventory. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned StationGroup.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

StationMagnitude

class seiscomp.datamodel.StationMagnitude

Inherits PublicObject.

This class describes the magnitude derived from a single waveform stream.

Parents:

• origin – Origin

Children:

• comment – Comment

Attributes:

• publicID: string

• originID – string

• magnitude – RealQuantity

• type – string

• amplitudeID – string

• methodID – string

• waveformID – WaveformStreamID (optional)

• passedQC – boolean (optional)

• creationInfo – CreationInfo (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type StationMagnitude if the cast was successful, None otherwise.

Cast an arbitrary object to StationMagnitude if the internal wrapped representation is an StationMagnitude object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type StationMagnitude.

Creates and registers (if enabled) a StationMagnitude instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type StationMagnitude.

Creates and registers (if enabled) a StationMagnitude instance with passed publicID.

equal(other)

Parameters:

other – Another object of type StationMagnitude to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setOriginID(originID)

Parameters:

originID – string

Reference to an origin’s publicID if the StationMagnitude has an associated Origin.

originID()

Return type:

string

setMagnitude(magnitude)

Parameters:

magnitude – RealQuantity

Estimated magnitude as RealQuantity.

magnitude()

Return type:

RealQuantity

setType(type)

Parameters:

type – string

See class Magnitude.

type()

Return type:

string

setAmplitudeID(amplitudeID)

Parameters:

amplitudeID – string

Identifies the data source of the StationMagnitude. For magnitudes derived from amplitudes in waveforms (e. g., local magnitude ML ), amplitudeID points to publicID in class Amplitude.

amplitudeID()

Return type:

string

setMethodID(methodID)

Parameters:

methodID – string

See class Magnitude.

methodID()

Return type:

string

setWaveformID(waveformID)

Parameters:

waveformID – WaveformStreamID

Identifies the waveform stream. This element can be helpful if no amplitude is referenced, or the amplitude is not available in the context. Otherwise, it would duplicate the waveformID provided there and can be omitted.

waveformID()

Return type:

WaveformStreamID

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setPassedQC(passedQC)

Parameters:

passedQC – boolean

An optional flag that indicates whether a station magnitude has passed the quality control or not. For example, if a station magnitude is out of the defined distance range but should be associated to a network magnitude for further analysis then this flag can be set to false. If the flag is not set, it defaults to true.

passedQC()

Return type:

boolean

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setCreationInfo(creationInfo)

Parameters:

creationInfo – CreationInfo

CreationInfo for the StationMagnitude object.

creationInfo()

Return type:

CreationInfo

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Comment object to StationMagnitude. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Comment object from StationMagnitude.

removeComment(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeComment(commentIndex);

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

commentCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Comment child objects.

comment(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Comment.

Returns the Comment at index idx.

comment(commentIndex)

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

Object of type Comment.

Returns the Comment at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

origin()

Return type:

Origin

Returns the parent Origin if available. Returns None if the parent is not a Origin. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned StationMagnitude.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

StationMagnitudeContribution

class seiscomp.datamodel.StationMagnitudeContribution

Inherits Object.

This class describes the weighting of magnitude values from several StationMagnitude objects for computing a network magnitude estimation.

Parents:

• magnitude – Magnitude

Attributes:

• stationMagnitudeID – string

• residual – float (optional)

• weight – float (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type StationMagnitudeContribution if the cast was successful, None otherwise.

Cast an arbitrary object to StationMagnitudeContribution if the internal wrapped representation is an StationMagnitudeContribution object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type StationMagnitudeContribution to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type StationMagnitudeContributionIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – StationMagnitudeContribution

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setStationMagnitudeID(stationMagnitudeID)

Parameters:

stationMagnitudeID – string

Refers to the publicID of a StationMagnitude object.

stationMagnitudeID()

Return type:

string

setResidual(residual)

Parameters:

residual – float

Residual of magnitude computation.

residual()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setWeight(weight)

Parameters:

weight – float

Weight of the magnitude value from class StationMagnitude for computing the magnitude value in class Magnitude. Note that there is no rule for the sum of the weights of all station magnitude contributions to a specific network magnitude. In particular, the weights are not required to sum up to unity.

weight()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

magnitude()

Return type:

Magnitude

Returns the parent Magnitude if available. Returns None if the parent is not a Magnitude. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned StationMagnitudeContribution.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

StationReference

class seiscomp.datamodel.StationReference

Inherits Object.

This type describes a station reference within a station group

Parents:

• stationGroup – StationGroup

Attributes:

• stationID – string

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type StationReference if the cast was successful, None otherwise.

Cast an arbitrary object to StationReference if the internal wrapped representation is an StationReference object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type StationReference to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type StationReferenceIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – StationReference

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setStationID(stationID)

Parameters:

stationID – string

Reference to network/station/@publicID

stationID()

Return type:

string

stationGroup()

Return type:

StationGroup

Returns the parent StationGroup if available. Returns None if the parent is not a StationGroup. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned StationReference.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Stream

class seiscomp.datamodel.Stream

Inherits PublicObject.

This type describes a stream (channel) with defined frequency response

Parents:

• sensorLocation – SensorLocation

Children:

• comment – Comment

Attributes:

• publicID: string

• code – string

• start – seiscomp.core.Time

• end – seiscomp.core.Time (optional)

• datalogger – string

• dataloggerSerialNumber – string

• dataloggerChannel – int (optional)

• sensor – string

• sensorSerialNumber – string

• sensorChannel – int (optional)

• clockSerialNumber – string

• sampleRateNumerator – int (optional)

• sampleRateDenominator – int (optional)

• depth – float (optional)

• azimuth – float (optional)

• dip – float (optional)

• gain – float (optional)

• gainFrequency – float (optional)

• gainUnit – string

• format – string

• flags – string

• restricted – boolean (optional)

• shared – boolean (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Stream if the cast was successful, None otherwise.

Cast an arbitrary object to Stream if the internal wrapped representation is an Stream object. The cast is important if instances of type Object are passed to methods which need access to the real type.

static Create()

Return type:

A new object of type Stream.

Creates and registers (if enabled) a Stream instance. The publicID is auto-generated.

static Create(publicID)

Return type:

A new object of type Stream.

Creates and registers (if enabled) a Stream instance with passed publicID.

equal(other)

Parameters:

other – Another object of type Stream to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type StreamIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – Stream

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setCode(code)

Parameters:

code – string

Stream code (52.04)

code()

Return type:

string

setStart(start)

Parameters:

start – seiscomp.core.Time

Start of epoch in ISO datetime format (52.22)

start()

Return type:

seiscomp.core.Time

setEnd(end)

Parameters:

end – seiscomp.core.Time

End of epoch (52.23)

end()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDatalogger(datalogger)

Parameters:

datalogger – string

Reference to datalogger/@publicID

datalogger()

Return type:

string

setDataloggerSerialNumber(dataloggerSerialNumber)

Parameters:

dataloggerSerialNumber – string

Reference to datalogger/calibration/@serialNumber

dataloggerSerialNumber()

Return type:

string

setDataloggerChannel(dataloggerChannel)

Parameters:

dataloggerChannel – int

Reference to datalogger/calibration/@channel

dataloggerChannel()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setSensor(sensor)

Parameters:

sensor – string

Reference to sensor/@publicID

sensor()

Return type:

string

setSensorSerialNumber(sensorSerialNumber)

Parameters:

sensorSerialNumber – string

Reference to sensor/calibration/@serialNumber

sensorSerialNumber()

Return type:

string

setSensorChannel(sensorChannel)

Parameters:

sensorChannel – int

Reference to sensor/calibration/@channel

sensorChannel()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setClockSerialNumber(clockSerialNumber)

Parameters:

clockSerialNumber – string

Serial no. of clock (GPS). Mostly unused

clockSerialNumber()

Return type:

string

setSampleRateNumerator(sampleRateNumerator)

Parameters:

sampleRateNumerator – int

Sample rate numerator (always >0, eg., not identical to 52.18)

sampleRateNumerator()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setSampleRateDenominator(sampleRateDenominator)

Parameters:

sampleRateDenominator – int

Sample rate denominator (always >0, eg., not identical to 52.19)

sampleRateDenominator()

Return type:

int

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDepth(depth)

Parameters:

depth – float

Depth (52.13) of the sensor below sensorLocation in meters

depth()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setAzimuth(azimuth)

Parameters:

azimuth – float

Azimuth (52.14)

azimuth()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setDip(dip)

Parameters:

dip – float

Dip (52.15)

dip()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setGain(gain)

Parameters:

gain – float

Overall sensitivity (58.04) in counts/gainUnit

gain()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setGainFrequency(gainFrequency)

Parameters:

gainFrequency – float

Gain frequency (58.05)

gainFrequency()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setGainUnit(gainUnit)

Parameters:

gainUnit – string

Sensor’s unit of measurement (eg., M/S, M/S**2)

gainUnit()

Return type:

string

setFormat(format)

Parameters:

format – string

Data format, eg.: "steim1", "steim2", "mseedN" (N = encoding format in blockette 1000)

format()

Return type:

string

setFlags(flags)

Parameters:

flags – string

Channel flags (52.21)

flags()

Return type:

string

setRestricted(restricted)

Parameters:

restricted – boolean

Whether the stream is "restricted"

restricted()

Return type:

boolean

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setShared(shared)

Parameters:

shared – boolean

Whether the metadata is synchronized with other datacenters

shared()

Return type:

boolean

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

add(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Adds a Comment object to Stream. The object is not copied but managed by this instance. Any change to the passed object will also change the child.

remove(comment)

Parameters:

comment – Object of type Comment

Return type:

A Boolean value indicating success with True, False otherwise.

Removes a previously added Comment object from Stream.

removeComment(idx)

Parameters:

idx – An integer index of the object to be removed.

Return type:

A Boolean value indicating success with True, False otherwise.

removeComment(commentIndex);

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

A Boolean value indicating success with True, False otherwise.

commentCount()

Return type:

integer value indicating the number of child objects.

Returns the number of Comment child objects.

comment(idx)

Parameters:

idx – An integer index of the object to be returned.

Return type:

Object of type Comment.

Returns the Comment at index idx.

comment(commentIndex)

Parameters:

commentIndex – The index of the object to be removed of type CommentIndex.

Return type:

Object of type Comment.

Returns the Comment at given index. The indexes of all child objects are compared by value which makes this function slower than the direct integer index look-up.

sensorLocation()

Return type:

SensorLocation

Returns the parent SensorLocation if available. Returns None if the parent is not a SensorLocation. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned Stream.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

updateChild(ref)

Parameters:

ref – A child object derived from class Object.

Return type:

A Boolean flag indicating success with True, False otherwise

This method takes the passed reference object and searches for a child with the same publicID (if derived from PublicObject) or the same index (if derived from Object). The the child was found the reference objects attributes are copied to the child object. Children of child are being ignored during this operation. This method implements the PublicObject interface.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

Tensor

class seiscomp.datamodel.Tensor

Inherits Object.

The Tensor class represents the six moment-tensor elements Mrr , Mtt , Mpp , Mrt , Mrp , Mtp in the spherical coordinate system defined by local upward vertical (r), North-South (t), and West-East (p) directions. See Aki and Richards (1980) for conversions to other coordinate systems.

Attributes:

• Mrr – RealQuantity

• Mtt – RealQuantity

• Mpp – RealQuantity

• Mrt – RealQuantity

• Mrp – RealQuantity

• Mtp – RealQuantity

Used by:

• MomentTensor.tensor()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type Tensor if the cast was successful, None otherwise.

Cast an arbitrary object to Tensor if the internal wrapped representation is an Tensor object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type Tensor to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setMrr(Mrr)

Parameters:

Mrr – RealQuantity

Moment-tensor element Mrr in Nm.

Mrr()

Return type:

RealQuantity

setMtt(Mtt)

Parameters:

Mtt – RealQuantity

Moment-tensor element Mtt in Nm.

Mtt()

Return type:

RealQuantity

setMpp(Mpp)

Parameters:

Mpp – RealQuantity

Moment-tensor element Mpp in Nm.

Mpp()

Return type:

RealQuantity

setMrt(Mrt)

Parameters:

Mrt – RealQuantity

Moment-tensor element Mrt in Nm.

Mrt()

Return type:

RealQuantity

setMrp(Mrp)

Parameters:

Mrp – RealQuantity

Moment-tensor element Mrp in Nm.

Mrp()

Return type:

RealQuantity

setMtp(Mtp)

Parameters:

Mtp – RealQuantity

Moment-tensor element Mtp in Nm.

Mtp()

Return type:

RealQuantity

TimeArray

class seiscomp.datamodel.TimeArray

Inherits Object.

Attributes:

• content – seiscomp.core.Time (optional)

Used by:

• TimePDF1D.variable()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type TimeArray if the cast was successful, None otherwise.

Cast an arbitrary object to TimeArray if the internal wrapped representation is an TimeArray object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type TimeArray to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setContent(content)

Parameters:

content – seiscomp.core.Time

content()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

TimePDF1D

class seiscomp.datamodel.TimePDF1D

Inherits Object.

A probability density function description. It can be used in three different modes:

1) "raw samples mode"

variable is a list of M values, no probability. The values represent samples, no binning/probabilities made.

2) "implicitly binned PDF"

variable and probabilty arrays have length N. variable values to be interpreted as "bin centers" (or representative values), no bin edges given.

3) "explicitly binned PDF"

variable has length N+1, probability has length N. variable values describe bin edges (upper bin edge is lower edge of next bin).

Attributes:

• variable – TimeArray

• probability – RealArray

Used by:

• TimeQuantity.pdf()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type TimePDF1D if the cast was successful, None otherwise.

Cast an arbitrary object to TimePDF1D if the internal wrapped representation is an TimePDF1D object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type TimePDF1D to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setVariable(variable)

Parameters:

variable – TimeArray

List of datetimes

variable()

Return type:

TimeArray

setProbability(probability)

Parameters:

probability – RealArray

List of probabilities

probability()

Return type:

RealArray

TimeQuantity

class seiscomp.datamodel.TimeQuantity

Inherits Object.

This type describes a point in time, given in ISO 8601 format, with optional symmetric or asymmetric uncertainties given in seconds. The time has to be specified in UTC.

Attributes:

• value – seiscomp.core.Time

• uncertainty – float (optional)

• lowerUncertainty – float (optional)

• upperUncertainty – float (optional)

• confidenceLevel – float (optional)

• pdf – TimePDF1D (optional)

Used by:

• Amplitude.scalingTime()

• Origin.time()

• Pick.time()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type TimeQuantity if the cast was successful, None otherwise.

Cast an arbitrary object to TimeQuantity if the internal wrapped representation is an TimeQuantity object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type TimeQuantity to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setValue(value)

Parameters:

value – seiscomp.core.Time

Point in time (UTC), given in ISO 8601 format.

value()

Return type:

seiscomp.core.Time

setUncertainty(uncertainty)

Parameters:

uncertainty – float

Symmetric uncertainty of point in time in seconds.

uncertainty()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setLowerUncertainty(lowerUncertainty)

Parameters:

lowerUncertainty – float

Lower uncertainty of point in time in seconds.

lowerUncertainty()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setUpperUncertainty(upperUncertainty)

Parameters:

upperUncertainty – float

Upper uncertainty of point in time in seconds.

upperUncertainty()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setConfidenceLevel(confidenceLevel)

Parameters:

confidenceLevel – float

Confidence level of the uncertainty, given in percent.

confidenceLevel()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setPdf(pdf)

Parameters:

pdf – TimePDF1D

Probability density function of the quantity.

pdf()

Return type:

TimePDF1D

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

TimeWindow

class seiscomp.datamodel.TimeWindow

Inherits Object.

Describes a time window for amplitude measurements, given by a central point in time, and points in time before and after this central point. Both points before and after may coincide with the central point.

Attributes:

• reference – seiscomp.core.Time

• begin – float

• end – float

Used by:

• Amplitude.timeWindow()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type TimeWindow if the cast was successful, None otherwise.

Cast an arbitrary object to TimeWindow if the internal wrapped representation is an TimeWindow object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type TimeWindow to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setReference(reference)

Parameters:

reference – seiscomp.core.Time

Reference point in time ("central" point), in ISO 8601 format. It has to be given in UTC.

reference()

Return type:

seiscomp.core.Time

setBegin(begin)

Parameters:

begin – float

Absolute value of duration of time interval before reference point in time window. The value may be zero, but not negative in seconds.

begin()

Return type:

float

setEnd(end)

Parameters:

end – float

Absolute value of duration of time interval after reference point in time window. The value may be zero, but not negative in seconds.

end()

Return type:

float

WaveformQuality

class seiscomp.datamodel.WaveformQuality

Inherits Object.

Parents:

• qualityControl – QualityControl

Attributes:

• waveformID – WaveformStreamID

• creatorID – string

• created – seiscomp.core.Time

• start – seiscomp.core.Time

• end – seiscomp.core.Time (optional)

• type – string

• parameter – string

• value – float

• lowerUncertainty – float (optional)

• upperUncertainty – float (optional)

• windowLength – float (optional)

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type WaveformQuality if the cast was successful, None otherwise.

Cast an arbitrary object to WaveformQuality if the internal wrapped representation is an WaveformQuality object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type WaveformQuality to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

index()

Return type:

The object’s index of type WaveformQualityIndex.

Returns the objects index which is also used for the database as unique constraint.

equalIndex(lhs)

Parameters:

lhs – WaveformQuality

Return type:

A Boolean value indicating True if both indexes are equal or False otherwise.

setWaveformID(waveformID)

Parameters:

waveformID – WaveformStreamID

waveformID()

Return type:

WaveformStreamID

setCreatorID(creatorID)

Parameters:

creatorID – string

creatorID()

Return type:

string

setCreated(created)

Parameters:

created – seiscomp.core.Time

created()

Return type:

seiscomp.core.Time

setStart(start)

Parameters:

start – seiscomp.core.Time

start()

Return type:

seiscomp.core.Time

setEnd(end)

Parameters:

end – seiscomp.core.Time

end()

Return type:

seiscomp.core.Time

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setType(type)

Parameters:

type – string

type()

Return type:

string

setParameter(parameter)

Parameters:

parameter – string

parameter()

Return type:

string

setValue(value)

Parameters:

value – float

value()

Return type:

float

setLowerUncertainty(lowerUncertainty)

Parameters:

lowerUncertainty – float

lowerUncertainty()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setUpperUncertainty(upperUncertainty)

Parameters:

upperUncertainty – float

upperUncertainty()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

setWindowLength(windowLength)

Parameters:

windowLength – float

windowLength()

Return type:

float

Note

As this attribute is optional, this method throws a ValueError if the value of the attribute is not set.

qualityControl()

Return type:

QualityControl

Returns the parent QualityControl if available. Returns None if the parent is not a QualityControl. This is a convenience wrapper for parent().

assign(other)

This method implements the Object interface.

attachTo(parent)

This method implements the Object interface.

detachFrom(parent)

This method implements the Object interface.

detach()

This method implements the Object interface.

clone()

Return type:

A cloned WaveformQuality.

Returns a new instance that is a clone of the current instance. Child objects are being ignored.

accept(visitor)

Parameters:

visitor – A visitor.

This method implements the PublicObject interface.

WaveformStreamID

class seiscomp.datamodel.WaveformStreamID

Inherits Object.

Reference to a stream description in an inventory. This is mostly equivalent to the combination of networkCode, stationCode, locationCode and channelCode. However, additional information, e. g., sampling rate, can be referenced by the resourceURI. It is recommended to use resourceURI as a flexible, abstract, and unique stream ID that allows to describe different processing levels, or resampled/filtered products of the same initial stream, without violating the intrinsic meaning of the legacy identifiers (network, station, channel, and location codes). However, for operation in the context of legacy systems, the classical identifier components are supported.

Attributes:

• networkCode – string

• stationCode – string

• locationCode – string

• channelCode – string

• resourceURI – string

Used by:

• Amplitude.waveformID()

• ArclinkRequestLine.streamID()

• DataExtent.waveformID()

• MomentTensorStationContribution.waveformID()

• Outage.waveformID()

• Pick.waveformID()

• QCLog.waveformID()

• StationMagnitude.waveformID()

• WaveformQuality.waveformID()

Methods:

static Cast(obj)

Parameters:

obj – The object to be casted.

Return type:

An object of type WaveformStreamID if the cast was successful, None otherwise.

Cast an arbitrary object to WaveformStreamID if the internal wrapped representation is an WaveformStreamID object. The cast is important if instances of type Object are passed to methods which need access to the real type.

equal(other)

Parameters:

other – Another object of type WaveformStreamID to compare this instance to

Return type:

A Boolean value indicating True if both objects are equal or False otherwise.

Compares two objects without its child objects. Both objects are compared by value.

setNetworkCode(networkCode)

Parameters:

networkCode – string

Network code. String with a maximum length of 8 characters.

networkCode()

Return type:

string

setStationCode(stationCode)

Parameters:

stationCode – string

Station code. String with a maximum length of 8 characters.

stationCode()

Return type:

string

setLocationCode(locationCode)

Parameters:

locationCode – string

Location code. String with a maximum length of 8 characters.

locationCode()

Return type:

string

setChannelCode(channelCode)

Parameters:

channelCode – string

Channel code. String with a maximum length of 8 characters.

channelCode()

Return type:

string

setResourceURI(resourceURI)

Parameters:

resourceURI – string

Optional resource identifier for the waveform stream. QuakeML adopts in many places resource descriptors with a well-defined syntax for unambiguous resource identification. Resource identifiers are designed to be backward compatible with existing descriptors. In SeisComP this identifier is not used at all.

resourceURI()

Return type:

string