Package gda.device.detector.pixium

Class PixiumNXDetector

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.NXDetector

gda.device.detector.pixium.PixiumNXDetector

All Implemented Interfaces:

Detector, NexusDetector, NXPluginDetector, IPixiumNXDetector, Device, Scannable, PositionCallableProvider<NexusTreeProvider>, Configurable, Findable, gda.observable.IObservable, Serializable, org.springframework.beans.factory.InitializingBean

public class PixiumNXDetector
extends NXDetector
implements IPixiumNXDetector

See Also:

• Serialized Form

Field Summary

Fields inherited from class gda.device.detector.NXDetector

lastReadoutValue, UNSUPPORTED_PART_OF_SCANNABLE_INTERFACE, UNSUPPORTED_SET_FUNCTION

Fields inherited from class gda.device.detector.DetectorBase

collectionTime

Fields inherited from class gda.device.scannable.ScannableBase

__doc__, DEFAULT_INPUT_NAME, DEFAULT_OUTPUT_FORMAT, extraNames, inputNames, level, outputFormat

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Fields inherited from interface gda.device.Detector

BUSY, FAULT, IDLE, MONITORING, PAUSED, STANDBY

Fields inherited from interface gda.device.detector.pixium.IPixiumNXDetector

ACQUIRE, BASE_ACQUIRE_PERIOD, BASE_ACQUIRE_PERIOD_RBV, BASE_EXPOSURE, BASE_EXPOSURE_RBV, CALIBRATE, CALIBRATE_RBV, CALIBRATION_REQUIRED_RBV, DETECTOR_STATE_RBV, EARLY_FRAMES, EARLY_FRAMES_RBV, EXPOSURES_PER_IMAGE, EXPOSURES_PER_IMAGE_RBV, NUM_IMAGES, NUM_IMAGES_RBV, PU_MODE, PU_MODE_RBV

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
PixiumNXDetector()

Method Summary

Modifier and Type	Method	Description
void	acquire(double collectionTime)
void	acquire(double collectionTime, int numImages)
void	afterPropertiesSet()
void	atPointEnd()	Called on every Scannable at the end of every data point, for scans which are broken down into individual points (i.e.
void	atPointStart()	Called on every Scannable at every data point, for scans which are broken down into individual points (i.e.
void	atScanEnd()	Called for every Scannable at the end of a group of nested scans (or a single scan if that is the case).
void	atScanStart()	Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case)
void	calibrate()
void	excludeEarlyFrames()
void	excludeEarlyFramesExt()
double	getBaseAcquirePeriod()
double	getBaseExposure()
Scriptcontroller	getEventAdmin()
int	getExposuresPerImage()
Scannable	getFastshutter()
int	getNumImages()
String	getPrefix()
int	getPUMode()
int	getShutterIntForClose()
int	getShutterIntForOpen()
String	getShutterPVName()
String[]	getWindowsSubString()
void	includeEarlyFrames()
void	includeEarlyFramesExt()
boolean	isUseShutter()
void	reportAllowablePUModes()
int	reportEarlyFrames()
int	reportEarlyFramesExt()
void	setBaseAcquirePeriod(double acqTime)
void	setBaseAcquirePeriodExt(double acqTime)
void	setBaseExposure(double expTime)
void	setBaseExposureExt(double expTime)
void	setEventAdmin(Scriptcontroller eventAdmin)
void	setExposuresPerImage(int numExp)
void	setExposuresPerImageExt(int numExp)
void	setFastshutter(Scannable fastshutter)
void	setNumImages(int numImg)
void	setNumImagesExt(int numImg)
void	setPrefix(String prefix)
void	setPUMode(int mode)
void	setPUModeExt(int mode)
void	setShutterIntForClose(int shutterIntForClose)
void	setShutterIntForOpen(int shutterIntForOpen)
void	setShutterPVName(String shutterPVName)
void	setUseShutter(boolean useShutter)
void	setWindowsSubString(String windowsSubString)
void	stop()	Stop the current move/operation.
void	stopAcquiring()
void	waitForIntPVValEqualTo(PV<Integer> pv, int valWaitedFor, double timeoutSec)
void	waitForIntPVValNotEqualTo(PV<Integer> pv, int valWaitedFor, double timeoutSec)
void	waitForShutterPos(int shutterPosWaitedFor, double timeoutSec)

Methods inherited from class gda.device.detector.NXDetector

__getattr__, __str__, asynchronousMoveTo, atCommandFailure, atScanLineEnd, atScanLineStart, collectData, createsOwnFiles, endCollection, getAdditionalPluginList, getCollectionStrategy, getExtraNames, getFileStructure, getInputNames, getOutputFormat, getPlugin, getPluginList, getPluginMap, getPosition, getPositionCallable, getStatus, isAddCollectTimeMs, isBusy, prepareCollectionStrategyAtScanStart, prepareForCollection, readout, setAddCollectTimeMs, setAdditionalPluginList, setCollectionStrategy, setExtraNames, setInputNames, setOutputFormat, waitWhileBusy

Methods inherited from class gda.device.detector.DetectorBase

checkPositionValid, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, setCollectionTime, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, atLevelEnd, atLevelMoveStart, atLevelStart, externalToInternal, getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setLevel, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, getAttribute, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setName, setProtectionLevel

Methods inherited from class gda.factory.ConfigurableBase

configure, isConfigured, reconfigure, setConfigured

Methods inherited from class java.lang.Object

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

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Detector

getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, setCollectionTime

Methods inherited from interface gda.device.Device

close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Methods inherited from interface gda.device.Scannable

atLevelEnd, atLevelMoveStart, atLevelStart, checkPositionValid, getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, moveTo, setLevel, setScanMetadataAttribute, setScanMetadataAttributes, toFormattedString

Constructor Details

PixiumNXDetector

public PixiumNXDetector()

Method Details

getShutterPVName

public String getShutterPVName()

setShutterPVName

public void setShutterPVName(String shutterPVName)

getShutterIntForClose

public int getShutterIntForClose()

setShutterIntForClose

public void setShutterIntForClose(int shutterIntForClose)

getShutterIntForOpen

public int getShutterIntForOpen()

setShutterIntForOpen

public void setShutterIntForOpen(int shutterIntForOpen)

isUseShutter

public boolean isUseShutter()

setUseShutter

public void setUseShutter(boolean useShutter)

getPrefix

public String getPrefix()

setPrefix

public void setPrefix(String prefix)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Overrides:

afterPropertiesSet in class NXDetector

atScanStart

public void atScanStart()
                 throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case) Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanStart in interface Scannable

Overrides:

atScanStart in class NXDetector

Throws:

DeviceException

See Also:

• Scannable.atScanStart()

atPointStart

public void atPointStart()
                  throws DeviceException

Description copied from class: ScannableBase

Called on every Scannable at every data point, for scans which are broken down into individual points (i.e. non-continuous scans) Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atPointStart in interface Scannable

Overrides:

atPointStart in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atPointStart()

atPointEnd

public void atPointEnd()
                throws DeviceException

Description copied from class: ScannableBase

Called on every Scannable at the end of every data point, for scans which are broken down into individual points (i.e. non-continous scans) Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atPointEnd in interface Scannable

Overrides:

atPointEnd in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atPointEnd()

atScanEnd

public void atScanEnd()
               throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the end of a group of nested scans (or a single scan if that is the case).

Note that this is only called if the Scan finishes normally, or has been requested to finish early. This will not be called if the scan finishes due to an exception of any kind. See Scannable.atCommandFailure() Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanEnd in interface Scannable

Overrides:

atScanEnd in class NXDetector

Throws:

DeviceException

See Also:

• Scannable.atScanEnd()

includeEarlyFrames

public void includeEarlyFrames()
                        throws IOException,
DeviceException

Specified by:

includeEarlyFrames in interface IPixiumNXDetector

Throws:

IOException

DeviceException

includeEarlyFramesExt

public void includeEarlyFramesExt()
                           throws IOException,
DeviceException

Throws:

IOException

DeviceException

excludeEarlyFrames

public void excludeEarlyFrames()
                        throws Exception

Specified by:

excludeEarlyFrames in interface IPixiumNXDetector

Throws:

Exception

excludeEarlyFramesExt

public void excludeEarlyFramesExt()
                           throws Exception

Throws:

Exception

reportEarlyFrames

public int reportEarlyFrames()
                      throws IOException

Throws:

IOException

reportEarlyFramesExt

public int reportEarlyFramesExt()
                         throws IOException

Throws:

IOException

setBaseExposure

public void setBaseExposure(double expTime)
                     throws Exception

Specified by:

setBaseExposure in interface IPixiumNXDetector

Throws:

Exception

setBaseExposureExt

public void setBaseExposureExt(double expTime)
                        throws Exception

Throws:

Exception

getBaseExposure

public double getBaseExposure()
                       throws Exception

Specified by:

getBaseExposure in interface IPixiumNXDetector

Throws:

Exception

setBaseAcquirePeriod

public void setBaseAcquirePeriod(double acqTime)
                          throws Exception

Specified by:

setBaseAcquirePeriod in interface IPixiumNXDetector

Throws:

Exception

setBaseAcquirePeriodExt

public void setBaseAcquirePeriodExt(double acqTime)
                             throws Exception

Throws:

Exception

getBaseAcquirePeriod

public double getBaseAcquirePeriod()
                            throws Exception

Specified by:

getBaseAcquirePeriod in interface IPixiumNXDetector

Throws:

Exception

setExposuresPerImage

public void setExposuresPerImage(int numExp)
                          throws Exception

Specified by:

setExposuresPerImage in interface IPixiumNXDetector

Throws:

Exception

setExposuresPerImageExt

public void setExposuresPerImageExt(int numExp)
                             throws Exception

Throws:

Exception

getExposuresPerImage

public int getExposuresPerImage()
                         throws Exception

Specified by:

getExposuresPerImage in interface IPixiumNXDetector

Throws:

Exception

setNumImages

public void setNumImages(int numImg)
                  throws Exception

Specified by:

setNumImages in interface IPixiumNXDetector

Throws:

Exception

setNumImagesExt

public void setNumImagesExt(int numImg)
                     throws Exception

Throws:

Exception

getNumImages

public int getNumImages()
                 throws Exception

Specified by:

getNumImages in interface IPixiumNXDetector

Throws:

Exception

setPUMode

public void setPUMode(int mode)
               throws Exception

Specified by:

setPUMode in interface IPixiumNXDetector

Throws:

Exception

setPUModeExt

public void setPUModeExt(int mode)
                  throws Exception

Throws:

Exception

getPUMode

public int getPUMode()
              throws Exception

Specified by:

getPUMode in interface IPixiumNXDetector

Throws:

Exception

reportAllowablePUModes

public void reportAllowablePUModes()

calibrate

public void calibrate()
               throws Exception

Specified by:

calibrate in interface IPixiumNXDetector

Throws:

Exception

waitForIntPVValEqualTo

public void waitForIntPVValEqualTo(PV<Integer> pv,
 int valWaitedFor,
 double timeoutSec)
                            throws DeviceException

Throws:

DeviceException

waitForIntPVValNotEqualTo

public void waitForIntPVValNotEqualTo(PV<Integer> pv,
 int valWaitedFor,
 double timeoutSec)
                               throws DeviceException

Throws:

DeviceException

waitForShutterPos

public void waitForShutterPos(int shutterPosWaitedFor,
 double timeoutSec)
                       throws DeviceException

Throws:

DeviceException

acquire

public void acquire(double collectionTime,
 int numImages)
             throws Exception

Specified by:

acquire in interface IPixiumNXDetector

Throws:

Exception

acquire

public void acquire(double collectionTime)
             throws Exception

Specified by:

acquire in interface IPixiumNXDetector

Throws:

Exception

stop

public void stop()
          throws DeviceException

Description copied from class: ScannableBase

Stop the current move/operation. Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

stop in interface IPixiumNXDetector

Specified by:

stop in interface Scannable

Overrides:

stop in class NXDetector

Throws:

DeviceException

See Also:

• Scannable.stop()

stopAcquiring

public void stopAcquiring()
                   throws Exception

Throws:

Exception

setWindowsSubString

public void setWindowsSubString(String windowsSubString)

getWindowsSubString

public String[] getWindowsSubString()

getFastshutter

public Scannable getFastshutter()

setFastshutter

public void setFastshutter(Scannable fastshutter)

getEventAdmin

public Scriptcontroller getEventAdmin()

setEventAdmin

public void setEventAdmin(Scriptcontroller eventAdmin)