Package gda.device.detector.addetector

Class ADCameraDetector

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.addetector.ADCameraDetector

All Implemented Interfaces:

Detector, NexusDetector, Device, Scannable, Configurable, Findable, gda.observable.IObservable, Serializable, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

ADCameraDetector

public class ADCameraDetector
extends DetectorBase
implements org.springframework.beans.factory.InitializingBean, NexusDetector

we assume the camera is in constant acquire mode, so we can just grab an image from the array plugin this class only usefully writes to NeXus

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Object>	attributeMap

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

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
ADCameraDetector()

Method Summary

Modifier and Type	Method	Description
void	acquire()
protected void	addMetadata(NXDetectorData nxdata)
void	afterPropertiesSet()
int[]	cagetArrayUnsigned()
void	collectData()	Tells the detector to begin to collect a set of data, then returns immediately.
void	configure()	Default implementation for classes that do not have to do any specific configuration. Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.
boolean	createsOwnFiles()	Returns a value which indicates whether the detector creates its own files.
int	getAcquireState()
double	getAcquireTime()
ADBase	getAreaDetector()
AreaDetectorROI	getAreaDetectorROI()
NDArray	getArray()
int	getArrayCounter()
Object	getAttribute(String attributeName)	Get the value of the specified attribute
String	getBasePVName()
int	getCaptureState()
float[]	getCurrentArray()
int[]	getDataDimensions()	Default which should be overridden by subclasses.
String	getDescription()
String	getDetectorID()
short	getDetectorState()
String	getDetectorType()
NDOverlay	getDraw()
int	getExposures()
int	getImageMode()
int	getNumImages()
IPVProvider	getPvProvider()
int	getStatus()	Returns the current collecting state of the device.
int	getTriggerMode()
org.eclipse.january.dataset.IntegerDataset	readLastImage()
NexusTreeProvider	readout()	Returns the latest data collected as well as general detector information
void	resetAll()
void	resetCounters()
void	setAcquirePeriod(double acquirePeriod)
void	setAcquireTime(double time)
void	setAreaDetector(ADBase areaDetector)
void	setArray(NDArray array)
void	setAttribute(String attributeName, Object value)	Set any attribute the implementing classes may provide
void	setBasePVName(String basePVName)
void	setDraw(NDOverlay draw)
void	setExposures(int numberOfExposures)
void	setImageMode(int imageMode)
void	setNumImages(int numberOfExposures)
void	setPvProvider(IPVProvider pvProvider)
void	setTriggerMode(int mode)
void	stopAcquiring()

Methods inherited from class gda.device.detector.DetectorBase

asynchronousMoveTo, checkPositionValid, endCollection, getCollectionTime, getPosition, isBusy, prepareForCollection, setCollectionTime, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, waitWhileBusy, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

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

Methods inherited from class gda.factory.ConfigurableBase

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

isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Detector

endCollection, getCollectionTime, getFileStructure, prepareForCollection, setCollectionTime, waitWhileBusy

Methods inherited from interface gda.device.Device

close, getProtectionLevel, 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

asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString

Field Details

attributeMap

protected Map<String,Object> attributeMap

Constructor Details

ADCameraDetector

public ADCameraDetector()

Method Details

configure

public void configure()
               throws FactoryException

Description copied from class: ConfigurableBase

Default implementation for classes that do not have to do any specific configuration.
Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.

Specified by:

configure in interface Configurable

Overrides:

configure in class ConfigurableBase

Throws:

FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

getAreaDetector

public ADBase getAreaDetector()

setAreaDetector

public void setAreaDetector(ADBase areaDetector)

getDraw

public NDOverlay getDraw()

setDraw

public void setDraw(NDOverlay draw)

getBasePVName

public String getBasePVName()

setBasePVName

public void setBasePVName(String basePVName)

resetAll

public void resetAll()
              throws Exception

Throws:

Exception

getTriggerMode

public int getTriggerMode()
                   throws Exception

Throws:

Exception

setTriggerMode

public void setTriggerMode(int mode)
                    throws Exception

Throws:

Exception

setExposures

public void setExposures(int numberOfExposures)
                  throws Exception

Throws:

Exception

getExposures

public int getExposures()
                 throws Exception

Throws:

Exception

setNumImages

public void setNumImages(int numberOfExposures)
                  throws Exception

Throws:

Exception

getNumImages

public int getNumImages()
                 throws Exception

Throws:

Exception

setAcquireTime

public void setAcquireTime(double time)
                    throws Exception

Throws:

Exception

getAcquireTime

public double getAcquireTime()
                      throws Exception

Throws:

Exception

getPvProvider

public IPVProvider getPvProvider()

setPvProvider

public void setPvProvider(IPVProvider pvProvider)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

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

Throws:

Exception

acquire

public void acquire()
             throws Exception

Throws:

Exception

getDetectorState

public short getDetectorState()
                       throws Exception

Throws:

Exception

getAcquireState

public int getAcquireState()
                    throws Exception

Throws:

Exception

getArrayCounter

public int getArrayCounter()
                    throws Exception

Throws:

Exception

setAcquirePeriod

public void setAcquirePeriod(double acquirePeriod)
                      throws Exception

Throws:

Exception

stopAcquiring

public void stopAcquiring()
                   throws Exception

Throws:

Exception

setImageMode

public void setImageMode(int imageMode)
                  throws Exception

Throws:

Exception

getAreaDetectorROI

public AreaDetectorROI getAreaDetectorROI()
                                   throws Exception

Throws:

Exception

getImageMode

public int getImageMode()
                 throws Exception

Throws:

Exception

getCaptureState

public int getCaptureState()
                    throws Exception

Throws:

Exception

getCurrentArray

public float[] getCurrentArray()
                        throws Exception

Throws:

Exception

setArray

public void setArray(NDArray array)

getArray

public NDArray getArray()

resetCounters

public void resetCounters()
                   throws Exception

Throws:

Exception

collectData

public void collectData()
                 throws DeviceException

Description copied from interface: Detector

Tells the detector to begin to collect a set of data, then returns immediately. Should cause the hardware to start collecting immediately: if there is any delay then detectors used in the same scan would collect over different times when beam conditions may differ.

Specified by:

collectData in interface Detector

Throws:

DeviceException

createsOwnFiles

public boolean createsOwnFiles()
                        throws DeviceException

Description copied from interface: Detector

Returns a value which indicates whether the detector creates its own files. If it does (return true) the readout() method returns the name of the latest file created as a string. If it does not (return false) the readout() method will return the data directly.

Specified by:

createsOwnFiles in interface Detector

Returns:

true if readout() returns filenames

Throws:

DeviceException

getDescription

public String getDescription()
                      throws DeviceException

Specified by:

getDescription in interface Detector

Overrides:

getDescription in class DetectorBase

Returns:

A description of the detector.

Throws:

DeviceException

getDetectorID

public String getDetectorID()
                     throws DeviceException

Specified by:

getDetectorID in interface Detector

Overrides:

getDetectorID in class DetectorBase

Returns:

A identifier for this detector.

Throws:

DeviceException

getDetectorType

public String getDetectorType()
                       throws DeviceException

Specified by:

getDetectorType in interface Detector

Overrides:

getDetectorType in class DetectorBase

Returns:

The type of detector.

Throws:

DeviceException

getStatus

public int getStatus()
              throws DeviceException

Description copied from interface: Detector

Returns the current collecting state of the device.

Specified by:

getStatus in interface Detector

Returns:

BUSY if the detector has not finished the requested operation(s), IDLE if in an completely idle state and STANDBY if temporarily suspended.

Throws:

DeviceException

readout

public NexusTreeProvider readout()
                          throws DeviceException

Description copied from interface: NexusDetector

Returns the latest data collected as well as general detector information

Specified by:

readout in interface Detector

Specified by:

readout in interface NexusDetector

Returns:

the data collected

Throws:

DeviceException

addMetadata

protected void addMetadata(NXDetectorData nxdata)

readLastImage

public org.eclipse.january.dataset.IntegerDataset readLastImage()
                                                         throws DeviceException

Throws:

DeviceException

getDataDimensions

public int[] getDataDimensions()
                        throws DeviceException

Description copied from class: DetectorBase

Default which should be overridden by subclasses.

Specified by:

getDataDimensions in interface Detector

Overrides:

getDataDimensions in class DetectorBase

Returns:

the dimensions of the data object returned by the Detector.readout() method

Throws:

DeviceException

See Also:

• Detector.getDataDimensions()

cagetArrayUnsigned

public int[] cagetArrayUnsigned()
                         throws Exception

Throws:

Exception

setAttribute

public void setAttribute(String attributeName,
 Object value)
                  throws DeviceException

Description copied from interface: Device

Set any attribute the implementing classes may provide

Specified by:

setAttribute in interface Device

Overrides:

setAttribute in class DeviceBase

Parameters:

attributeName - is the name of the attribute

value - is the value of the attribute

Throws:

DeviceException - if an attribute cannot be set

getAttribute

public Object getAttribute(String attributeName)
                    throws DeviceException

Description copied from interface: Device

Get the value of the specified attribute

Specified by:

getAttribute in interface Device

Overrides:

getAttribute in class DeviceBase

Parameters:

attributeName - is the name of the attribute

Returns:

the value of the attribute as an Object type

Throws:

DeviceException - if an attribute cannot be retrieved