seiscomp.datamodel

Classes

  • Object

  • PublicObject

  • Notifier

  • EventParameters

    digraph G { graph [size="8, 100"] node [fontname=Verdana,fontsize=8] node [shape=plaintext] node [penwidth=0.5] node [style="rounded,filled"] node [fillcolor="#fcf2e3"] node [color="#000000"] edge [color="#000000"] layout="dot" Pick [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Pick</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="time"><font color="#8b0000">+ time: TimeQuantity</font></td></tr><tr><td align="left" port="waveformID"><font color="#8b0000">+ waveformID: WaveformStreamID</font></td></tr><tr><td align="left" port="filterID"><font color="#8b0000">+ filterID: string</font></td></tr><tr><td align="left" port="methodID"><font color="#8b0000">+ methodID: string</font></td></tr><tr><td align="left" port="horizontalSlowness"><font color="#8b0000">+ horizontalSlowness: RealQuantity [0..1]</font></td></tr><tr><td align="left" port="backazimuth"><font color="#8b0000">+ backazimuth: RealQuantity [0..1]</font></td></tr><tr><td align="left" port="slownessMethodID"><font color="#8b0000">+ slownessMethodID: string</font></td></tr><tr><td align="left" port="onset"><font color="#8b0000">+ onset: PickOnset [0..1]</font></td></tr><tr><td align="left" port="phaseHint"><font color="#8b0000">+ phaseHint: Phase [0..1]</font></td></tr><tr><td align="left" port="polarity"><font color="#8b0000">+ polarity: PickPolarity [0..1]</font></td></tr><tr><td align="left" port="evaluationMode"><font color="#8b0000">+ evaluationMode: EvaluationMode [0..1]</font></td></tr><tr><td align="left" port="evaluationStatus"><font color="#8b0000">+ evaluationStatus: EvaluationStatus [0..1]</font></td></tr><tr><td align="left" port="creationInfo"><font color="#8b0000">+ creationInfo: CreationInfo [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ comment: Comment [0..*]</font></td></tr></table>>] Comment [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Comment</td></tr><tr><td align="left" port="text"><font color="#8b0000">+ text: string</font></td></tr><tr><td align="left" port="id"><font color="#8b0000">+ id: string</font></td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime [0..1]</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime [0..1]</font></td></tr><tr><td align="left" port="creationInfo"><font color="#8b0000">+ creationInfo: CreationInfo [0..1]</font></td></tr></table>>] Amplitude [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Amplitude</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="type"><font color="#8b0000">+ type: string</font></td></tr><tr><td align="left" port="amplitude"><font color="#8b0000">+ amplitude: RealQuantity [0..1]</font></td></tr><tr><td align="left" port="timeWindow"><font color="#8b0000">+ timeWindow: TimeWindow [0..1]</font></td></tr><tr><td align="left" port="period"><font color="#8b0000">+ period: RealQuantity [0..1]</font></td></tr><tr><td align="left" port="snr"><font color="#8b0000">+ snr: float [0..1]</font></td></tr><tr><td align="left" port="unit"><font color="#8b0000">+ unit: string</font></td></tr><tr><td align="left" port="pickID"><font color="#8b0000">+ pickID: string</font></td></tr><tr><td align="left" port="waveformID"><font color="#8b0000">+ waveformID: WaveformStreamID [0..1]</font></td></tr><tr><td align="left" port="filterID"><font color="#8b0000">+ filterID: string</font></td></tr><tr><td align="left" port="methodID"><font color="#8b0000">+ methodID: string</font></td></tr><tr><td align="left" port="scalingTime"><font color="#8b0000">+ scalingTime: TimeQuantity [0..1]</font></td></tr><tr><td align="left" port="magnitudeHint"><font color="#8b0000">+ magnitudeHint: string</font></td></tr><tr><td align="left" port="evaluationMode"><font color="#8b0000">+ evaluationMode: EvaluationMode [0..1]</font></td></tr><tr><td align="left" port="creationInfo"><font color="#8b0000">+ creationInfo: CreationInfo [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ comment: Comment [0..*]</font></td></tr></table>>] Reading [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Reading</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left"><font color="#8b0000">+ pickReference: PickReference [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ amplitudeReference: AmplitudeReference [0..*]</font></td></tr></table>>] PickReference [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>PickReference</td></tr><tr><td align="left" port="pickID"><font color="#8b0000">+ pickID: string</font></td></tr></table>>] AmplitudeReference [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>AmplitudeReference</td></tr><tr><td align="left" port="amplitudeID"><font color="#8b0000">+ amplitudeID: string</font></td></tr></table>>] Origin [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Origin</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="time"><font color="#8b0000">+ time: TimeQuantity</font></td></tr><tr><td align="left" port="latitude"><font color="#8b0000">+ latitude: RealQuantity</font></td></tr><tr><td align="left" port="longitude"><font color="#8b0000">+ longitude: RealQuantity</font></td></tr><tr><td align="left" port="depth"><font color="#8b0000">+ depth: RealQuantity [0..1]</font></td></tr><tr><td align="left" port="depthType"><font color="#8b0000">+ depthType: OriginDepthType [0..1]</font></td></tr><tr><td align="left" port="timeFixed"><font color="#8b0000">+ timeFixed: boolean [0..1]</font></td></tr><tr><td align="left" port="epicenterFixed"><font color="#8b0000">+ epicenterFixed: boolean [0..1]</font></td></tr><tr><td align="left" port="referenceSystemID"><font color="#8b0000">+ referenceSystemID: string</font></td></tr><tr><td align="left" port="methodID"><font color="#8b0000">+ methodID: string</font></td></tr><tr><td align="left" port="earthModelID"><font color="#8b0000">+ earthModelID: string</font></td></tr><tr><td align="left" port="quality"><font color="#8b0000">+ quality: OriginQuality [0..1]</font></td></tr><tr><td align="left" port="uncertainty"><font color="#8b0000">+ uncertainty: OriginUncertainty [0..1]</font></td></tr><tr><td align="left" port="type"><font color="#8b0000">+ type: OriginType [0..1]</font></td></tr><tr><td align="left" port="evaluationMode"><font color="#8b0000">+ evaluationMode: EvaluationMode [0..1]</font></td></tr><tr><td align="left" port="evaluationStatus"><font color="#8b0000">+ evaluationStatus: EvaluationStatus [0..1]</font></td></tr><tr><td align="left" port="creationInfo"><font color="#8b0000">+ creationInfo: CreationInfo [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ comment: Comment [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ compositeTime: CompositeTime [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ arrival: Arrival [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ stationMagnitude: StationMagnitude [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ magnitude: Magnitude [0..*]</font></td></tr></table>>] CompositeTime [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>CompositeTime</td></tr><tr><td align="left" port="year"><font color="#8b0000">+ year: IntegerQuantity [0..1]</font></td></tr><tr><td align="left" port="month"><font color="#8b0000">+ month: IntegerQuantity [0..1]</font></td></tr><tr><td align="left" port="day"><font color="#8b0000">+ day: IntegerQuantity [0..1]</font></td></tr><tr><td align="left" port="hour"><font color="#8b0000">+ hour: IntegerQuantity [0..1]</font></td></tr><tr><td align="left" port="minute"><font color="#8b0000">+ minute: IntegerQuantity [0..1]</font></td></tr><tr><td align="left" port="second"><font color="#8b0000">+ second: RealQuantity [0..1]</font></td></tr></table>>] Arrival [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Arrival</td></tr><tr><td align="left" port="pickID"><font color="#8b0000">+ pickID: string</font></td></tr><tr><td align="left" port="phase"><font color="#8b0000">+ phase: Phase</font></td></tr><tr><td align="left" port="timeCorrection"><font color="#8b0000">+ timeCorrection: float [0..1]</font></td></tr><tr><td align="left" port="azimuth"><font color="#8b0000">+ azimuth: float [0..1]</font></td></tr><tr><td align="left" port="distance"><font color="#8b0000">+ distance: float [0..1]</font></td></tr><tr><td align="left" port="takeOffAngle"><font color="#8b0000">+ takeOffAngle: float [0..1]</font></td></tr><tr><td align="left" port="timeResidual"><font color="#8b0000">+ timeResidual: float [0..1]</font></td></tr><tr><td align="left" port="horizontalSlownessResidual"><font color="#8b0000">+ horizontalSlownessResidual: float [0..1]</font></td></tr><tr><td align="left" port="backazimuthResidual"><font color="#8b0000">+ backazimuthResidual: float [0..1]</font></td></tr><tr><td align="left" port="timeUsed"><font color="#8b0000">+ timeUsed: boolean [0..1]</font></td></tr><tr><td align="left" port="horizontalSlownessUsed"><font color="#8b0000">+ horizontalSlownessUsed: boolean [0..1]</font></td></tr><tr><td align="left" port="backazimuthUsed"><font color="#8b0000">+ backazimuthUsed: boolean [0..1]</font></td></tr><tr><td align="left" port="weight"><font color="#8b0000">+ weight: float [0..1]</font></td></tr><tr><td align="left" port="earthModelID"><font color="#8b0000">+ earthModelID: string</font></td></tr><tr><td align="left" port="preliminary"><font color="#8b0000">+ preliminary: boolean [0..1]</font></td></tr><tr><td align="left" port="creationInfo"><font color="#8b0000">+ creationInfo: CreationInfo [0..1]</font></td></tr></table>>] StationMagnitude [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>StationMagnitude</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="originID"><font color="#8b0000">+ originID: string</font></td></tr><tr><td align="left" port="magnitude"><font color="#8b0000">+ magnitude: RealQuantity</font></td></tr><tr><td align="left" port="type"><font color="#8b0000">+ type: string</font></td></tr><tr><td align="left" port="amplitudeID"><font color="#8b0000">+ amplitudeID: string</font></td></tr><tr><td align="left" port="methodID"><font color="#8b0000">+ methodID: string</font></td></tr><tr><td align="left" port="waveformID"><font color="#8b0000">+ waveformID: WaveformStreamID [0..1]</font></td></tr><tr><td align="left" port="passedQC"><font color="#8b0000">+ passedQC: boolean [0..1]</font></td></tr><tr><td align="left" port="creationInfo"><font color="#8b0000">+ creationInfo: CreationInfo [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ comment: Comment [0..*]</font></td></tr></table>>] Magnitude [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Magnitude</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="magnitude"><font color="#8b0000">+ magnitude: RealQuantity</font></td></tr><tr><td align="left" port="type"><font color="#8b0000">+ type: string</font></td></tr><tr><td align="left" port="originID"><font color="#8b0000">+ originID: string</font></td></tr><tr><td align="left" port="methodID"><font color="#8b0000">+ methodID: string</font></td></tr><tr><td align="left" port="stationCount"><font color="#8b0000">+ stationCount: int [0..1]</font></td></tr><tr><td align="left" port="azimuthalGap"><font color="#8b0000">+ azimuthalGap: float [0..1]</font></td></tr><tr><td align="left" port="evaluationStatus"><font color="#8b0000">+ evaluationStatus: EvaluationStatus [0..1]</font></td></tr><tr><td align="left" port="creationInfo"><font color="#8b0000">+ creationInfo: CreationInfo [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ comment: Comment [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ stationMagnitudeContribution: StationMagnitudeContribution [0..*]</font></td></tr></table>>] StationMagnitudeContribution [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>StationMagnitudeContribution</td></tr><tr><td align="left" port="stationMagnitudeID"><font color="#8b0000">+ stationMagnitudeID: string</font></td></tr><tr><td align="left" port="residual"><font color="#8b0000">+ residual: float [0..1]</font></td></tr><tr><td align="left" port="weight"><font color="#8b0000">+ weight: float [0..1]</font></td></tr></table>>] FocalMechanism [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>FocalMechanism</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="triggeringOriginID"><font color="#8b0000">+ triggeringOriginID: string</font></td></tr><tr><td align="left" port="nodalPlanes"><font color="#8b0000">+ nodalPlanes: NodalPlanes [0..1]</font></td></tr><tr><td align="left" port="principalAxes"><font color="#8b0000">+ principalAxes: PrincipalAxes [0..1]</font></td></tr><tr><td align="left" port="azimuthalGap"><font color="#8b0000">+ azimuthalGap: float [0..1]</font></td></tr><tr><td align="left" port="stationPolarityCount"><font color="#8b0000">+ stationPolarityCount: int [0..1]</font></td></tr><tr><td align="left" port="misfit"><font color="#8b0000">+ misfit: float [0..1]</font></td></tr><tr><td align="left" port="stationDistributionRatio"><font color="#8b0000">+ stationDistributionRatio: float [0..1]</font></td></tr><tr><td align="left" port="methodID"><font color="#8b0000">+ methodID: string</font></td></tr><tr><td align="left" port="evaluationMode"><font color="#8b0000">+ evaluationMode: EvaluationMode [0..1]</font></td></tr><tr><td align="left" port="evaluationStatus"><font color="#8b0000">+ evaluationStatus: EvaluationStatus [0..1]</font></td></tr><tr><td align="left" port="creationInfo"><font color="#8b0000">+ creationInfo: CreationInfo [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ comment: Comment [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ momentTensor: MomentTensor [0..*]</font></td></tr></table>>] MomentTensor [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>MomentTensor</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="derivedOriginID"><font color="#8b0000">+ derivedOriginID: string</font></td></tr><tr><td align="left" port="momentMagnitudeID"><font color="#8b0000">+ momentMagnitudeID: string</font></td></tr><tr><td align="left" port="scalarMoment"><font color="#8b0000">+ scalarMoment: RealQuantity [0..1]</font></td></tr><tr><td align="left" port="tensor"><font color="#8b0000">+ tensor: Tensor [0..1]</font></td></tr><tr><td align="left" port="variance"><font color="#8b0000">+ variance: float [0..1]</font></td></tr><tr><td align="left" port="varianceReduction"><font color="#8b0000">+ varianceReduction: float [0..1]</font></td></tr><tr><td align="left" port="doubleCouple"><font color="#8b0000">+ doubleCouple: float [0..1]</font></td></tr><tr><td align="left" port="clvd"><font color="#8b0000">+ clvd: float [0..1]</font></td></tr><tr><td align="left" port="iso"><font color="#8b0000">+ iso: float [0..1]</font></td></tr><tr><td align="left" port="greensFunctionID"><font color="#8b0000">+ greensFunctionID: string</font></td></tr><tr><td align="left" port="filterID"><font color="#8b0000">+ filterID: string</font></td></tr><tr><td align="left" port="sourceTimeFunction"><font color="#8b0000">+ sourceTimeFunction: SourceTimeFunction [0..1]</font></td></tr><tr><td align="left" port="methodID"><font color="#8b0000">+ methodID: string</font></td></tr><tr><td align="left" port="method"><font color="#8b0000">+ method: MomentTensorMethod [0..1]</font></td></tr><tr><td align="left" port="status"><font color="#8b0000">+ status: MomentTensorStatus [0..1]</font></td></tr><tr><td align="left" port="cmtName"><font color="#8b0000">+ cmtName: string</font></td></tr><tr><td align="left" port="cmtVersion"><font color="#8b0000">+ cmtVersion: string</font></td></tr><tr><td align="left" port="creationInfo"><font color="#8b0000">+ creationInfo: CreationInfo [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ comment: Comment [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ dataUsed: DataUsed [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ momentTensorPhaseSetting: MomentTensorPhaseSetting [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ momentTensorStationContribution: MomentTensorStationContribution [0..*]</font></td></tr></table>>] DataUsed [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>DataUsed</td></tr><tr><td align="left" port="waveType"><font color="#8b0000">+ waveType: DataUsedWaveType</font></td></tr><tr><td align="left" port="stationCount"><font color="#8b0000">+ stationCount: int</font></td></tr><tr><td align="left" port="componentCount"><font color="#8b0000">+ componentCount: int</font></td></tr><tr><td align="left" port="shortestPeriod"><font color="#8b0000">+ shortestPeriod: float [0..1]</font></td></tr></table>>] MomentTensorPhaseSetting [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>MomentTensorPhaseSetting</td></tr><tr><td align="left" port="code"><font color="#8b0000">+ code: string</font></td></tr><tr><td align="left" port="lowerPeriod"><font color="#8b0000">+ lowerPeriod: float</font></td></tr><tr><td align="left" port="upperPeriod"><font color="#8b0000">+ upperPeriod: float</font></td></tr><tr><td align="left" port="minimumSNR"><font color="#8b0000">+ minimumSNR: float [0..1]</font></td></tr><tr><td align="left" port="maximumTimeShift"><font color="#8b0000">+ maximumTimeShift: float [0..1]</font></td></tr></table>>] MomentTensorStationContribution [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>MomentTensorStationContribution</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="active"><font color="#8b0000">+ active: boolean</font></td></tr><tr><td align="left" port="waveformID"><font color="#8b0000">+ waveformID: WaveformStreamID [0..1]</font></td></tr><tr><td align="left" port="weight"><font color="#8b0000">+ weight: float [0..1]</font></td></tr><tr><td align="left" port="timeShift"><font color="#8b0000">+ timeShift: float [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ momentTensorComponentContribution: MomentTensorComponentContribution [0..*]</font></td></tr></table>>] MomentTensorComponentContribution [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>MomentTensorComponentContribution</td></tr><tr><td align="left" port="phaseCode"><font color="#8b0000">+ phaseCode: string</font></td></tr><tr><td align="left" port="component"><font color="#8b0000">+ component: int</font></td></tr><tr><td align="left" port="active"><font color="#8b0000">+ active: boolean</font></td></tr><tr><td align="left" port="weight"><font color="#8b0000">+ weight: float</font></td></tr><tr><td align="left" port="timeShift"><font color="#8b0000">+ timeShift: float</font></td></tr><tr><td align="left" port="dataTimeWindow"><font color="#8b0000">+ dataTimeWindow: float</font></td></tr><tr><td align="left" port="misfit"><font color="#8b0000">+ misfit: float [0..1]</font></td></tr><tr><td align="left" port="snr"><font color="#8b0000">+ snr: float [0..1]</font></td></tr></table>>] Event [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Event</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="preferredOriginID"><font color="#8b0000">+ preferredOriginID: string</font></td></tr><tr><td align="left" port="preferredMagnitudeID"><font color="#8b0000">+ preferredMagnitudeID: string</font></td></tr><tr><td align="left" port="preferredFocalMechanismID"><font color="#8b0000">+ preferredFocalMechanismID: string</font></td></tr><tr><td align="left" port="type"><font color="#8b0000">+ type: EventType [0..1]</font></td></tr><tr><td align="left" port="typeCertainty"><font color="#8b0000">+ typeCertainty: EventTypeCertainty [0..1]</font></td></tr><tr><td align="left" port="creationInfo"><font color="#8b0000">+ creationInfo: CreationInfo [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ eventDescription: EventDescription [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ comment: Comment [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ originReference: OriginReference [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ focalMechanismReference: FocalMechanismReference [0..*]</font></td></tr></table>>] EventDescription [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>EventDescription</td></tr><tr><td align="left" port="text"><font color="#8b0000">+ text: string</font></td></tr><tr><td align="left" port="type"><font color="#8b0000">+ type: EventDescriptionType</font></td></tr></table>>] OriginReference [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>OriginReference</td></tr><tr><td align="left" port="originID"><font color="#8b0000">+ originID: string</font></td></tr></table>>] FocalMechanismReference [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>FocalMechanismReference</td></tr><tr><td align="left" port="focalMechanismID"><font color="#8b0000">+ focalMechanismID: string</font></td></tr></table>>] EventParameters -> Pick MomentTensor -> Comment FocalMechanism -> Comment Amplitude -> Comment Magnitude -> Comment StationMagnitude -> Comment Pick -> Comment Event -> Comment Origin -> Comment EventParameters -> Amplitude EventParameters -> Reading Reading -> PickReference Reading -> AmplitudeReference EventParameters -> Origin Origin -> CompositeTime Origin -> Arrival Origin -> StationMagnitude Origin -> Magnitude Magnitude -> StationMagnitudeContribution EventParameters -> FocalMechanism FocalMechanism -> MomentTensor MomentTensor -> DataUsed MomentTensor -> MomentTensorPhaseSetting MomentTensor -> MomentTensorStationContribution MomentTensorStationContribution -> MomentTensorComponentContribution EventParameters -> Event Event -> EventDescription Event -> OriginReference Event -> FocalMechanismReference }

    EventParameters object connections from parent to child.

  • Config

    digraph G { graph [size="8, 100"] node [fontname=Verdana,fontsize=8] node [shape=plaintext] node [penwidth=0.5] node [style="rounded,filled"] node [fillcolor="#fcf2e3"] node [color="#000000"] edge [color="#000000"] layout="dot" ParameterSet [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>ParameterSet</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="baseID"><font color="#8b0000">+ baseID: string</font></td></tr><tr><td align="left" port="moduleID"><font color="#8b0000">+ moduleID: string</font></td></tr><tr><td align="left" port="created"><font color="#8b0000">+ created: datetime [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ parameter: Parameter [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ comment: Comment [0..*]</font></td></tr></table>>] Parameter [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Parameter</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="name"><font color="#8b0000">+ name: string</font></td></tr><tr><td align="left" port="value"><font color="#8b0000">+ value: string</font></td></tr><tr><td align="left"><font color="#8b0000">+ comment: Comment [0..*]</font></td></tr></table>>] Comment [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Comment</td></tr><tr><td align="left" port="text"><font color="#8b0000">+ text: string</font></td></tr><tr><td align="left" port="id"><font color="#8b0000">+ id: string</font></td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime [0..1]</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime [0..1]</font></td></tr><tr><td align="left" port="creationInfo"><font color="#8b0000">+ creationInfo: CreationInfo [0..1]</font></td></tr></table>>] ConfigModule [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>ConfigModule</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="name"><font color="#8b0000">+ name: string</font></td></tr><tr><td align="left" port="parameterSetID"><font color="#8b0000">+ parameterSetID: string</font></td></tr><tr><td align="left" port="enabled"><font color="#8b0000">+ enabled: boolean</font></td></tr><tr><td align="left"><font color="#8b0000">+ configStation: ConfigStation [0..*]</font></td></tr></table>>] ConfigStation [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>ConfigStation</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="networkCode"><font color="#8b0000">+ networkCode: string</font></td></tr><tr><td align="left" port="stationCode"><font color="#8b0000">+ stationCode: string</font></td></tr><tr><td align="left" port="enabled"><font color="#8b0000">+ enabled: boolean</font></td></tr><tr><td align="left" port="creationInfo"><font color="#8b0000">+ creationInfo: CreationInfo [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ setup: Setup [0..*]</font></td></tr></table>>] Setup [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Setup</td></tr><tr><td align="left" port="name"><font color="#8b0000">+ name: string</font></td></tr><tr><td align="left" port="parameterSetID"><font color="#8b0000">+ parameterSetID: string</font></td></tr><tr><td align="left" port="enabled"><font color="#8b0000">+ enabled: boolean</font></td></tr></table>>] Config -> ParameterSet ParameterSet -> Parameter Parameter -> Comment ParameterSet -> Comment Config -> ConfigModule ConfigModule -> ConfigStation ConfigStation -> Setup }

    Config object connections from parent to child.

  • QualityControl

    digraph G { graph [size="8, 100"] node [fontname=Verdana,fontsize=8] node [shape=plaintext] node [penwidth=0.5] node [style="rounded,filled"] node [fillcolor="#fcf2e3"] node [color="#000000"] edge [color="#000000"] layout="dot" QCLog [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>QCLog</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="waveformID"><font color="#8b0000">+ waveformID: WaveformStreamID</font></td></tr><tr><td align="left" port="creatorID"><font color="#8b0000">+ creatorID: string</font></td></tr><tr><td align="left" port="created"><font color="#8b0000">+ created: datetime</font></td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime</font></td></tr><tr><td align="left" port="message"><font color="#8b0000">+ message: string</font></td></tr></table>>] WaveformQuality [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>WaveformQuality</td></tr><tr><td align="left" port="waveformID"><font color="#8b0000">+ waveformID: WaveformStreamID</font></td></tr><tr><td align="left" port="creatorID"><font color="#8b0000">+ creatorID: string</font></td></tr><tr><td align="left" port="created"><font color="#8b0000">+ created: datetime</font></td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime [0..1]</font></td></tr><tr><td align="left" port="type"><font color="#8b0000">+ type: string</font></td></tr><tr><td align="left" port="parameter"><font color="#8b0000">+ parameter: string</font></td></tr><tr><td align="left" port="value"><font color="#8b0000">+ value: float</font></td></tr><tr><td align="left" port="lowerUncertainty"><font color="#8b0000">+ lowerUncertainty: float [0..1]</font></td></tr><tr><td align="left" port="upperUncertainty"><font color="#8b0000">+ upperUncertainty: float [0..1]</font></td></tr><tr><td align="left" port="windowLength"><font color="#8b0000">+ windowLength: float [0..1]</font></td></tr></table>>] Outage [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Outage</td></tr><tr><td align="left" port="waveformID"><font color="#8b0000">+ waveformID: WaveformStreamID</font></td></tr><tr><td align="left" port="creatorID"><font color="#8b0000">+ creatorID: string</font></td></tr><tr><td align="left" port="created"><font color="#8b0000">+ created: datetime</font></td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime [0..1]</font></td></tr></table>>] QualityControl -> QCLog QualityControl -> WaveformQuality QualityControl -> Outage }

    QualityControl object connections from parent to child.

  • Inventory

    digraph G { graph [size="8, 100"] node [fontname=Verdana,fontsize=8] node [shape=plaintext] node [penwidth=0.5] node [style="rounded,filled"] node [fillcolor="#fcf2e3"] node [color="#000000"] edge [color="#000000"] layout="dot" StationGroup [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>StationGroup</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="type"><font color="#8b0000">+ type: StationGroupType [0..1]</font></td></tr><tr><td align="left" port="code"><font color="#8b0000">+ code: string</font></td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime [0..1]</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime [0..1]</font></td></tr><tr><td align="left" port="description"><font color="#8b0000">+ description: string</font></td></tr><tr><td align="left" port="latitude"><font color="#8b0000">+ latitude: float [0..1]</font></td></tr><tr><td align="left" port="longitude"><font color="#8b0000">+ longitude: float [0..1]</font></td></tr><tr><td align="left" port="elevation"><font color="#8b0000">+ elevation: float [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ stationReference: StationReference [0..*]</font></td></tr></table>>] StationReference [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>StationReference</td></tr><tr><td align="left" port="stationID"><font color="#8b0000">+ stationID: string</font></td></tr></table>>] AuxDevice [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>AuxDevice</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="name"><font color="#8b0000">+ name: string</font></td></tr><tr><td align="left" port="description"><font color="#8b0000">+ description: string</font></td></tr><tr><td align="left" port="model"><font color="#8b0000">+ model: string</font></td></tr><tr><td align="left" port="manufacturer"><font color="#8b0000">+ manufacturer: string</font></td></tr><tr><td align="left" port="remark"><font color="#8b0000">+ remark: Blob [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ auxSource: AuxSource [0..*]</font></td></tr></table>>] AuxSource [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>AuxSource</td></tr><tr><td align="left" port="name"><font color="#8b0000">+ name: string</font></td></tr><tr><td align="left" port="description"><font color="#8b0000">+ description: string</font></td></tr><tr><td align="left" port="unit"><font color="#8b0000">+ unit: string</font></td></tr><tr><td align="left" port="conversion"><font color="#8b0000">+ conversion: string</font></td></tr><tr><td align="left" port="sampleRateNumerator"><font color="#8b0000">+ sampleRateNumerator: int [0..1]</font></td></tr><tr><td align="left" port="sampleRateDenominator"><font color="#8b0000">+ sampleRateDenominator: int [0..1]</font></td></tr><tr><td align="left" port="remark"><font color="#8b0000">+ remark: Blob [0..1]</font></td></tr></table>>] Sensor [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Sensor</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="name"><font color="#8b0000">+ name: string</font></td></tr><tr><td align="left" port="description"><font color="#8b0000">+ description: string</font></td></tr><tr><td align="left" port="model"><font color="#8b0000">+ model: string</font></td></tr><tr><td align="left" port="manufacturer"><font color="#8b0000">+ manufacturer: string</font></td></tr><tr><td align="left" port="type"><font color="#8b0000">+ type: string</font></td></tr><tr><td align="left" port="unit"><font color="#8b0000">+ unit: string</font></td></tr><tr><td align="left" port="lowFrequency"><font color="#8b0000">+ lowFrequency: float [0..1]</font></td></tr><tr><td align="left" port="highFrequency"><font color="#8b0000">+ highFrequency: float [0..1]</font></td></tr><tr><td align="left" port="response"><font color="#8b0000">+ response: string</font></td></tr><tr><td align="left" port="remark"><font color="#8b0000">+ remark: Blob [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ sensorCalibration: SensorCalibration [0..*]</font></td></tr></table>>] SensorCalibration [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>SensorCalibration</td></tr><tr><td align="left" port="serialNumber"><font color="#8b0000">+ serialNumber: string</font></td></tr><tr><td align="left" port="channel"><font color="#8b0000">+ channel: int</font></td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime [0..1]</font></td></tr><tr><td align="left" port="gain"><font color="#8b0000">+ gain: float [0..1]</font></td></tr><tr><td align="left" port="gainFrequency"><font color="#8b0000">+ gainFrequency: float [0..1]</font></td></tr><tr><td align="left" port="remark"><font color="#8b0000">+ remark: Blob [0..1]</font></td></tr></table>>] Datalogger [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Datalogger</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="name"><font color="#8b0000">+ name: string</font></td></tr><tr><td align="left" port="description"><font color="#8b0000">+ description: string</font></td></tr><tr><td align="left" port="digitizerModel"><font color="#8b0000">+ digitizerModel: string</font></td></tr><tr><td align="left" port="digitizerManufacturer"><font color="#8b0000">+ digitizerManufacturer: string</font></td></tr><tr><td align="left" port="recorderModel"><font color="#8b0000">+ recorderModel: string</font></td></tr><tr><td align="left" port="recorderManufacturer"><font color="#8b0000">+ recorderManufacturer: string</font></td></tr><tr><td align="left" port="clockModel"><font color="#8b0000">+ clockModel: string</font></td></tr><tr><td align="left" port="clockManufacturer"><font color="#8b0000">+ clockManufacturer: string</font></td></tr><tr><td align="left" port="clockType"><font color="#8b0000">+ clockType: string</font></td></tr><tr><td align="left" port="gain"><font color="#8b0000">+ gain: float [0..1]</font></td></tr><tr><td align="left" port="maxClockDrift"><font color="#8b0000">+ maxClockDrift: float [0..1]</font></td></tr><tr><td align="left" port="remark"><font color="#8b0000">+ remark: Blob [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ dataloggerCalibration: DataloggerCalibration [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ decimation: Decimation [0..*]</font></td></tr></table>>] DataloggerCalibration [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>DataloggerCalibration</td></tr><tr><td align="left" port="serialNumber"><font color="#8b0000">+ serialNumber: string</font></td></tr><tr><td align="left" port="channel"><font color="#8b0000">+ channel: int</font></td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime [0..1]</font></td></tr><tr><td align="left" port="gain"><font color="#8b0000">+ gain: float [0..1]</font></td></tr><tr><td align="left" port="gainFrequency"><font color="#8b0000">+ gainFrequency: float [0..1]</font></td></tr><tr><td align="left" port="remark"><font color="#8b0000">+ remark: Blob [0..1]</font></td></tr></table>>] Decimation [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Decimation</td></tr><tr><td align="left" port="sampleRateNumerator"><font color="#8b0000">+ sampleRateNumerator: int</font></td></tr><tr><td align="left" port="sampleRateDenominator"><font color="#8b0000">+ sampleRateDenominator: int</font></td></tr><tr><td align="left" port="analogueFilterChain"><font color="#8b0000">+ analogueFilterChain: Blob [0..1]</font></td></tr><tr><td align="left" port="digitalFilterChain"><font color="#8b0000">+ digitalFilterChain: Blob [0..1]</font></td></tr></table>>] ResponsePAZ [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>ResponsePAZ</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="name"><font color="#8b0000">+ name: string</font></td></tr><tr><td align="left" port="type"><font color="#8b0000">+ type: string</font></td></tr><tr><td align="left" port="gain"><font color="#8b0000">+ gain: float [0..1]</font></td></tr><tr><td align="left" port="gainFrequency"><font color="#8b0000">+ gainFrequency: float [0..1]</font></td></tr><tr><td align="left" port="normalizationFactor"><font color="#8b0000">+ normalizationFactor: float [0..1]</font></td></tr><tr><td align="left" port="normalizationFrequency"><font color="#8b0000">+ normalizationFrequency: float [0..1]</font></td></tr><tr><td align="left" port="numberOfZeros"><font color="#8b0000">+ numberOfZeros: int [0..1]</font></td></tr><tr><td align="left" port="numberOfPoles"><font color="#8b0000">+ numberOfPoles: int [0..1]</font></td></tr><tr><td align="left" port="zeros"><font color="#8b0000">+ zeros: ComplexArray [0..1]</font></td></tr><tr><td align="left" port="poles"><font color="#8b0000">+ poles: ComplexArray [0..1]</font></td></tr><tr><td align="left" port="remark"><font color="#8b0000">+ remark: Blob [0..1]</font></td></tr><tr><td align="left" port="decimationFactor"><font color="#8b0000">+ decimationFactor: int [0..1]</font></td></tr><tr><td align="left" port="delay"><font color="#8b0000">+ delay: float [0..1]</font></td></tr><tr><td align="left" port="correction"><font color="#8b0000">+ correction: float [0..1]</font></td></tr></table>>] ResponseFIR [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>ResponseFIR</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="name"><font color="#8b0000">+ name: string</font></td></tr><tr><td align="left" port="gain"><font color="#8b0000">+ gain: float [0..1]</font></td></tr><tr><td align="left" port="gainFrequency"><font color="#8b0000">+ gainFrequency: float [0..1]</font></td></tr><tr><td align="left" port="decimationFactor"><font color="#8b0000">+ decimationFactor: int [0..1]</font></td></tr><tr><td align="left" port="delay"><font color="#8b0000">+ delay: float [0..1]</font></td></tr><tr><td align="left" port="correction"><font color="#8b0000">+ correction: float [0..1]</font></td></tr><tr><td align="left" port="numberOfCoefficients"><font color="#8b0000">+ numberOfCoefficients: int [0..1]</font></td></tr><tr><td align="left" port="symmetry"><font color="#8b0000">+ symmetry: string</font></td></tr><tr><td align="left" port="coefficients"><font color="#8b0000">+ coefficients: RealArray [0..1]</font></td></tr><tr><td align="left" port="remark"><font color="#8b0000">+ remark: Blob [0..1]</font></td></tr></table>>] ResponseIIR [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>ResponseIIR</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="name"><font color="#8b0000">+ name: string</font></td></tr><tr><td align="left" port="type"><font color="#8b0000">+ type: string</font></td></tr><tr><td align="left" port="gain"><font color="#8b0000">+ gain: float [0..1]</font></td></tr><tr><td align="left" port="gainFrequency"><font color="#8b0000">+ gainFrequency: float [0..1]</font></td></tr><tr><td align="left" port="decimationFactor"><font color="#8b0000">+ decimationFactor: int [0..1]</font></td></tr><tr><td align="left" port="delay"><font color="#8b0000">+ delay: float [0..1]</font></td></tr><tr><td align="left" port="correction"><font color="#8b0000">+ correction: float [0..1]</font></td></tr><tr><td align="left" port="numberOfNumerators"><font color="#8b0000">+ numberOfNumerators: int [0..1]</font></td></tr><tr><td align="left" port="numberOfDenominators"><font color="#8b0000">+ numberOfDenominators: int [0..1]</font></td></tr><tr><td align="left" port="numerators"><font color="#8b0000">+ numerators: RealArray [0..1]</font></td></tr><tr><td align="left" port="denominators"><font color="#8b0000">+ denominators: RealArray [0..1]</font></td></tr><tr><td align="left" port="remark"><font color="#8b0000">+ remark: Blob [0..1]</font></td></tr></table>>] ResponsePolynomial [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>ResponsePolynomial</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="name"><font color="#8b0000">+ name: string</font></td></tr><tr><td align="left" port="gain"><font color="#8b0000">+ gain: float [0..1]</font></td></tr><tr><td align="left" port="gainFrequency"><font color="#8b0000">+ gainFrequency: float [0..1]</font></td></tr><tr><td align="left" port="frequencyUnit"><font color="#8b0000">+ frequencyUnit: string</font></td></tr><tr><td align="left" port="approximationType"><font color="#8b0000">+ approximationType: string</font></td></tr><tr><td align="left" port="approximationLowerBound"><font color="#8b0000">+ approximationLowerBound: float [0..1]</font></td></tr><tr><td align="left" port="approximationUpperBound"><font color="#8b0000">+ approximationUpperBound: float [0..1]</font></td></tr><tr><td align="left" port="approximationError"><font color="#8b0000">+ approximationError: float [0..1]</font></td></tr><tr><td align="left" port="numberOfCoefficients"><font color="#8b0000">+ numberOfCoefficients: int [0..1]</font></td></tr><tr><td align="left" port="coefficients"><font color="#8b0000">+ coefficients: RealArray [0..1]</font></td></tr><tr><td align="left" port="remark"><font color="#8b0000">+ remark: Blob [0..1]</font></td></tr></table>>] ResponseFAP [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>ResponseFAP</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="name"><font color="#8b0000">+ name: string</font></td></tr><tr><td align="left" port="gain"><font color="#8b0000">+ gain: float [0..1]</font></td></tr><tr><td align="left" port="gainFrequency"><font color="#8b0000">+ gainFrequency: float [0..1]</font></td></tr><tr><td align="left" port="numberOfTuples"><font color="#8b0000">+ numberOfTuples: int [0..1]</font></td></tr><tr><td align="left" port="tuples"><font color="#8b0000">+ tuples: RealArray [0..1]</font></td></tr><tr><td align="left" port="remark"><font color="#8b0000">+ remark: Blob [0..1]</font></td></tr></table>>] Network [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Network</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="code"><font color="#8b0000">+ code: string</font></td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime [0..1]</font></td></tr><tr><td align="left" port="description"><font color="#8b0000">+ description: string</font></td></tr><tr><td align="left" port="institutions"><font color="#8b0000">+ institutions: string</font></td></tr><tr><td align="left" port="region"><font color="#8b0000">+ region: string</font></td></tr><tr><td align="left" port="type"><font color="#8b0000">+ type: string</font></td></tr><tr><td align="left" port="netClass"><font color="#8b0000">+ netClass: string</font></td></tr><tr><td align="left" port="archive"><font color="#8b0000">+ archive: string</font></td></tr><tr><td align="left" port="restricted"><font color="#8b0000">+ restricted: boolean [0..1]</font></td></tr><tr><td align="left" port="shared"><font color="#8b0000">+ shared: boolean [0..1]</font></td></tr><tr><td align="left" port="remark"><font color="#8b0000">+ remark: Blob [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ comment: Comment [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ station: Station [0..*]</font></td></tr></table>>] Comment [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Comment</td></tr><tr><td align="left" port="text"><font color="#8b0000">+ text: string</font></td></tr><tr><td align="left" port="id"><font color="#8b0000">+ id: string</font></td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime [0..1]</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime [0..1]</font></td></tr><tr><td align="left" port="creationInfo"><font color="#8b0000">+ creationInfo: CreationInfo [0..1]</font></td></tr></table>>] Station [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Station</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="code"><font color="#8b0000">+ code: string</font></td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime [0..1]</font></td></tr><tr><td align="left" port="description"><font color="#8b0000">+ description: string</font></td></tr><tr><td align="left" port="latitude"><font color="#8b0000">+ latitude: float [0..1]</font></td></tr><tr><td align="left" port="longitude"><font color="#8b0000">+ longitude: float [0..1]</font></td></tr><tr><td align="left" port="elevation"><font color="#8b0000">+ elevation: float [0..1]</font></td></tr><tr><td align="left" port="place"><font color="#8b0000">+ place: string</font></td></tr><tr><td align="left" port="country"><font color="#8b0000">+ country: string</font></td></tr><tr><td align="left" port="affiliation"><font color="#8b0000">+ affiliation: string</font></td></tr><tr><td align="left" port="type"><font color="#8b0000">+ type: string</font></td></tr><tr><td align="left" port="archive"><font color="#8b0000">+ archive: string</font></td></tr><tr><td align="left" port="archiveNetworkCode"><font color="#8b0000">+ archiveNetworkCode: string</font></td></tr><tr><td align="left" port="restricted"><font color="#8b0000">+ restricted: boolean [0..1]</font></td></tr><tr><td align="left" port="shared"><font color="#8b0000">+ shared: boolean [0..1]</font></td></tr><tr><td align="left" port="remark"><font color="#8b0000">+ remark: Blob [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ comment: Comment [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ sensorLocation: SensorLocation [0..*]</font></td></tr></table>>] SensorLocation [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>SensorLocation</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="code"><font color="#8b0000">+ code: string</font></td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime [0..1]</font></td></tr><tr><td align="left" port="latitude"><font color="#8b0000">+ latitude: float [0..1]</font></td></tr><tr><td align="left" port="longitude"><font color="#8b0000">+ longitude: float [0..1]</font></td></tr><tr><td align="left" port="elevation"><font color="#8b0000">+ elevation: float [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ comment: Comment [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ auxStream: AuxStream [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ stream: Stream [0..*]</font></td></tr></table>>] AuxStream [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>AuxStream</td></tr><tr><td align="left" port="code"><font color="#8b0000">+ code: string</font></td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime [0..1]</font></td></tr><tr><td align="left" port="device"><font color="#8b0000">+ device: string</font></td></tr><tr><td align="left" port="deviceSerialNumber"><font color="#8b0000">+ deviceSerialNumber: string</font></td></tr><tr><td align="left" port="source"><font color="#8b0000">+ source: string</font></td></tr><tr><td align="left" port="format"><font color="#8b0000">+ format: string</font></td></tr><tr><td align="left" port="flags"><font color="#8b0000">+ flags: string</font></td></tr><tr><td align="left" port="restricted"><font color="#8b0000">+ restricted: boolean [0..1]</font></td></tr><tr><td align="left" port="shared"><font color="#8b0000">+ shared: boolean [0..1]</font></td></tr></table>>] Stream [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Stream</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="code"><font color="#8b0000">+ code: string</font></td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime [0..1]</font></td></tr><tr><td align="left" port="datalogger"><font color="#8b0000">+ datalogger: string</font></td></tr><tr><td align="left" port="dataloggerSerialNumber"><font color="#8b0000">+ dataloggerSerialNumber: string</font></td></tr><tr><td align="left" port="dataloggerChannel"><font color="#8b0000">+ dataloggerChannel: int [0..1]</font></td></tr><tr><td align="left" port="sensor"><font color="#8b0000">+ sensor: string</font></td></tr><tr><td align="left" port="sensorSerialNumber"><font color="#8b0000">+ sensorSerialNumber: string</font></td></tr><tr><td align="left" port="sensorChannel"><font color="#8b0000">+ sensorChannel: int [0..1]</font></td></tr><tr><td align="left" port="clockSerialNumber"><font color="#8b0000">+ clockSerialNumber: string</font></td></tr><tr><td align="left" port="sampleRateNumerator"><font color="#8b0000">+ sampleRateNumerator: int [0..1]</font></td></tr><tr><td align="left" port="sampleRateDenominator"><font color="#8b0000">+ sampleRateDenominator: int [0..1]</font></td></tr><tr><td align="left" port="depth"><font color="#8b0000">+ depth: float [0..1]</font></td></tr><tr><td align="left" port="azimuth"><font color="#8b0000">+ azimuth: float [0..1]</font></td></tr><tr><td align="left" port="dip"><font color="#8b0000">+ dip: float [0..1]</font></td></tr><tr><td align="left" port="gain"><font color="#8b0000">+ gain: float [0..1]</font></td></tr><tr><td align="left" port="gainFrequency"><font color="#8b0000">+ gainFrequency: float [0..1]</font></td></tr><tr><td align="left" port="gainUnit"><font color="#8b0000">+ gainUnit: string</font></td></tr><tr><td align="left" port="format"><font color="#8b0000">+ format: string</font></td></tr><tr><td align="left" port="flags"><font color="#8b0000">+ flags: string</font></td></tr><tr><td align="left" port="restricted"><font color="#8b0000">+ restricted: boolean [0..1]</font></td></tr><tr><td align="left" port="shared"><font color="#8b0000">+ shared: boolean [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ comment: Comment [0..*]</font></td></tr></table>>] Inventory -> StationGroup StationGroup -> StationReference Inventory -> AuxDevice AuxDevice -> AuxSource Inventory -> Sensor Sensor -> SensorCalibration Inventory -> Datalogger Datalogger -> DataloggerCalibration Datalogger -> Decimation Inventory -> ResponsePAZ Inventory -> ResponseFIR Inventory -> ResponseIIR Inventory -> ResponsePolynomial Inventory -> ResponseFAP Inventory -> Network Stream -> Comment SensorLocation -> Comment Station -> Comment Network -> Comment Network -> Station Station -> SensorLocation SensorLocation -> AuxStream SensorLocation -> Stream }

    Inventory object connections from parent to child.

  • Routing

    digraph G { graph [size="8, 100"] node [fontname=Verdana,fontsize=8] node [shape=plaintext] node [penwidth=0.5] node [style="rounded,filled"] node [fillcolor="#fcf2e3"] node [color="#000000"] edge [color="#000000"] layout="dot" Route [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Route</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="networkCode"><font color="#8b0000">+ networkCode: string</font></td></tr><tr><td align="left" port="stationCode"><font color="#8b0000">+ stationCode: string</font></td></tr><tr><td align="left" port="locationCode"><font color="#8b0000">+ locationCode: string</font></td></tr><tr><td align="left" port="streamCode"><font color="#8b0000">+ streamCode: string</font></td></tr><tr><td align="left"><font color="#8b0000">+ routeArclink: RouteArclink [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ routeSeedlink: RouteSeedlink [0..*]</font></td></tr></table>>] RouteArclink [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>RouteArclink</td></tr><tr><td align="left" port="address"><font color="#8b0000">+ address: string</font></td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime [0..1]</font></td></tr><tr><td align="left" port="priority"><font color="#8b0000">+ priority: int [0..1]</font></td></tr></table>>] RouteSeedlink [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>RouteSeedlink</td></tr><tr><td align="left" port="address"><font color="#8b0000">+ address: string</font></td></tr><tr><td align="left" port="priority"><font color="#8b0000">+ priority: int [0..1]</font></td></tr></table>>] Access [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>Access</td></tr><tr><td align="left" port="networkCode"><font color="#8b0000">+ networkCode: string</font></td></tr><tr><td align="left" port="stationCode"><font color="#8b0000">+ stationCode: string</font></td></tr><tr><td align="left" port="locationCode"><font color="#8b0000">+ locationCode: string</font></td></tr><tr><td align="left" port="streamCode"><font color="#8b0000">+ streamCode: string</font></td></tr><tr><td align="left" port="user"><font color="#8b0000">+ user: string</font></td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime [0..1]</font></td></tr></table>>] Routing -> Route Route -> RouteArclink Route -> RouteSeedlink Routing -> Access }

    Routing object connections from parent to child.

  • Journaling

    digraph G { graph [size="8, 100"] node [fontname=Verdana,fontsize=8] node [shape=plaintext] node [penwidth=0.5] node [style="rounded,filled"] node [fillcolor="#fcf2e3"] node [color="#000000"] edge [color="#000000"] layout="dot" JournalEntry [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>JournalEntry</td></tr><tr><td align="left" port="created"><font color="#8b0000">+ created: datetime [0..1]</font></td></tr><tr><td align="left" port="objectID"><font color="#8b0000">+ objectID: string</font></td></tr><tr><td align="left" port="sender"><font color="#8b0000">+ sender: string</font></td></tr><tr><td align="left" port="action"><font color="#8b0000">+ action: string</font></td></tr><tr><td align="left" port="parameters"><font color="#8b0000">+ parameters: string</font></td></tr></table>>] Journaling -> JournalEntry }

    Journaling object connections from parent to child.

  • ArclinkLog

    digraph G { graph [size="8, 100"] node [fontname=Verdana,fontsize=8] node [shape=plaintext] node [penwidth=0.5] node [style="rounded,filled"] node [fillcolor="#fcf2e3"] node [color="#000000"] edge [color="#000000"] layout="dot" ArclinkRequest [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>ArclinkRequest</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="requestID"><font color="#8b0000">+ requestID: string</font></td></tr><tr><td align="left" port="userID"><font color="#8b0000">+ userID: string</font></td></tr><tr><td align="left" port="userIP"><font color="#8b0000">+ userIP: string</font></td></tr><tr><td align="left" port="clientID"><font color="#8b0000">+ clientID: string</font></td></tr><tr><td align="left" port="clientIP"><font color="#8b0000">+ clientIP: string</font></td></tr><tr><td align="left" port="type"><font color="#8b0000">+ type: string</font></td></tr><tr><td align="left" port="created"><font color="#8b0000">+ created: datetime</font></td></tr><tr><td align="left" port="status"><font color="#8b0000">+ status: string</font></td></tr><tr><td align="left" port="message"><font color="#8b0000">+ message: string</font></td></tr><tr><td align="left" port="label"><font color="#8b0000">+ label: string</font></td></tr><tr><td align="left" port="header"><font color="#8b0000">+ header: string</font></td></tr><tr><td align="left" port="summary"><font color="#8b0000">+ summary: ArclinkRequestSummary [0..1]</font></td></tr><tr><td align="left"><font color="#8b0000">+ arclinkStatusLine: ArclinkStatusLine [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ arclinkRequestLine: ArclinkRequestLine [0..*]</font></td></tr></table>>] ArclinkStatusLine [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>ArclinkStatusLine</td></tr><tr><td align="left" port="type"><font color="#8b0000">+ type: string</font></td></tr><tr><td align="left" port="status"><font color="#8b0000">+ status: string</font></td></tr><tr><td align="left" port="size"><font color="#8b0000">+ size: int [0..1]</font></td></tr><tr><td align="left" port="message"><font color="#8b0000">+ message: string</font></td></tr><tr><td align="left" port="volumeID"><font color="#8b0000">+ volumeID: string</font></td></tr></table>>] ArclinkRequestLine [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>ArclinkRequestLine</td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime</font></td></tr><tr><td align="left" port="streamID"><font color="#8b0000">+ streamID: WaveformStreamID</font></td></tr><tr><td align="left" port="restricted"><font color="#8b0000">+ restricted: boolean [0..1]</font></td></tr><tr><td align="left" port="shared"><font color="#8b0000">+ shared: boolean [0..1]</font></td></tr><tr><td align="left" port="netClass"><font color="#8b0000">+ netClass: string</font></td></tr><tr><td align="left" port="constraints"><font color="#8b0000">+ constraints: string</font></td></tr><tr><td align="left" port="status"><font color="#8b0000">+ status: ArclinkStatusLine</font></td></tr></table>>] ArclinkUser [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>ArclinkUser</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="name"><font color="#8b0000">+ name: string</font></td></tr><tr><td align="left" port="email"><font color="#8b0000">+ email: string</font></td></tr><tr><td align="left" port="password"><font color="#8b0000">+ password: string</font></td></tr></table>>] ArclinkLog -> ArclinkRequest ArclinkRequest -> ArclinkStatusLine ArclinkRequest -> ArclinkRequestLine ArclinkLog -> ArclinkUser }

    ArclinkLog object connections from parent to child.

  • DataAvailability

    digraph G { graph [size="8, 100"] node [fontname=Verdana,fontsize=8] node [shape=plaintext] node [penwidth=0.5] node [style="rounded,filled"] node [fillcolor="#fcf2e3"] node [color="#000000"] edge [color="#000000"] layout="dot" DataExtent [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>DataExtent</td></tr><tr><td align="left" port="publicID"><font color="#8b0000">+ publicID: string</font></td></tr><tr><td align="left" port="waveformID"><font color="#8b0000">+ waveformID: WaveformStreamID</font></td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime</font></td></tr><tr><td align="left" port="updated"><font color="#8b0000">+ updated: datetime</font></td></tr><tr><td align="left" port="lastScan"><font color="#8b0000">+ lastScan: datetime</font></td></tr><tr><td align="left" port="segmentOverflow"><font color="#8b0000">+ segmentOverflow: boolean</font></td></tr><tr><td align="left"><font color="#8b0000">+ dataSegment: DataSegment [0..*]</font></td></tr><tr><td align="left"><font color="#8b0000">+ dataAttributeExtent: DataAttributeExtent [0..*]</font></td></tr></table>>] DataSegment [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>DataSegment</td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime</font></td></tr><tr><td align="left" port="updated"><font color="#8b0000">+ updated: datetime</font></td></tr><tr><td align="left" port="sampleRate"><font color="#8b0000">+ sampleRate: double</font></td></tr><tr><td align="left" port="quality"><font color="#8b0000">+ quality: string</font></td></tr><tr><td align="left" port="outOfOrder"><font color="#8b0000">+ outOfOrder: boolean</font></td></tr></table>>] DataAttributeExtent [label = <<table border="0" cellpadding="0" cellspacing="2"><tr><td>DataAttributeExtent</td></tr><tr><td align="left" port="start"><font color="#8b0000">+ start: datetime</font></td></tr><tr><td align="left" port="end"><font color="#8b0000">+ end: datetime</font></td></tr><tr><td align="left" port="sampleRate"><font color="#8b0000">+ sampleRate: double</font></td></tr><tr><td align="left" port="quality"><font color="#8b0000">+ quality: string</font></td></tr><tr><td align="left" port="updated"><font color="#8b0000">+ updated: datetime</font></td></tr><tr><td align="left" port="segmentCount"><font color="#8b0000">+ segmentCount: int</font></td></tr></table>>] DataAvailability -> DataExtent DataExtent -> DataSegment DataExtent -> DataAttributeExtent }

    DataAvailability object connections from parent to child.

Reference

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.

class seiscomp.datamodel.PublicObject

Inherits Object.

setPublicID(id)

Sets the publicID of the object.

publicID()

Returns the publicID of the object.

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.

class seiscomp.datamodel.Access

Inherits Object.

This type describes an ArcLink access rule

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

otherAccess

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 objects index of type AccessIndex.

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

equalIndex(lhs)
Parameters

lhsAccess

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.

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.

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

otherAmplitude

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

amplitudeRealQuantity

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

timeWindowTimeWindow

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

periodRealQuantity

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

waveformIDWaveformStreamID

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

scalingTimeTimeQuantity

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

creationInfoCreationInfo

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.

class seiscomp.datamodel.AmplitudeReference

Inherits Object.

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

otherAmplitudeReference

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 objects index of type AmplitudeReferenceIndex.

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

equalIndex(lhs)
Parameters

lhsAmplitudeReference

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.

class seiscomp.datamodel.ArclinkLog

Inherits PublicObject.

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

otherArclinkLog

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.

class seiscomp.datamodel.ArclinkRequest

Inherits PublicObject.

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

otherArclinkRequest

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 objects index of type ArclinkRequestIndex.

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

equalIndex(lhs)
Parameters

lhsArclinkRequest

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

summaryArclinkRequestSummary

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.

class seiscomp.datamodel.ArclinkRequestLine

Inherits Object.

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

otherArclinkRequestLine

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 objects index of type ArclinkRequestLineIndex.

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

equalIndex(lhs)
Parameters

lhsArclinkRequestLine

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

streamIDWaveformStreamID

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

statusArclinkStatusLine

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.

class seiscomp.datamodel.ArclinkRequestSummary

Inherits Object.

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

otherArclinkRequestSummary

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

class seiscomp.datamodel.ArclinkStatusLine

Inherits Object.

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

otherArclinkStatusLine

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 objects index of type ArclinkStatusLineIndex.

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

equalIndex(lhs)
Parameters

lhsArclinkStatusLine

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.

class seiscomp.datamodel.ArclinkUser

Inherits PublicObject.

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

otherArclinkUser

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 objects index of type ArclinkUserIndex.

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

equalIndex(lhs)
Parameters

lhsArclinkUser

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.

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.

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

otherArrival

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 objects index of type ArrivalIndex.

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

equalIndex(lhs)
Parameters

lhsArrival

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

phasePhase

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

creationInfoCreationInfo

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.

class seiscomp.datamodel.AuxDevice

Inherits PublicObject.

This type describes an auxilliary device

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

otherAuxDevice

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 objects index of type AuxDeviceIndex.

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

equalIndex(lhs)
Parameters

lhsAuxDevice

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

remarkBlob

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.

class seiscomp.datamodel.AuxSource

Inherits Object.

This type describes a channel of an auxilliary device

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

otherAuxSource

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 objects index of type AuxSourceIndex.

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

equalIndex(lhs)
Parameters

lhsAuxSource

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

remarkBlob

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.

class seiscomp.datamodel.AuxStream

Inherits Object.

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

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

otherAuxStream

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 objects index of type AuxStreamIndex.

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

equalIndex(lhs)
Parameters

lhsAuxStream

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.

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.

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

otherAxis

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

azimuthRealQuantity

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

plungeRealQuantity

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

lengthRealQuantity

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

length()
Return type

RealQuantity

class seiscomp.datamodel.Blob

Inherits Object.

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

otherBlob

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

class seiscomp.datamodel.Comment

Inherits Object.

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

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

otherComment

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 objects index of type CommentIndex.

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

equalIndex(lhs)
Parameters

lhsComment

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

creationInfoCreationInfo

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.

class seiscomp.datamodel.ComplexArray

Inherits Object.

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

otherComplexArray

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.

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.

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

otherCompositeTime

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

yearIntegerQuantity

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

monthIntegerQuantity

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

dayIntegerQuantity

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

hourIntegerQuantity

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

minuteIntegerQuantity

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

secondRealQuantity

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.

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)

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

otherConfidenceEllipsoid

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

class seiscomp.datamodel.Config

Inherits PublicObject.

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

otherConfig

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.

class seiscomp.datamodel.ConfigModule

Inherits PublicObject.

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

otherConfigModule

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.

class seiscomp.datamodel.ConfigStation

Inherits PublicObject.

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

otherConfigStation

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 objects index of type ConfigStationIndex.

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

equalIndex(lhs)
Parameters

lhsConfigStation

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

creationInfoCreationInfo

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.

class seiscomp.datamodel.CreationInfo

Inherits Object.

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

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

otherCreationInfo

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

class seiscomp.datamodel.DataAttributeExtent

Inherits Object.

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

otherDataAttributeExtent

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 objects index of type DataAttributeExtentIndex.

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

equalIndex(lhs)
Parameters

lhsDataAttributeExtent

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.

class seiscomp.datamodel.DataAvailability

Inherits PublicObject.

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

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

otherDataAvailability

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.

class seiscomp.datamodel.DataExtent

Inherits PublicObject.

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

otherDataExtent

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 objects index of type DataExtentIndex.

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

equalIndex(lhs)
Parameters

lhsDataExtent

Return type

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

setWaveformID(waveformID)
Parameters

waveformIDWaveformStreamID

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.

class seiscomp.datamodel.DataSegment

Inherits Object.

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

otherDataSegment

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 objects index of type DataSegmentIndex.

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

equalIndex(lhs)
Parameters

lhsDataSegment

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.

class seiscomp.datamodel.DataUsed

Inherits Object.

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

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

otherDataUsed

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.

class seiscomp.datamodel.Datalogger

Inherits PublicObject.

This type describes a datalogger (digitizer and recorder)

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

otherDatalogger

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 objects index of type DataloggerIndex.

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

equalIndex(lhs)
Parameters

lhsDatalogger

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

remarkBlob

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.

class seiscomp.datamodel.DataloggerCalibration

Inherits Object.

This type describes a datalogger calibration

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

otherDataloggerCalibration

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 objects index of type DataloggerCalibrationIndex.

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

equalIndex(lhs)
Parameters

lhsDataloggerCalibration

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

remarkBlob

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.

class seiscomp.datamodel.Decimation

Inherits Object.

This type describes a decimation to a certain sample rate

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

otherDecimation

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 objects index of type DecimationIndex.

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

equalIndex(lhs)
Parameters

lhsDecimation

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

analogueFilterChainBlob

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

digitalFilterChainBlob

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.

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.

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

otherEvent

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

creationInfoCreationInfo

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.

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.

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

otherEventDescription

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 objects index of type EventDescriptionIndex.

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

equalIndex(lhs)
Parameters

lhsEventDescription

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.

class seiscomp.datamodel.EventParameters

Inherits PublicObject.

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

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

otherEventParameters

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.

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.

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

otherFocalMechanism

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

nodalPlanesNodalPlanes

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

principalAxesPrincipalAxes

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

creationInfoCreationInfo

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.

class seiscomp.datamodel.FocalMechanismReference

Inherits Object.

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

otherFocalMechanismReference

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 objects index of type FocalMechanismReferenceIndex.

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

equalIndex(lhs)
Parameters

lhsFocalMechanismReference

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.

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.

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

otherIntegerQuantity

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.

class seiscomp.datamodel.Inventory

Inherits PublicObject.

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

otherInventory

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.

class seiscomp.datamodel.JournalEntry

Inherits Object.

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

otherJournalEntry

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.

class seiscomp.datamodel.Journaling

Inherits PublicObject.

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

otherJournaling

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.

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.

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

otherMagnitude

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

magnitudeRealQuantity

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 magitude (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

creationInfoCreationInfo

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.

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.

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

otherMomentTensor

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

scalarMomentRealQuantity

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

tensorTensor

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

sourceTimeFunctionSourceTimeFunction

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

creationInfoCreationInfo

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.

class seiscomp.datamodel.MomentTensorComponentContribution

Inherits Object.

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

otherMomentTensorComponentContribution

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 objects index of type MomentTensorComponentContributionIndex.

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

equalIndex(lhs)
Parameters

lhsMomentTensorComponentContribution

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.

class seiscomp.datamodel.MomentTensorPhaseSetting

Inherits Object.

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

otherMomentTensorPhaseSetting

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 objects index of type MomentTensorPhaseSettingIndex.

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

equalIndex(lhs)
Parameters

lhsMomentTensorPhaseSetting

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.

class seiscomp.datamodel.MomentTensorStationContribution

Inherits PublicObject.

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

otherMomentTensorStationContribution

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

waveformIDWaveformStreamID

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.

class seiscomp.datamodel.Network

Inherits PublicObject.

This type describes a network of seismic stations

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

otherNetwork

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 objects index of type NetworkIndex.

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

equalIndex(lhs)
Parameters

lhsNetwork

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

remarkBlob

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.

class seiscomp.datamodel.NodalPlane

Inherits