Package uk.ac.gda.server.ncd.subdetector

Class NcdSubDetector

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

uk.ac.gda.server.ncd.subdetector.NcdSubDetector

All Implemented Interfaces:

Device, Configurable, Findable, gda.observable.IObservable, INcdSubDetector

Direct Known Subclasses:

NcdEigerDetector, NcdPilatusAD, NcdPressureCell, NcdScalerDetector, NcdTetrammDetector, NcdWireDetector, NcdXmapDetector

@ServiceInterface(INcdSubDetector.class)
public class NcdSubDetector
extends DeviceBase
implements INcdSubDetector

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Object>	attributeMap
protected org.apache.commons.configuration.FileConfiguration	configuration
protected String	description
protected Detector	detector
protected String	detectorType
protected String	interpretation
protected org.eclipse.january.dataset.DoubleDataset	mask
protected Collection<INcdMetaProvider>	metaProviders
protected double	pixelSize

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Fields inherited from interface uk.ac.gda.server.ncd.subdetector.INcdSubDetector

descriptionLabel, SERIAL_NUMBER_LABEL

Constructor Summary

Constructors

Constructor	Description
NcdSubDetector()

Method Summary

Modifier and Type	Method	Description
protected void	addMetadata(NXDetectorData nxdata)
void	addPostScanAction(NcdAction action)
void	addPreScanAction(NcdAction action)
void	atScanEnd()
void	atScanStart()
void	atScanStart(ScanInformation info)
void	clear()
void	close()	Close and unconfigure the device.
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.
Object	getAttribute(String attributeName)	Get the value of the specified attribute
int[]	getDataDimensions()
Detector	getDetector()
DetectorProperties	getDetectorProperties()
String	getDetectorType()
String	getInterpretation()
org.eclipse.january.dataset.Dataset	getMask()
int	getMemorySize()
double	getPixelSize()	Get the size of pixels in x (for 1d detectors) or x and y (for 2d detectors)
Collection<NcdAction>	getPostScanActions()
Collection<NcdAction>	getPreScanActions()
String	getSerialNumber()	A unique identifier for this sub-detector
List<DataDimension>	getSupportedDimensions()	The supported dimensions are obtained firstly from the XML Spring configuration and if not there will try a detector attribute "DataDimensions" else it will fallback to the currently selected data dimensions.
String	getTreeName()
void	reconfigure()	Re-initialisation of values and states.
void	removePostScanAction(NcdAction action)
void	removePreScanAction(NcdAction action)
protected void	restoreAttributeMap()
void	setAttribute(String attributeName, Object value)	Set any attribute the implementing classes may provide
void	setCollectionTime(double time)
void	setDataDimensions(int[] detectorSize)
void	setDetector(Detector detector)
void	setDetectorType(String detectorType)
void	setInterpretation(String interpretation)
void	setMask(org.eclipse.january.dataset.DoubleDataset mask)
void	setMetaProviders(Collection<INcdMetaProvider> meta)
void	setPixelSize(double pixelSize)
void	setPostScanActions(Collection<NcdAction> actions)
void	setPreScanActions(Collection<NcdAction> actions)
void	setSerialNumber(String serial)
void	setTimer(Timer timer)
void	start()
void	stop()
String	toString()
void	writeout(int frames, NXDetectorData dataTree)	add detector data for frames to the returned data type

Methods inherited from class gda.device.DeviceBase

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

Methods inherited from class gda.factory.ConfigurableBase

isConfigured, 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

Methods inherited from interface gda.device.Device

getProtectionLevel, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Field Details

detector

protected Detector detector

detectorType

protected String detectorType

pixelSize

protected double pixelSize

attributeMap

protected Map<String,Object> attributeMap

description

protected String description

mask

protected org.eclipse.january.dataset.DoubleDataset mask

interpretation

protected String interpretation

configuration

protected org.apache.commons.configuration.FileConfiguration configuration

metaProviders

protected Collection<INcdMetaProvider> metaProviders

Constructor Details

NcdSubDetector

public NcdSubDetector()

Method Details

restoreAttributeMap

protected void restoreAttributeMap()

getDetector

public Detector getDetector()

setDetector

public void setDetector(Detector detector)

getTreeName

public String getTreeName()

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

reconfigure

public void reconfigure()
                 throws FactoryException

Description copied from interface: Configurable

Re-initialisation of values and states.

Moved from Reconfigurable which has been deleted

Specified by:

reconfigure in interface Configurable

Overrides:

reconfigure in class ConfigurableBase

Throws:

FactoryException

clear

public void clear()
           throws DeviceException

Specified by:

clear in interface INcdSubDetector

Throws:

DeviceException

close

public void close()
           throws DeviceException

Description copied from interface: Device

Close and unconfigure the device.

Specified by:

close in interface Device

Overrides:

close in class DeviceBase

Throws:

DeviceException

getDataDimensions

public int[] getDataDimensions()
                        throws DeviceException

Specified by:

getDataDimensions in interface INcdSubDetector

Throws:

DeviceException

getDetectorType

public String getDetectorType()

Specified by:

getDetectorType in interface INcdSubDetector

getMemorySize

public int getMemorySize()
                  throws DeviceException

Specified by:

getMemorySize in interface INcdSubDetector

Throws:

DeviceException

getSupportedDimensions

public List<DataDimension> getSupportedDimensions()
                                           throws DeviceException

The supported dimensions are obtained firstly from the XML Spring configuration and if not there will try a detector attribute "DataDimensions" else it will fallback to the currently selected data dimensions.

Specified by:

getSupportedDimensions in interface INcdSubDetector

Throws:

DeviceException

setDataDimensions

public void setDataDimensions(int[] detectorSize)
                       throws DeviceException

Specified by:

setDataDimensions in interface INcdSubDetector

Throws:

DeviceException

setDetectorType

public void setDetectorType(String detectorType)

Parameters:

detectorType - the detectorType to set

start

public void start()
           throws DeviceException

Specified by:

start in interface INcdSubDetector

Throws:

DeviceException

stop

public void stop()
          throws DeviceException

Specified by:

stop in interface INcdSubDetector

Throws:

DeviceException

setCollectionTime

public void setCollectionTime(double time)
                       throws DeviceException

Throws:

DeviceException

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

writeout

public void writeout(int frames,
 NXDetectorData dataTree)
              throws DeviceException

Description copied from interface: INcdSubDetector

add detector data for frames to the returned data type

Specified by:

writeout in interface INcdSubDetector

Parameters:

frames -

dataTree -

Throws:

DeviceException

addMetadata

protected void addMetadata(NXDetectorData nxdata)
                    throws DeviceException

Throws:

DeviceException

getPixelSize

public double getPixelSize()
                    throws DeviceException

Description copied from interface: INcdSubDetector

Get the size of pixels in x (for 1d detectors) or x and y (for 2d detectors)

Specified by:

getPixelSize in interface INcdSubDetector

Returns:

pixel size in metres

Throws:

DeviceException

setPixelSize

public void setPixelSize(double pixelSize)
                  throws DeviceException

Throws:

DeviceException

getMask

public org.eclipse.january.dataset.Dataset getMask()

setMask

public void setMask(org.eclipse.january.dataset.DoubleDataset mask)

atScanStart

public void atScanStart()
                 throws DeviceException

Specified by:

atScanStart in interface INcdSubDetector

Throws:

DeviceException

setTimer

public void setTimer(Timer timer)
              throws DeviceException

Specified by:

setTimer in interface INcdSubDetector

Throws:

DeviceException

atScanStart

public void atScanStart(ScanInformation info)
                 throws DeviceException

Specified by:

atScanStart in interface INcdSubDetector

Throws:

DeviceException

atScanEnd

public void atScanEnd()
               throws DeviceException

Specified by:

atScanEnd in interface INcdSubDetector

Throws:

DeviceException

getInterpretation

public String getInterpretation()

setInterpretation

public void setInterpretation(String interpretation)

getDetectorProperties

public DetectorProperties getDetectorProperties()
                                         throws DeviceException

Specified by:

getDetectorProperties in interface INcdSubDetector

Throws:

DeviceException

setMetaProviders

public void setMetaProviders(Collection<INcdMetaProvider> meta)

getSerialNumber

public String getSerialNumber()

Description copied from interface: INcdSubDetector

A unique identifier for this sub-detector

Specified by:

getSerialNumber in interface INcdSubDetector

Returns:

String serial number

setSerialNumber

public void setSerialNumber(String serial)

toString

public String toString()

Overrides:

toString in class Object

getPreScanActions

public Collection<NcdAction> getPreScanActions()

setPreScanActions

public void setPreScanActions(Collection<NcdAction> actions)

addPreScanAction

public void addPreScanAction(NcdAction action)

removePreScanAction

public void removePreScanAction(NcdAction action)

getPostScanActions

public Collection<NcdAction> getPostScanActions()

setPostScanActions

public void setPostScanActions(Collection<NcdAction> actions)

addPostScanAction

public void addPostScanAction(NcdAction action)

removePostScanAction

public void removePostScanAction(NcdAction action)