xal.smf.impl.profile

Class Signal

java.lang.Object

xal.smf.scada.ScadaRecord

xal.smf.impl.profile.Signal

All Implemented Interfaces:

java.lang.Cloneable, DataListener

public class Signal
extends ScadaRecord

Data structure for storing all the properties of a beam profile signal. This includes the signal values, the location of the value within the beam pipe, and the number of samples. Noise characteristics may also be present.

This structure is equipped for direct acquisition of WireHarp device profile data measurements. The data structure is derived from the ScadaStruct base class in order to use that data I/O mechanism already in place.

This type is intended to serve as attributes for a larger data structure containing the beam profiles in multiple transverse planes. That aggregating structure is expected to set up the necessary connections for data acquisition use by the base class ScadaRecord, namely by instantiating instances with the constructor Signal(List) (protected access). It is still possible to use a Signal object directly by annotating it with the AScada.Record annotation.

Ported from XAL on Jul 15, 2014.
· Jonathan M. Freed

Since:

Jan 30, 2013

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Signal.FIELD Field names of the Signal class.

Nested classes/interfaces inherited from class xal.smf.scada.ScadaRecord

ScadaRecord.IFieldDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
int	cnt Number of sample points in the signal
double	navg mean value of the noise amplitude
double	nvar standard deviation (or variance) of the noise amplitude
double[]	pos Positions of the sample points in signal
double[]	val Signal value at the sample location

Constructor Summary

Constructors

Modifier	Constructor and Description
	Signal() Creates a new, uninitialized instance of Signal which is not connected to any XAL channels.
protected	Signal(java.util.List<ScadaFieldDescriptor> lstFldDscr) Creates a new instance of Signal and initializes the SCADA operations with the given field descriptors.

Method Summary

Modifier and Type	Method and Description
void	average(Signal sigAcq, double dblWtFac) Performs an averaging operation with the given Signal object using the given averaging factor.
java.lang.Object	clone() Creates a deep copy of this object.
static Signal	createBlankSignal() Creates and returns a new Signal object containing no data and incapable of any data acquisition.
static Signal	createConnectedSignal(ASignal annSig) Creates a new instance of the Signal class which is connected to a given device whose signal fields are described in the given annotation.
java.lang.String	dataLabel() Returns a (unique) string identifier that identifies the persistent data format that belongs to this Signal class.
java.lang.String	toString() Write out the contents of this signal.
void	update(DataAdaptor daptSrc) Read in the values of the data structure fields from the data source behind the data adaptor interface.
void	write(DataAdaptor daptSink) Save the data structure field values to the given data sink behind the DataAdaptor interface.

Methods inherited from class xal.smf.scada.ScadaRecord

getFieldDescriptor, getFieldDescriptorMap, getFieldDescriptors, loadHardwareValues, setFieldFromPV, setHardwareValues, setPvFromField

Methods inherited from class java.lang.Object

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

Field Detail

pos

public double[] pos

Positions of the sample points in signal

val

public double[] val

Signal value at the sample location

cnt

public int cnt

Number of sample points in the signal

navg

public double navg

mean value of the noise amplitude

nvar

public double nvar

standard deviation (or variance) of the noise amplitude

Constructor Detail

Signal

public Signal()
       throws BadStructException

Creates a new, uninitialized instance of Signal which is not connected to any XAL channels.

Throws:

BadStructException - no SCADA fields (@AScada.Field) were found in data structure

Since:

Feb 7, 2013

Signal

protected Signal(java.util.List<ScadaFieldDescriptor> lstFldDscr)
          throws BadStructException

Creates a new instance of Signal and initializes the SCADA operations with the given field descriptors.

Parameters:

lstFldDscr - array of field descriptors used for communication with hardware

Throws:

BadStructException - no SCADA fields were found in argument

Since:

Feb 1, 2013

Method Detail

createBlankSignal

public static Signal createBlankSignal()

Creates and returns a new Signal object containing no data and incapable of any data acquisition. This type of object is primarily used for data processing.

Returns:

an empty, unattached signal object

Since:

Apr 19, 2012

createConnectedSignal

public static Signal createConnectedSignal(ASignal annSig)
                                    throws BadStructException,
                                           ScadaAnnotationException

Creates a new instance of the Signal class which is connected to a given device whose signal fields are described in the given annotation. When created here, the Signal object becomes a fully functional ScadaRecord and can automatically acquire data from the connected device.

NOTES:

· The returned Signal object may not have all fields connected. Only those fields for which the given annotation has non-empty values will be connected. This could cause complications for signals requiring such fields and should be checked.

Parameters:

annSig - annotation class containing the meta-data describing the signal connections

Returns:

operational ScadaRecord class capable of data acquisition

Throws:

ScadaAnnotationException - field in the annotation is not accessible, does not exist, or enumeration Signal.FIELD is corrupt

BadStructException - a required field of the given annotation is empty

Since:

Feb 7, 2013

average

public void average(Signal sigAcq,
                    double dblWtFac)
             throws java.lang.IllegalArgumentException

Performs an averaging operation with the given Signal object using the given averaging factor. The quantities within this data structure are averaged in place with that of the given signal structure. Letting λ denote the provided averaging factor, which is in the interval [0,1], the new values of this signal, say v' are given by the formula

v' = λu + (1 - λ)v

where v is the previous value of v' and u is the new value of v in sigAcq.

NOTES:

· Nothing is done to the position values in the signal, they are unchanged of current writing.
· The standard deviation is weighted vectorally.

Parameters:

sigAcq - signal u to average into this one v

dblWtFac - weighting factor λ ∈ [0,1] for argument u

Throws:

java.lang.IllegalArgumentException - the provided signal is not the same size as this signal

Since:

May 1, 2014

dataLabel

public java.lang.String dataLabel()

Returns a (unique) string identifier that identifies the persistent data format that belongs to this Signal class.

Returns:

a tag that identifies the receiver's type

Since:

Jan 30, 2013

See Also:

gov.sns.tools.data.DataListener#dataLabel()

update

public void update(DataAdaptor daptSrc)
            throws java.util.MissingResourceException,
                   BadStructException

Description copied from class: ScadaRecord

Read in the values of the data structure fields from the data source behind the data adaptor interface. The attributes of the data source are the field names, the values are taken from there.

Specified by:

update in interface DataListener

Overrides:

update in class ScadaRecord

Parameters:

daptSrc - The adaptor from which to update the data

Throws:

java.util.MissingResourceException - a data field was missing from the data source

BadStructException - data structure fields are ill-defined/incompatible

Since:

Oct 14, 2014

See Also:

ScadaRecord.update(xal.tools.data.DataAdaptor)

write

public void write(DataAdaptor daptSink)
           throws BadStructException

Description copied from class: ScadaRecord

Save the data structure field values to the given data sink behind the DataAdaptor interface. Each value is stored as the value of an attribute being the field name.

Specified by:

write in interface DataListener

Overrides:

write in class ScadaRecord

Parameters:

daptSink - The adaptor to which the receiver's data is written

Throws:

BadStructException - data structure fields are ill-defined/incompatible

Since:

Oct 14, 2014

See Also:

ScadaRecord.write(xal.tools.data.DataAdaptor)

toString

public java.lang.String toString()

Write out the contents of this signal.

Overrides:

toString in class ScadaRecord

Returns:

a representation of the signal as a string of (pos,val) pairs

Since:

Mar 12, 2010

See Also:

gov.sns.xal.smf.scada.ScadaRecord#toString()

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Creates a deep copy of this object. All arrays and field descriptors are duplicated.

Overrides:

clone in class ScadaRecord

Throws:

java.lang.CloneNotSupportedException

Since:

Apr 19, 2012

See Also:

Object.clone()