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

Class NcdWireDetector

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

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

uk.ac.gda.server.ncd.subdetector.NcdWireDetector

All Implemented Interfaces:

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

Direct Known Subclasses:

NcdTimesDetector

@ServiceInterface(INcdSubDetector.class)
public class NcdWireDetector
extends NcdSubDetector

A class to represent a detector for NCD.

Field Summary

Fields

Modifier and Type	Field	Description
protected Gdhist	memory
protected boolean	transposedData

Fields inherited from class uk.ac.gda.server.ncd.subdetector.NcdSubDetector

attributeMap, configuration, description, detector, detectorType, interpretation, mask, metaProviders, 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
NcdWireDetector()

Method Summary

Modifier and Type	Method	Description
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.
int[]	getDataDimensions()
String	getDetectorType()
Gdhist	getMemory()
int	getMemorySize()
double	getPixelSize()	Get the size of pixels in x (for 1d detectors) or x and y (for 2d detectors)
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.
boolean	isTransposedData()
double[]	read(int frame)
double[]	read(int x, int y, int t, int dx, int dy, int dt)
float[]	readFloat(int frame)
float[]	readFloat(int x, int y, int t, int dx, int dy, int dt)
void	reconfigure()	Re-initialisation of values and states.
void	setDataDimensions(int[] detectorSize)
void	setMemory(Gdhist memory)
void	setPixelSize(double pixelsize)
void	setTransposedData(boolean transposedData)
void	start()
void	stop()
void	writeout(int frames, NXDetectorData nxdata)	add detector data for frames to the returned data type

Methods inherited from class uk.ac.gda.server.ncd.subdetector.NcdSubDetector

addMetadata, addPostScanAction, addPreScanAction, atScanEnd, atScanStart, atScanStart, getAttribute, getDetector, getDetectorProperties, getInterpretation, getMask, getPostScanActions, getPreScanActions, getSerialNumber, getTreeName, removePostScanAction, removePreScanAction, restoreAttributeMap, setAttribute, setCollectionTime, setDetector, setDetectorType, setInterpretation, setMask, setMetaProviders, setPostScanActions, setPreScanActions, setSerialNumber, setTimer, toString

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

memory

protected Gdhist memory

transposedData

protected boolean transposedData

Constructor Details

NcdWireDetector

public NcdWireDetector()

Method Details

isTransposedData

public boolean isTransposedData()

setTransposedData

public void setTransposedData(boolean transposedData)

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 NcdSubDetector

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 NcdSubDetector

Throws:

FactoryException

writeout

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

Description copied from interface: INcdSubDetector

add detector data for frames to the returned data type

Specified by:

writeout in interface INcdSubDetector

Overrides:

writeout in class NcdSubDetector

Parameters:

frames -

nxdata -

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 NcdSubDetector

Throws:

DeviceException

getMemory

public Gdhist getMemory()

Returns:

Returns the memory.

setMemory

public void setMemory(Gdhist memory)

Parameters:

memory - The memory to set.

clear

public void clear()
           throws DeviceException

Specified by:

clear in interface INcdSubDetector

Overrides:

clear in class NcdSubDetector

Throws:

DeviceException

getMemorySize

public int getMemorySize()
                  throws DeviceException

Specified by:

getMemorySize in interface INcdSubDetector

Overrides:

getMemorySize in class NcdSubDetector

Throws:

DeviceException

start

public void start()
           throws DeviceException

Specified by:

start in interface INcdSubDetector

Overrides:

start in class NcdSubDetector

Throws:

DeviceException

stop

public void stop()
          throws DeviceException

Specified by:

stop in interface INcdSubDetector

Overrides:

stop in class NcdSubDetector

Throws:

DeviceException

getDataDimensions

public int[] getDataDimensions()
                        throws DeviceException

Specified by:

getDataDimensions in interface INcdSubDetector

Overrides:

getDataDimensions in class NcdSubDetector

Throws:

DeviceException

setDataDimensions

public void setDataDimensions(int[] detectorSize)
                       throws DeviceException

Specified by:

setDataDimensions in interface INcdSubDetector

Overrides:

setDataDimensions in class NcdSubDetector

Throws:

DeviceException

read

public double[] read(int x,
 int y,
 int t,
 int dx,
 int dy,
 int dt)
              throws DeviceException

Throws:

DeviceException

read

public double[] read(int frame)
              throws DeviceException

Throws:

DeviceException

readFloat

public float[] readFloat(int x,
 int y,
 int t,
 int dx,
 int dy,
 int dt)
                  throws DeviceException

Throws:

DeviceException

readFloat

public float[] readFloat(int frame)
                  throws DeviceException

Throws:

DeviceException

getDetectorType

public String getDetectorType()

Specified by:

getDetectorType in interface INcdSubDetector

Overrides:

getDetectorType in class NcdSubDetector

getSupportedDimensions

public List<DataDimension> getSupportedDimensions()
                                           throws DeviceException

Description copied from class: NcdSubDetector

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

Overrides:

getSupportedDimensions in class NcdSubDetector

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

Overrides:

getPixelSize in class NcdSubDetector

Returns:

pixel size in metres

Throws:

DeviceException

setPixelSize

public void setPixelSize(double pixelsize)
                  throws DeviceException

Overrides:

setPixelSize in class NcdSubDetector

Throws:

DeviceException