GeneralValueMetric-class: Class '"GeneralValueMetric"'

GeneralValueMetric-classR Documentation

Class "GeneralValueMetric"

Description

A container for metrics consisting of a vector of numeric values. This information is used to create XML that is then submitted to the MUSTANG Backend Storage System (BSS).

Objects from the Class

Objects can be created by calls of the form:

new("GeneralValueMetric", snclq, starttime, endtime, metricName, elementNames, elementValues, valueStrings, quality_flag, quality_flagString)

Lists of GeneralValueMetric objects are returned by various metrics functions in this package.

Slots

snclq:

Object of class "character": SNCLQ identifier.

starttime:

Object of class "POSIXct": Start time.

endtime:

Object of class "POSIXct": End time.

metricName:

Object of class "character": Name of the metric.

elementNames:

Object of class "character": Names of the elements storing the metric values (default="x").

elementValues:

Object of class "numeric": Numeric values.

valueStrings:

Object of class "character": String representations of the numeric values.

quality_flag:

Object of class "numeric": Quality flag.

quality_flagString:

Object of class "character": String representation of quality flag.

Methods

show

signature(object = "GeneralValueMetric"): Prettyprints the information in the GeneralValueMetric

Note

The starttime and endtime slots are typically associated with the user requested times which may not match up with the starttime associated with the first Trace and the endtime associated with last Trace in the Stream object being analyzed. This ensures that metrics results for a single time period but covering many stations or channels will have the same date range and improves performance of the BSS which expects XML of the following form:

<measurements>
  <date start='2012-02-10T00:00:00.000' end='2012-02-10T09:20:00.000'>
    <target snclq='N.S.L.C1.Q'>
      <EXAMPLE>
        <x value="1"/>
        <x value="2"/>
        <x value="3"/>
        <x value="4"/>
      </EXAMPLE>
    </target>
  </date>
</measurements>

The quality_flag is an optional value available for storing information related to the processing of a particular metric. Its meaning will vary from metric to metric.

Author(s)

Jonathan Callahan jonathan.s.callahan@gmail.com


IRISMustangMetrics documentation built on April 28, 2022, 1:06 a.m.