SpectrumMetric-class: Class '"SpectrumMetric"'

SpectrumMetric-classR Documentation

Class "SpectrumMetric"

Description

A container for metrics consisting of discrete spectra. 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("SpectrumMetric", snclq, starttime, endtime, metricName, freqs, amps, phases)

Slots

snclq:

Object of class "character": SNCLQ identifier.

metricName:

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

elementName:

Object of class "character": Name of the datetime element (default="t").

starttime:

Object of class "POSIXct": Start time.

endtime:

Object of class "POSIXct": End time.

freqs:

Object of class "numeric": Frequency values.

freqStrings:

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

amps:

Object of class "numeric": Amplitude values.

ampStrings:

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

phases:

Object of class "numeric": Phase values.

phaseStrings:

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

quality_flag:

Object of class "numeric": Quality flag.

quality_flagString:

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

Methods

show

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

Note

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@mazamascience.com


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