Package gda.scan

Class EdeScanWithTFGTrigger

java.lang.Object

gda.scan.ScanBase

gda.scan.ConcurrentScanChild

gda.scan.EdeScan

gda.scan.EdeScanWithTFGTrigger

All Implemented Interfaces:

EnergyDispersiveExafsScan, IConcurrentScanChild, NestableScan, Scan, ScanChild, Serializable

public class EdeScanWithTFGTrigger
extends EdeScan
implements EnergyDispersiveExafsScan

This is the with-beam It scan in linear and cyclic experiments.

This involves more than just the XCHIP detectors. It needs to also talk to an external TFG (eTFG) unit which will fire out synchronised TTL hardware signals to the photon shutter, user sample environments as well as the XCHIP detector. It will also hold a counter (scaler) of signals from Diamond's injection pulses so we can match up spectra to when (if) storage ring top-ups occur.

Wiring connections are assumed to be:

TRIG0 cable from machine top-up signal

TRIG1 cable from XH, to increment frames counting machine insertion signals

USR OUT 0 cable to photon shutter

USR OUT 1 cable to XH, to start the It sequence

USR OUT 2..7 cables to sample environments

SCA 0 cable from machine insertion signal

See Also:

• Serialized Form

Nested Class Summary

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

ConcurrentScanChild.PointPositionInLine

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.EdeScan

motorPositions, rawData, scanParameters, scanType, theDetector, topupChecker

Fields inherited from class gda.scan.ConcurrentScanChild

allChildScans, allScanObjects, detectorReadoutTask, scannableLevels

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
EdeScanWithTFGTrigger(EdeScanParameters scanParameters, TFGTrigger triggeringParameters, EdeScanPosition motorPositions, EdeScanType scanType, EdeDetector theDetector, Integer repetitionNumber, Scannable shutter, boolean shouldWaitForTopup)

Method Summary

Modifier and Type	Method	Description
protected void	addDetectorsToScanDataPoint(int lowFrame, Object[] detData, int thisFrame, ScanDataPoint thisPoint)
void	doCollection()	The method in which the work of the scan is performed.
void	doCollectionFrelon()
void	doCollectionOld()
protected NexusTreeProvider[]	readDetectors(int lowFrame, int highFrame)
void	setStatus(Scan.ScanStatus status)	To allow nests of scans to share a common status with each other.
String	toString()

Methods inherited from class gda.scan.EdeScan

addScannableToMonitorDuringScan, collectDetectorData, extractDetectorDataSet, extractEnergyDetectorDataSet, extractLastDetectorDataSet, fastShutterMoveTo, getCommand, getData, getDataPoints, getDetector, getDimension, getFastShutter, getHeaderDescription, getMotorPositions, getNumberOfAvailablePoints, getScannablesToMonitorDuringScan, getScanParameters, getScanType, getSleepTimeAfterCollection, getTotalNumberOfPoints, gsUseFastShutter, isIncludeGroupNumberInSDPLabel, isScannableToBeMoved, isSmartstop, isUseNexusTreeWriter, moveSampleIntoPosition, moveShutter, pollDetectorAndFetchData, setFastShutter, setIncludeCyclePlotLabel, setMotorPositions, setNoOfSecPerSpectrumToPublish, setProgressUpdater, setScannablesToMonitorDuringScan, setScanParameters, setScanType, setSmartstop, setUseFastShutter, setUseNexusTreeWriter, setWaitTimeAfterCollection, smartStopDetected, validate, waitAfterCollection, waitBeforeCycle

Methods inherited from class gda.scan.ConcurrentScanChild

acquirePoint, cancelReadoutAndPublishCompletion, checkAllMovesComplete, generateDevicesToMoveByLevel, getAllChildScans, getAllDetectors, getAllScannables, getAllScanObjects, getChild, getPointPositionInLine, getScannableLevels, isMustBeFinal, isReadoutConcurrent, isScannableActuallyToBeMoved, readoutDetectorsAndPublish, reorderAllScanObjects, setAllChildScans, setAllDetectors, setAllScannables, setAllScanObjects, setChild, setCommand, setMustBeFinal, setPointPositionInLine, setScannableLevels, setTotalNumberOfPoints, setUp, waitForDetectorReadoutAndPublishCompletion

Methods inherited from class gda.scan.ScanBase

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface gda.scan.EnergyDispersiveExafsScan

extractDetectorDataSet, extractEnergyDetectorDataSet, getData, getDetector, getHeaderDescription, getScanParameters, getScanType, setProgressUpdater, setScanParameters, setScanType

Methods inherited from interface gda.scan.Scan

getDataWriter, getDetectors, getDimension, getName, getScanDataPointPipeline, getScanInformation, getScannables, getScanNumber, getScanPlotSettings, getStatus, getStepId, isChild, isFinishEarlyRequested, pause, prepareForCollection, requestFinishEarly, resume, run, runScan, setChild, setDataWriter, setDetectors, setIsChild, setScanDataPointPipeline, setScannables, setScanPlotSettings, setStepId

Methods inherited from interface gda.scan.ScanChild

getParent, setParent

Constructor Details

EdeScanWithTFGTrigger

public EdeScanWithTFGTrigger(EdeScanParameters scanParameters,
 TFGTrigger triggeringParameters,
 EdeScanPosition motorPositions,
 EdeScanType scanType,
 EdeDetector theDetector,
 Integer repetitionNumber,
 Scannable shutter,
 boolean shouldWaitForTopup)

Method Details

doCollectionFrelon

public void doCollectionFrelon()
                        throws Exception

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

Overrides:

doCollection in class EdeScan

Throws:

Exception

doCollectionOld

public void doCollectionOld()
                     throws Exception

Throws:

Exception

addDetectorsToScanDataPoint

protected void addDetectorsToScanDataPoint(int lowFrame,
 Object[] detData,
 int thisFrame,
 ScanDataPoint thisPoint)
                                    throws DeviceException

Overrides:

addDetectorsToScanDataPoint in class EdeScan

Throws:

DeviceException

readDetectors

protected NexusTreeProvider[] readDetectors(int lowFrame,
 int highFrame)
                                     throws Exception,
DeviceException

Overrides:

readDetectors in class EdeScan

Throws:

Exception

DeviceException

toString

public String toString()

Overrides:

toString in class EdeScan

setStatus

void setStatus(Scan.ScanStatus status)

To allow nests of scans to share a common status with each other.

Parameters:

status -