xal.smf.impl.profile

Interface ProfileDevice.IProfileData

All Superinterfaces:

DataListener

Enclosing class:

ProfileDevice

public static interface ProfileDevice.IProfileData
extends DataListener

Interface exposed by data structures containing formatted data acquired from profile diagnostic devices. The interface presents that data which is common to all profile devices.

Since:

Apr 22, 2014

Method Summary

Modifier and Type	Method and Description
SignalAttrSet	getDataAttrs() Signal attributes (properties) computed from the profile device data set.
int	getDataSize() Returns the length of each signal in the data set, that is, the number of samples in the signals.
java.lang.String	getDeviceId() Returns the identifier string of the device that produced the current data.
java.lang.String	getDeviceTypeId() Returns the device type identifier string of the device that produced the current data.
SignalSet	getFitData() Returns a fitted signal set taken from the current profile data set.
SignalSet	getRawData() Returns the raw signal data from the profile device data set.
boolean	isValidWire(ProfileDevice.ANGLE angle, int iWire) Indicates whether or not the given wire is operating correctly and producing valid data.

Methods inherited from interface xal.tools.data.DataListener

dataLabel, update, write

Method Detail

getDeviceId

java.lang.String getDeviceId()

Returns the identifier string of the device that produced the current data.

Returns:

string identifier of the data acquisition device

Since:

Apr 22, 2014

getDeviceTypeId

java.lang.String getDeviceTypeId()

Returns the device type identifier string of the device that produced the current data.

Returns:

string identifier of the acquisition device (i.e., "ws", "harp", etc.)

Since:

Sep 22, 2014

getDataSize

int getDataSize()

Returns the length of each signal in the data set, that is, the number of samples in the signals.

Returns:

number of samples in each profile signal

Since:

Apr 22, 2014

getRawData

SignalSet getRawData()

Returns the raw signal data from the profile device data set.

Returns:

profile signal data acquire directly without any processing

Since:

Apr 22, 2014

getFitData

SignalSet getFitData()

Returns a fitted signal set taken from the current profile data set. The type of fit and its corresponding processing should be defined by the exposing method or clear from the context.

Returns:

fitted signal data from the profile data set

Since:

Apr 22, 2014

getDataAttrs

SignalAttrSet getDataAttrs()

Signal attributes (properties) computed from the profile device data set. This include signal offset, signal strength, standard deviation, etc. These values are computed from some pre-processed, or fitted, data. How these values are computed must be should be defined in in the exposed method or clear from the context.

Returns:

signal properties of the current profile device data set

Since:

Apr 22, 2014

isValidWire

boolean isValidWire(ProfileDevice.ANGLE angle,
                    int iWire)

Indicates whether or not the given wire is operating correctly and producing valid data. The argument is the index for the wire, the same index that would be used for the arrays of data produced by the profile device.

If the profile device has no method of validating wire operation then the method will return true regardless of the argument, rather than a blanket false

Parameters:

angle - projection angle of the harp to be validated

iWire - index of the wire to be validated

Returns:

true if the the wire is operating correctly or the device has no method of validation, false if the wire is faulty.

Since:

Jul 2, 2014