gov.sns.xal.tools.orbit
Class BpmResult

java.lang.Object
  |
  +--gov.sns.xal.tools.orbit.BpmResult

public class BpmResult

extends java.lang.Object

BpmResult is a simple wrapper class that provides convenient access to results of a correlation of signals from a single BPM.

Field Summary

protected BPM	_bpm
protected java.util.Map	recordMap
protected double	timestamp

Method Summary

double	ampAvg() Return the average BPM signal amplitude for the bpm at the time of the correlation.
protected void	appendHandle(ChannelSuite channelSuite, java.lang.String handle, Correlation correlation) convenient method for repeated application with different handle
BPM	getBpm() The bpm corresponding to this record
java.util.Date	getDate() get the timestamp in Java date format for convenient printing
ChannelTimeRecord	getRecord(java.lang.String handle) Return the record for the specified PV handle.
double	getTimestamp() The mean timestamp in seconds over all Epics timestamps of signals captured.
java.lang.String	toString() Return the map of handle/record pairs.
double	xAvg() Return the average x value for the bpm at the time of the correlation.
double	yAvg() Return the average y value for the bpm at the time of the correlation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_bpm

protected BPM _bpm

timestamp

protected double timestamp

recordMap

protected java.util.Map recordMap

Method Detail

appendHandle

protected void appendHandle(ChannelSuite channelSuite,
                            java.lang.String handle,
                            Correlation correlation)

convenient method for repeated application with different handle

getBpm

public BPM getBpm()

The bpm corresponding to this record

getTimestamp

public double getTimestamp()

The mean timestamp in seconds over all Epics timestamps of signals captured.

getDate

public java.util.Date getDate()

get the timestamp in Java date format for convenient printing

getRecord

public ChannelTimeRecord getRecord(java.lang.String handle)

Return the record for the specified PV handle.

xAvg

public double xAvg()

Return the average x value for the bpm at the time of the correlation.

yAvg

public double yAvg()

Return the average y value for the bpm at the time of the correlation.

ampAvg

public double ampAvg()

Return the average BPM signal amplitude for the bpm at the time of the correlation.

toString

public java.lang.String toString()

Return the map of handle/record pairs.

Overrides:

toString in class java.lang.Object