Package gda.scan

Class ScanDataPoint

java.lang.Object

gda.scan.ScanDataPoint

All Implemented Interfaces:

IScanDataPoint, Serializable

public class ScanDataPoint
extends Object
implements Serializable, IScanDataPoint

This class holds information about the data collected at a single point on a scan. It is to be passed around between objects for display \ recording of data.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DELIMITER	The delimiter used by toString() method.

Constructor Summary

Constructors

Constructor	Description
ScanDataPoint()

Method Summary

Modifier and Type	Method	Description
void	addDataFromDetector(Detector detector)	Deprecated, for removal: This API element is subject to removal in a future version.
void	addDetector(Detector det)	Add a detector to the list of detectors this object holds data from.
void	addDetectorData(Object data, String[] format)	Add a piece of data to this object.
void	addPositionFromScannable(Scannable scannable)	Deprecated, for removal: This API element is subject to removal in a future version.
void	addScannable(Scannable scannable)	Add a scannable to the list of scannables this object holds data on.
void	addScannablePosition(Object data, String[] format)	Add a position to the array of positions.
void	addScannablesAndDetectors(List<Scannable> allScannables, List<Detector> allDetectors)	Deprecated, for removal: This API element is subject to removal in a future version. this method is not used.
void	addScannableWithPosition(Scannable scannable, Object position, String[] format)	Adds a Scannable with its current data(/position/value) and the format that the data should be presented in.
boolean	equals(Object obj)
Double[]	getAllValuesAsDoubles()	Returns the values held by this ScanDataPoint of Scannables, Monitors and Detectors.
String	getCommand()
String	getCurrentFilename()
int	getCurrentPointNumber()
String	getDelimitedHeaderString()
Detector	getDetector(String name)	Searches the detectors for one of a given name.
List<Object>	getDetectorData()	Return the vector of detector data which this object is a carrier of.
Double[]	getDetectorDataAsDoubles()	Just returns array of detector data.
String[][]	getDetectorFormats()
List<String>	getDetectorHeader()	returns a list of expanded detector header string for each data point.
List<String>	getDetectorNames()	Return the list of names of detectors which this object holds data from.
List<Detector>	getDetectors()	The list of detectors this object refers to.
boolean	getHasChild()
String	getHeaderString()	Returns a string whose elements are separated by a mixture of tabs and spaces so that the columns are aligned with the output from invalid reference #toString()
String	getHeaderString(ScanDataPointFormatter dataPointFormatter)
String	getInstrument()
List<String>	getNames()
int	getNumberOfChildScans()
int	getNumberOfPoints()
List<String>	getPositionHeader()
List<Object>	getPositions()
Double[]	getPositionsAsDoubles()	Just returns array of positions.
String[]	getPositionsAsFormattedStrings()
int[]	getScanDimensions()
int	getScanIdentifier()
ScanInformation	getScanInformation()
Scannable	getScannable(String name)	Searches the scannables for one of a given name.
String[][]	getScannableFormats()
String[]	getScannableHeader()
List<String>	getScannableNames()
List<Object>	getScannablePositions()
List<Scannable>	getScannables()	The list of scannables this object refers to.
List<IScanObject>	getScanObjects()
ScanPlotSettings	getScanPlotSettings()
List<IScanStepId>	getStepIds()
String	getUniqueName()
int	hashCode()
boolean	isDetector(String name)	Searches the detectors for one of a given name.
boolean	isScannable(String name)	Searches the scannables for one of a given name.
void	setCommand(String command)
void	setCurrentFilename(String currentFilename)
void	setCurrentPointNumber(int currentPointNumber)
void	setDetectorData(List<Object> newData)
protected void	setDetectorData(List<Object> newData, String[][] format)	Replaces the detector data held by the object.
protected void	setDetectorData(List<Object> newData, List<String[]> formats)
void	setDetectorFormats(String[][] detectorFormats)
void	setDetectorFormats(List<String[]> detectorFormats)
void	setDetectorHeader(String[] detectorHeader)
void	setDetectors(List<Detector> detectors)
void	setHasChild(boolean hasChild)
void	setInstrument(String instrument)
void	setNumberOfChildScans(int numberOfChildScans)
void	setNumberOfPoints(int numberOfPoints)
void	setScanDimensions(int[] scanDimensions)
void	setScanIdentifier(int scanIdentifier)
void	setScanInformation(ScanInformation newScanInfo)
void	setScannableFormats(String[][] scannableFormats)
void	setScannableFormats(List<String[]> scannableFormats)
void	setScannableHeader(String[] scannableHeader)
void	setScannablePositions(List<Object> scannablePositions)
protected void	setScannablePositions(List<Object> positions, String[][] formats)	Replaces the scannable positions data held by the object.
void	setScannables(List<Scannable> scannables)
void	setScanObjects(List<IScanObject> scanObjects)
void	setScanPlotSettings(ScanPlotSettings scanPlotSettings)
void	setStepIds(List<IScanStepId> stepIds)
void	setUniqueName(String uniqueName)
String	toDelimitedString()	Returns a string of the information held by this object delimited by the static variable.
String	toFormattedString()	Returns a string whose elements are separated by a mixture of tabs and spaces so that the columns are aligned with the output from getHeaderString().
String	toFormattedString(ScanDataPointFormatter dataPointFormatter)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

DELIMITER

public static final String DELIMITER

The delimiter used by toString() method.

See Also:

• Constant Field Values

Constructor Details

ScanDataPoint

public ScanDataPoint()

Method Details

addScannablesAndDetectors

@Deprecated(since="9.33",
            forRemoval=true)
public void addScannablesAndDetectors(List<Scannable> allScannables,
 List<Detector> allDetectors)
                               throws DeviceException

Deprecated, for removal: This API element is subject to removal in a future version.

this method is not used. It calls Scannable.getPosition() on the scannables and Detector.readout() on the detectors, which arguably is not the job of a scan data point. Instead call addScannable(Scannable) addScannablePosition(Object, String[]), addDetector(Detector) and addDetectorData(Object, String[]) (other methods are available.

An alternative for populating this object. Can be used instead of repeated calls to addScannable,addScannablePosition,addDetector,addDetectorData.

Note this makes calls to getPosition() in the scannables and readout() in the detectors.

Specified by:

addScannablesAndDetectors in interface IScanDataPoint

Parameters:

allScannables -

allDetectors -

Throws:

DeviceException

addPositionFromScannable

@Deprecated(since="9.33",
            forRemoval=true)
public void addPositionFromScannable(Scannable scannable)
                              throws DeviceException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: IScanDataPoint

Gets a Scannables position and adds it to the data point. Does not add the Scannable itself.

Specified by:

addPositionFromScannable in interface IScanDataPoint

Parameters:

scannable -

Throws:

DeviceException

addDataFromDetector

@Deprecated(since="9.33",
            forRemoval=true)
public void addDataFromDetector(Detector detector)
                         throws DeviceException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: IScanDataPoint

Reads data from a detector and adds it to the point. Does not add the detector itself.

Specified by:

addDataFromDetector in interface IScanDataPoint

Parameters:

detector -

Throws:

DeviceException

addScannableWithPosition

public void addScannableWithPosition(Scannable scannable,
 Object position,
 String[] format)

Description copied from interface: IScanDataPoint

Adds a Scannable with its current data(/position/value) and the format that the data should be presented in.

Specified by:

addScannableWithPosition in interface IScanDataPoint

Parameters:

scannable -

position -

format -

addDetectorData

public void addDetectorData(Object data,
 String[] format)

Description copied from interface: IScanDataPoint

Add a piece of data to this object. Calls to this method must be made in the same order as calls to addDetector to associate the data with the detector.

Specified by:

addDetectorData in interface IScanDataPoint

Parameters:

data -

setDetectorData

protected void setDetectorData(List<Object> newData,
 String[][] format)

Replaces the detector data held by the object. The replacement List must be the same length as the previous for this sdp to be self-consistent.

Parameters:

newData -

setDetectorData

protected void setDetectorData(List<Object> newData,
 List<String[]> formats)

setDetectorData

public void setDetectorData(List<Object> newData)

Specified by:

setDetectorData in interface IScanDataPoint

addScannablePosition

public void addScannablePosition(Object data,
 String[] format)

Description copied from interface: IScanDataPoint

Add a position to the array of positions. Calls to this method must be made in the same order as calls to addScannable to associate the array of numbers with the scannable.

It is recommended to call setScannables instead.

Specified by:

addScannablePosition in interface IScanDataPoint

Parameters:

data -

setScannablePositions

protected void setScannablePositions(List<Object> positions,
 String[][] formats)

Replaces the scannable positions data held by the object. The replacement array must be the same length as the previous for this sdp to be self-consistent.

Parameters:

positions -

formats -

addDetector

public void addDetector(Detector det)

Description copied from interface: IScanDataPoint

Add a detector to the list of detectors this object holds data from. This stores the name in the detectorHeader array and detectorNames array. If it's a countertimer then it is stored in the boolean array. The contents of the detectorHeader and detectorNames arrays will be different if the detector is a countertimer.

Note this does not readout the detector! Data must be added by using the addData method.

Specified by:

addDetector in interface IScanDataPoint

Parameters:

det -

addScannable

public void addScannable(Scannable scannable)

Description copied from interface: IScanDataPoint

Add a scannable to the list of scannables this object holds data on.

Note that this does not read the current position of the scannable.

Specified by:

addScannable in interface IScanDataPoint

Parameters:

scannable -

getCommand

public String getCommand()

Specified by:

getCommand in interface IScanDataPoint

Returns:

the scan command entered to run the scan creating these ScanDataPoints

getCurrentFilename

public String getCurrentFilename()

Specified by:

getCurrentFilename in interface IScanDataPoint

Returns:

the name of the data file being written

getCurrentPointNumber

public int getCurrentPointNumber()

Specified by:

getCurrentPointNumber in interface IScanDataPoint

Returns:

the current point number in the scan

getDetectorData

public List<Object> getDetectorData()

Description copied from interface: IScanDataPoint

Return the vector of detector data which this object is a carrier of.

Specified by:

getDetectorData in interface IScanDataPoint

Returns:

detector data

getAllValuesAsDoubles

public Double[] getAllValuesAsDoubles()
                               throws IllegalArgumentException,
IndexOutOfBoundsException

Description copied from interface: IScanDataPoint

Returns the values held by this ScanDataPoint of Scannables, Monitors and Detectors.

Specified by:

getAllValuesAsDoubles in interface IScanDataPoint

Returns:

an array of Double of length getMonitorHeader().size() + getPositionHeader().size() + getDetectorHeader().size() if the conversion of a field to Double is not possible then the element of the array will be null

Throws:

IllegalArgumentException - if the fields convert to too few values

IndexOutOfBoundsException - if the fields convert to too many values

getDetectorDataAsDoubles

public Double[] getDetectorDataAsDoubles()

Description copied from interface: IScanDataPoint

Just returns array of detector data.

Specified by:

getDetectorDataAsDoubles in interface IScanDataPoint

Returns:

all detector data.

getDetectorHeader

public List<String> getDetectorHeader()

Description copied from interface: IScanDataPoint

returns a list of expanded detector header string for each data point.

Specified by:

getDetectorHeader in interface IScanDataPoint

Returns:

a list of expanded detector header string for each data point.

getDetectorNames

public List<String> getDetectorNames()

Description copied from interface: IScanDataPoint

Return the list of names of detectors which this object holds data from.

Specified by:

getDetectorNames in interface IScanDataPoint

Returns:

list of detector names

getDetectors

public List<Detector> getDetectors()

Description copied from interface: IScanDataPoint

The list of detectors this object refers to.

Specified by:

getDetectors in interface IScanDataPoint

Returns:

list of detectors this object refers to.

setDetectors

public void setDetectors(List<Detector> detectors)

getHasChild

public boolean getHasChild()

Specified by:

getHasChild in interface IScanDataPoint

Returns:

true if the current scan has a nested child scan, false otherwise

getHeaderString

public String getHeaderString()

Description copied from interface: IScanDataPoint

Returns a string whose elements are separated by a mixture of tabs and spaces so that the columns are aligned with the output from

invalid reference

#toString()

Specified by:

getHeaderString in interface IScanDataPoint

Returns:

header string, which could be used in an ascii print out of all the scan points from the same scan

getHeaderString

public String getHeaderString(ScanDataPointFormatter dataPointFormatter)

Specified by:

getHeaderString in interface IScanDataPoint

Parameters:

dataPointFormatter -

Returns:

String - the header String formatted used the given Formatter object

getDelimitedHeaderString

public String getDelimitedHeaderString()

Specified by:

getDelimitedHeaderString in interface IScanDataPoint

Returns:

the header with each element separated by a tab

getInstrument

public String getInstrument()

Specified by:

getInstrument in interface IScanDataPoint

Returns:

the beamline/instrument running the scan

getNames

public List<String> getNames()

Specified by:

getNames in interface IScanDataPoint

Returns:

list of scannable names

getNumberOfChildScans

public int getNumberOfChildScans()

Specified by:

getNumberOfChildScans in interface IScanDataPoint

Returns:

number of nested inner (child) scans

getNumberOfPoints

public int getNumberOfPoints()

Specified by:

getNumberOfPoints in interface IScanDataPoint

Returns:

number of points in this scan

getPositionHeader

public List<String> getPositionHeader()

Specified by:

getPositionHeader in interface IScanDataPoint

Returns:

the part of the header from the Scannables (not Detectors) as a list of strings

getPositions

public List<Object> getPositions()

Specified by:

getPositions in interface IScanDataPoint

Returns:

the part of the data from the Scannables (not Detectors) as a list of objects

getScanIdentifier

public int getScanIdentifier()

Specified by:

getScanIdentifier in interface IScanDataPoint

Returns:

unique ID of the scan

getScannableNames

public List<String> getScannableNames()

Specified by:

getScannableNames in interface IScanDataPoint

Returns:

list of the names of the Scannables in the scan

getPositionsAsDoubles

public Double[] getPositionsAsDoubles()

Description copied from interface: IScanDataPoint

Just returns array of positions. Strings will be an empty element.

Specified by:

getPositionsAsDoubles in interface IScanDataPoint

Returns:

all scannable positions.

getPositionsAsFormattedStrings

public String[] getPositionsAsFormattedStrings()

Specified by:

getPositionsAsFormattedStrings in interface IScanDataPoint

Returns:

all Scannable positions as strings using the given format

getScannables

public List<Scannable> getScannables()

The list of scannables this object refers to.

Specified by:

getScannables in interface IScanDataPoint

Returns:

list of scannables this object refers to.

setScannables

public void setScannables(List<Scannable> scannables)

getScanPlotSettings

public ScanPlotSettings getScanPlotSettings()

Specified by:

getScanPlotSettings in interface IScanDataPoint

setScanPlotSettings

public void setScanPlotSettings(ScanPlotSettings scanPlotSettings)

Specified by:

setScanPlotSettings in interface IScanDataPoint

getScanDimensions

public int[] getScanDimensions()

Specified by:

getScanDimensions in interface IScanDataPoint

Returns:

the dimensions of the nest of scans

setScanDimensions

public void setScanDimensions(int[] scanDimensions)

Specified by:

setScanDimensions in interface IScanDataPoint

toString

public String toString()

Overrides:

toString in class Object

toFormattedString

public String toFormattedString()

Description copied from interface: IScanDataPoint

Returns a string whose elements are separated by a mixture of tabs and spaces so that the columns are aligned with the output from getHeaderString().

To be used to create an ascii version of the data held by this object for printing to terminals or to ascii files.

Specified by:

toFormattedString in interface IScanDataPoint

toFormattedString

public String toFormattedString(ScanDataPointFormatter dataPointFormatter)

Specified by:

toFormattedString in interface IScanDataPoint

toDelimitedString

public String toDelimitedString()

Description copied from interface: IScanDataPoint

Returns a string of the information held by this object delimited by the static variable.

Specified by:

toDelimitedString in interface IScanDataPoint

Returns:

this point as a delimited string

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getStepIds

public List<IScanStepId> getStepIds()

Specified by:

getStepIds in interface IScanDataPoint

setStepIds

public void setStepIds(List<IScanStepId> stepIds)

Specified by:

setStepIds in interface IScanDataPoint

getUniqueName

public String getUniqueName()

Specified by:

getUniqueName in interface IScanDataPoint

Returns:

the unique identifier for the scan.

setUniqueName

public void setUniqueName(String uniqueName)

Specified by:

setUniqueName in interface IScanDataPoint

setCommand

public void setCommand(String command)

Specified by:

setCommand in interface IScanDataPoint

setCurrentFilename

public void setCurrentFilename(String currentFilename)

Specified by:

setCurrentFilename in interface IScanDataPoint

setCurrentPointNumber

public void setCurrentPointNumber(int currentPointNumber)

Specified by:

setCurrentPointNumber in interface IScanDataPoint

setHasChild

public void setHasChild(boolean hasChild)

Specified by:

setHasChild in interface IScanDataPoint

setInstrument

public void setInstrument(String instrument)

Specified by:

setInstrument in interface IScanDataPoint

setNumberOfChildScans

public void setNumberOfChildScans(int numberOfChildScans)

Specified by:

setNumberOfChildScans in interface IScanDataPoint

Parameters:

numberOfChildScans - The numberOfChildScans to set.

setNumberOfPoints

public void setNumberOfPoints(int numberOfPoints)

Specified by:

setNumberOfPoints in interface IScanDataPoint

setScanIdentifier

public void setScanIdentifier(int scanIdentifier)

Specified by:

setScanIdentifier in interface IScanDataPoint

getScannableFormats

public String[][] getScannableFormats()

Specified by:

getScannableFormats in interface IScanDataPoint

setScannableFormats

public void setScannableFormats(String[][] scannableFormats)

Specified by:

setScannableFormats in interface IScanDataPoint

setScannableFormats

public void setScannableFormats(List<String[]> scannableFormats)

setDetectorHeader

public void setDetectorHeader(String[] detectorHeader)

Specified by:

setDetectorHeader in interface IScanDataPoint

getScannableHeader

public String[] getScannableHeader()

Specified by:

getScannableHeader in interface IScanDataPoint

setScannableHeader

public void setScannableHeader(String[] scannableHeader)

Specified by:

setScannableHeader in interface IScanDataPoint

getScannablePositions

public List<Object> getScannablePositions()

Specified by:

getScannablePositions in interface IScanDataPoint

setScannablePositions

public void setScannablePositions(List<Object> scannablePositions)

Specified by:

setScannablePositions in interface IScanDataPoint

getScanObjects

public List<IScanObject> getScanObjects()

Specified by:

getScanObjects in interface IScanDataPoint

setScanObjects

public void setScanObjects(List<IScanObject> scanObjects)

Specified by:

setScanObjects in interface IScanDataPoint

getDetectorFormats

public String[][] getDetectorFormats()

Specified by:

getDetectorFormats in interface IScanDataPoint

setDetectorFormats

public void setDetectorFormats(String[][] detectorFormats)

Specified by:

setDetectorFormats in interface IScanDataPoint

setDetectorFormats

public void setDetectorFormats(List<String[]> detectorFormats)

getScannable

public Scannable getScannable(String name)

Description copied from interface: IScanDataPoint

Searches the scannables for one of a given name. Used to avoid searches being in many places.

Specified by:

getScannable in interface IScanDataPoint

Parameters:

name -

Returns:

the scannable with the given name in this point if it exists, otherwise null

isScannable

public boolean isScannable(String name)

Description copied from interface: IScanDataPoint

Searches the scannables for one of a given name. Works for scannables where name is declared and the actual scannable is not sent over.

Specified by:

isScannable in interface IScanDataPoint

Parameters:

name -

Returns:

true if this point contains a scannable with this name, false otherwise

getDetector

public Detector getDetector(String name)

Description copied from interface: IScanDataPoint

Searches the detectors for one of a given name. Used to avoid searches being in many places.

Specified by:

getDetector in interface IScanDataPoint

Parameters:

name -

Returns:

the detector with the given name in this point if it exists, otherwise null

isDetector

public boolean isDetector(String name)

Description copied from interface: IScanDataPoint

Searches the detectors for one of a given name. Works for detectors where name is declared and the actual detector is not sent over.

Specified by:

isDetector in interface IScanDataPoint

Parameters:

name -

Returns:

true if this point contains a detector with the given name, false otherwise

getScanInformation

public ScanInformation getScanInformation()

Specified by:

getScanInformation in interface IScanDataPoint

setScanInformation

public void setScanInformation(ScanInformation newScanInfo)