xal.extension.wirescan.profile

Class ProfileData

java.lang.Object

xal.extension.wirescan.profile.ProfileData

public class ProfileData
extends java.lang.Object

Encapsulation of generic beam profile measurement data. This data set consists of sampled data representing projections of the beam distribution from multiple viewing angles. The number of angles depends upon the number of "wire" orientations available on the diagnostic device. Currently the viewing angles are enumerated with the Java enumeration Angle.

Also contained in this data set are the axes positions for each projection sample. Specifically, each projection has an associated vector of axis positions where the sample was taken. Moreover, a time stamp for the data and the device identifier for the source of the data is stored.

NOTES:
- Currently there are no initializing constructors, or public constructors for that matter. There is a create(String, Date, int) static method for directly instantiating objects of this type. The thinking here is that sub-classes for the particular diagnostic device will handle initializing construction. Thus, if you wish to create a ProfileData object directly, you must call the factory method create(String, Data, int) then pack the data using the setter methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProfileData.Angle Enumeration of supported projection-data view angles.
static class	ProfileData.DeviceType Enumeration of known profile measurement device types.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProfileData(int szArrData) Deprecated.
protected	ProfileData(java.lang.String strDevId, java.util.Date dateTmStamp, int szArrData) Create a new, uninitialized instance of ProfileData, reserving the given amount of space for data.

Method Summary

Modifier and Type	Method and Description
static ProfileData	copy(ProfileData dataOrg) Make and return a deep copy of the given data set.
static ProfileData	create(java.lang.String strDevId, java.util.Date dateTmStamp, int szArrData) Create a new, uninitialized instance of ProfileData, reserving the given amount of space for data.
boolean	equals(java.lang.Object objData) Check to see that given object is either this object, or contains exactly the same data.
double	getActuatorPositionAt(int index) Returns the actuator position at given index.
double[]	getActuatorPositions() Returns the vector array of axis positions for each data value.
double	getAxisPositionAt(ProfileData.Angle view, int index) Returns the axis position at given index for the given viewing angle.
double[]	getAxisPositions(ProfileData.Angle view) Returns the vector array of axis positions for each data value.
java.lang.String	getComment() Return the comment string associated with this data.
int	getDataSize() Return the size of each data vector.
java.lang.String	getDeviceId() Return measurement device for this data.
ProfileData.DeviceType	getDeviceType() Return the measurement device type for this data.
double[]	getProjection(ProfileData.Angle view) Returns the projection data array for the given viewing angle.
double	getProjectionAt(ProfileData.Angle view, int index) Returns the value of given projection data at given index.
int	getPvLoggerId() Return the Process Variable Logger (PVLogger) record identifier for the machine configuration when this data was taken
java.util.Date	getTimeStamp() Returns the time and date when the measurement was initiated.
int	hashCode()
boolean	hasMissingData() Return the missing data flag.
void	setActuatorPositionAt(int index, double dblVal) Set the actuator position for the given sample index.
void	setActuatorPositions(double[] arrVals) Set the entire actuator position vector.
void	setActuatorPositions(java.util.List<java.lang.Double> lstVals) Set the entire actuator position vector.
void	setAllProjectionsAt(int index, java.lang.Double... argPrj) Sets all the projection data at the given index.
void	setAxisPositionAt(ProfileData.Angle view, int index, double dblVal) Set axis position at the given index.
void	setAxisPositions(ProfileData.Angle view, double[] arrVals) Set the entire axis position vector for the given viewing angle.
void	setAxisPositions(ProfileData.Angle view, java.util.List<java.lang.Double> lstVals) Set the entire axis position data array for the given projection angle.
void	setProjection(ProfileData.Angle view, double[] arrVals) Set the entire projection data array.
void	setProjection(ProfileData.Angle view, java.util.List<java.lang.Double> lstVals) Set the entire projection data array.
void	setProjectionAt(ProfileData.Angle view, int index, double dblVal) Set given view profile value at index.
java.lang.String	toString() Write out the contents of this data structure to a string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProfileData

@Deprecated
protected ProfileData(int szArrData)

Deprecated.

Create a new, uninitialized instance of ProfileData, reserving the given amount of space for data.

Parameters:

szArrData - the size of each data array

ProfileData

protected ProfileData(java.lang.String strDevId,
                      java.util.Date dateTmStamp,
                      int szArrData)

Create a new, uninitialized instance of ProfileData, reserving the given amount of space for data.

Parameters:

strDevId - profile measurement device identifier

dateTmStamp - measurement date of data

szArrData - the size of each data array

Method Detail

create

public static ProfileData create(java.lang.String strDevId,
                                 java.util.Date dateTmStamp,
                                 int szArrData)

Create a new, uninitialized instance of ProfileData, reserving the given amount of space for data.

Parameters:

strDevId - profile measurement device identifier

dateTmStamp - measurement date of data

szArrData - the size of each data array

Returns:

An empty single-device data structure ready for population.

copy

public static ProfileData copy(ProfileData dataOrg)

Make and return a deep copy of the given data set.

Parameters:

dataOrg - original data set

Returns:

deep copy of given data

setActuatorPositionAt

public void setActuatorPositionAt(int index,
                                  double dblVal)
                           throws java.lang.ArrayIndexOutOfBoundsException

Set the actuator position for the given sample index.

Parameters:

index - index of the actuator position array

dblVal - new value for the actuator position

Throws:

java.lang.ArrayIndexOutOfBoundsException - index larger than storage capacity

setActuatorPositions

public void setActuatorPositions(double[] arrVals)
                          throws java.lang.ArrayIndexOutOfBoundsException

Set the entire actuator position vector. This is a copy operation, not a set by reference. Note further that the given array must have length equal to the storage specified by ProfileData#allocStorage(int).

Parameters:

arrVals - array of actuator positions

Throws:

java.lang.ArrayIndexOutOfBoundsException - list size not equal storage allocated

setActuatorPositions

public void setActuatorPositions(java.util.List<java.lang.Double> lstVals)
                          throws java.lang.ArrayIndexOutOfBoundsException

Set the entire actuator position vector. Note that the given list must have length equal to the storage specified by ProfileData#allocStorage(int).

Parameters:

lstVals - ordered list of actuator positions

Throws:

java.lang.ArrayIndexOutOfBoundsException - list size not equal storage allocated

setAxisPositionAt

public void setAxisPositionAt(ProfileData.Angle view,
                              int index,
                              double dblVal)
                       throws java.lang.ArrayIndexOutOfBoundsException

Set axis position at the given index.

Parameters:

view - viewing angle

index - index of the axis position array

dblVal - new value for the position at index

Throws:

java.lang.ArrayIndexOutOfBoundsException - index larger than storage capacity

setAxisPositions

public void setAxisPositions(ProfileData.Angle view,
                             double[] arrVals)
                      throws java.lang.ArrayIndexOutOfBoundsException

Set the entire axis position vector for the given viewing angle. This is a copy operation, not a set by reference. Note further that the given array must have length equal to the storage specified by ProfileData#allocStorage(int).

Parameters:

view - viewing angle

arrVals - array of axis positions

Throws:

java.lang.ArrayIndexOutOfBoundsException - list size not equal storage allocated

setAxisPositions

public void setAxisPositions(ProfileData.Angle view,
                             java.util.List<java.lang.Double> lstVals)
                      throws java.lang.ArrayIndexOutOfBoundsException

Set the entire axis position data array for the given projection angle. Note that the given list must have length equal to the storage specified by ProfileData#allocStorage.

Parameters:

view - viewing angle

lstVals - ordered list of axis positions

Throws:

java.lang.ArrayIndexOutOfBoundsException - list size not equal storage allocated

setProjectionAt

public void setProjectionAt(ProfileData.Angle view,
                            int index,
                            double dblVal)
                     throws java.lang.ArrayIndexOutOfBoundsException

Set given view profile value at index.

Parameters:

view - viewing angle

index - index of the profile array

dblVal - new value of profile at index

Throws:

java.lang.ArrayIndexOutOfBoundsException - index larger than storage capacity

setAllProjectionsAt

public void setAllProjectionsAt(int index,
                                java.lang.Double... argPrj)
                         throws java.lang.ArrayIndexOutOfBoundsException,
                                java.lang.IllegalArgumentException

Sets all the projection data at the given index. The variable argument list must contain only entry per ProfileData.View.

Parameters:

index - index of the axis position array

argPrj - projection values, one for each projection view

Throws:

java.lang.ArrayIndexOutOfBoundsException - index larger than storage capacity

java.lang.IllegalArgumentException - wrong number of projection values

See Also:

gov.sns.tools.data.profile.ProfileData.Angle

setProjection

public void setProjection(ProfileData.Angle view,
                          double[] arrVals)
                   throws java.lang.ArrayIndexOutOfBoundsException

Set the entire projection data array. This is a copy operation, not a set by reference. Note further that the given array must have length equal to the storage specified by ProfileData#allocStorage(int).

Parameters:

view - projection view angle

arrVals - array of projection data

Throws:

java.lang.ArrayIndexOutOfBoundsException - data size not equal storage allocated

setProjection

public void setProjection(ProfileData.Angle view,
                          java.util.List<java.lang.Double> lstVals)
                   throws java.lang.ArrayIndexOutOfBoundsException

Set the entire projection data array. Note that the given list must have length equal to the storage specified by ProfileData#allocStorage(int).

Parameters:

view - projection view angle

lstVals - ordered list of projection data

Throws:

java.lang.ArrayIndexOutOfBoundsException - list size not equal storage allocated

getDeviceId

public java.lang.String getDeviceId()

Return measurement device for this data.

Returns:

the device identifier associated with this data

getDeviceType

public ProfileData.DeviceType getDeviceType()

Return the measurement device type for this data.

Returns:

the device type associated with this data

hasMissingData

public boolean hasMissingData()

Return the missing data flag. If true then this data set contains missing points which are represented with the value Double.NaN. Otherwise, the data set is complete.

Returns:

true if data set contains missing data points.

getTimeStamp

public java.util.Date getTimeStamp()

Returns the time and date when the measurement was initiated.

Returns:

the time stamp of this data

getPvLoggerId

public int getPvLoggerId()

Return the Process Variable Logger (PVLogger) record identifier for the machine configuration when this data was taken

Returns:

PVLogger snapshot id

getComment

public java.lang.String getComment()

Return the comment string associated with this data.

Returns:

user comment string or null if none

getDataSize

public int getDataSize()

Return the size of each data vector.

Returns:

data vector length.

getActuatorPositions

public double[] getActuatorPositions()

Returns the vector array of axis positions for each data value.

Returns:

array of axis positions

getActuatorPositionAt

public double getActuatorPositionAt(int index)

Returns the actuator position at given index.

NOTE: For the sake of speed, there is no error checking here. Any bounds overruns bubble up from here.

Parameters:

index - index of the position vector

Returns:

axis position at index

getAxisPositions

public double[] getAxisPositions(ProfileData.Angle view)

Returns the vector array of axis positions for each data value.

Parameters:

view - projection viewing angle

Returns:

array of axis positions

getAxisPositionAt

public double getAxisPositionAt(ProfileData.Angle view,
                                int index)

Returns the axis position at given index for the given viewing angle.

NOTE: For the sake of speed, there is no error checking here. Any bounds overruns bubble up from here.

Parameters:

view - projection viewing angle

index - index of the position vector

Returns:

axis position at index

getProjection

public double[] getProjection(ProfileData.Angle view)

Returns the projection data array for the given viewing angle.

Parameters:

view - projection viewing angle

Returns:

projection data array

getProjectionAt

public double getProjectionAt(ProfileData.Angle view,
                              int index)

Returns the value of given projection data at given index.

NOTE: For the sake of speed, there is no error checking here. Any bounds overruns bubble up from here.

Parameters:

view - projection viewing angle

index - index of the projection data vector

Returns:

projection data value at index

equals

public boolean equals(java.lang.Object objData)

Check to see that given object is either this object, or contains exactly the same data.

Overrides:

equals in class java.lang.Object

Parameters:

objData - object under comparison

Returns:

true if objData is this or contains the same data

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Since:

Feb 3, 2015 by Christopher K. Allen

See Also:

Object.hashCode()

toString

public java.lang.String toString()

Write out the contents of this data structure to a string.

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()