Package gda.scan

Class CentroidScan

java.lang.Object

gda.scan.ScanBase

gda.scan.CentroidScan

All Implemented Interfaces:

NestableScan, Scan, ScanChild, Serializable

public class CentroidScan
extends ScanBase

Wrapper for the ConcurrentScan, except it takes centroid, width, step as arguments.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class gda.scan.ScanBase

ScanBase.ParentScanComponent

Nested classes/interfaces inherited from interface gda.scan.Scan

Scan.ScanStatus

Field Summary

Fields inherited from class gda.scan.ScanBase

allDetectors, allScannables, callCollectDataOnDetectors, child, command, currentPointCount, GDA_SCANBASE_FIRST_SCAN_NUMBER_FOR_TEST, GDA_SCANBASE_PRINT_TIMESTAMP_TO_TERMINAL, instrument, isChild, name, numberOfChildScans, parent, parentComponent, permissionLevel, scanDataPointPipeline, stepId, totalNumberOfPoints

Constructor Summary

Constructors

Constructor	Description
CentroidScan(Object[] args)	Expect arguments in the format:

Method Summary

Modifier and Type	Method	Description
void	doCollection()	The method in which the work of the scan is performed.
protected void	endScan()	This should be called by all scans when they have finished, including when an exception has been raised.
List<Detector>	getDetectors()	Returns the list of Detector objects which form part of the scan.
List<Scannable>	getScannables()	Returns the list of all the Scannable objects which are part of this scan
void	prepareForCollection()	This should called by all scans just before they start to collect data.
static void	runScan(Object[] args)	Creates and runs a scan.

Methods inherited from class gda.scan.ScanBase

callAtCommandFailureHooks, callDetectorsEndCollection, callScannablesAtScanEnd, callScannablesAtScanLineEnd, callScannablesAtScanLineStart, callScannablesAtScanStart, cancelReadoutAndPublishCompletion, checkStartStopStep, checkThreadInterrupted, collectData, createScanDataPoint, createScanDataPointPipeline, createScanDataPointPipeline, generateRandomName, getChild, getDataWriter, getDimension, getDimensions, getName, getNumberOfChildScans, getParent, getPositionCallableThreadPoolSize, getScanDataPointPipeline, getScanDataPointQueueLength, getScanInformation, getScanNumber, getScanPlotSettings, getStatus, getStepId, getStepIds, getTotalNumberOfPoints, isChild, isFinishEarlyRequested, isLineScanNeedsDoing, notifyServer, notifyServer, numberOfScannablesThatCanProvidePositionCallables, pause, prepareDevicesForCollection, prepareScanForCollection, prepareScanNumber, prepareStaticVariables, readDevicesAndPublishScanDataPoint, readoutDetectorsAndPublish, reorderScannables, representThrowable, requestFinishEarly, resume, run, runScan, scanRunning, sendScanEvent, setChild, setDataWriter, setDetectors, setIsChild, setLineScanNeedsDoing, setNumberOfChildScans, setParent, setPositionCallableThreadPoolSize, setScanDataPointPipeline, setScanDataPointQueueLength, setScanIdentifierInScanDataPoint, setScannables, setScanNumber, setScanPlotSettings, setStatus, setStepId, setUp, shutdownScandataPipeline, signalScanComplete, signalScanStarted, sortArguments, waitForDetectorReadoutAndPublishCompletion, waitIfPaused, wasScanExplicitlyHalted, wrappedException

Methods inherited from class java.lang.Object

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

Constructor Details

CentroidScan

public CentroidScan(Object[] args)
             throws IllegalArgumentException

Expect arguments in the format:

scannbleObject1 centroid [width step] scannbleObject2 centroid [width step] scannbleObject3 centroid [width step]

If width defined, then step must be defined, else an error is thrown.

The number of steps for each scannable must be the same, or an error will be thrwon.

Parameters:

args - Object[]

Throws:

IllegalArgumentException

Method Details

getDetectors

public List<Detector> getDetectors()

Description copied from interface: Scan

Returns the list of Detector objects which form part of the scan.

Specified by:

getDetectors in interface Scan

Overrides:

getDetectors in class ScanBase

Returns:

Vector of Detectors

getScannables

public List<Scannable> getScannables()

Description copied from interface: Scan

Returns the list of all the Scannable objects which are part of this scan

Specified by:

getScannables in interface Scan

Overrides:

getScannables in class ScanBase

Returns:

Vector of Scannables

runScan

public static void runScan(Object[] args)
                    throws InterruptedException,
Exception

Creates and runs a scan.

Parameters:

args - String[]

Throws:

InterruptedException

Exception

prepareForCollection

public void prepareForCollection()
                          throws Exception

Description copied from class: ScanBase

This should called by all scans just before they start to collect data. It resets the static variable which the scan classes use and creates a dataHandler if one has not been created yet.

Specified by:

prepareForCollection in interface Scan

Overrides:

prepareForCollection in class ScanBase

Throws:

Exception

doCollection

public void doCollection()
                  throws Exception

Description copied from interface: Scan

The method in which the work of the scan is performed. This method assumes that the data handler has already been created and the baton claimed.

Specified by:

doCollection in interface Scan

Specified by:

doCollection in class ScanBase

Throws:

Exception

endScan

protected void endScan()
                throws DeviceException,
InterruptedException

Description copied from class: ScanBase

This should be called by all scans when they have finished, including when an exception has been raised.

Overrides:

endScan in class ScanBase

Throws:

DeviceException

InterruptedException