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

Interface INcdSubDetector

All Superinterfaces:

Configurable, Device, Findable, gda.observable.IObservable

All Known Subinterfaces:

IHaveExtraNames

All Known Implementing Classes:

NcdEigerDetector, NcdPilatusAD, NcdPilatusADP2, NcdPressureCell, NcdScalerDetector, NcdSubDetector, NcdTetrammDetector, NcdTimesDetector, NcdWireDetector, NcdXmapDetector, SingleScalerWithScalingAndOffset

public interface INcdSubDetector
extends Device

A class to represent a physical detector for NCD.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	descriptionLabel
static final String	SERIAL_NUMBER_LABEL

Method Summary

Modifier and Type	Method	Description
default void	atScanEnd()
default void	atScanStart()
default void	atScanStart(ScanInformation info)
void	clear()
int[]	getDataDimensions()
DetectorProperties	getDetectorProperties()
String	getDetectorType()
int	getMemorySize()
double	getPixelSize()	Get the size of pixels in x (for 1d detectors) or x and y (for 2d detectors)
String	getSerialNumber()	A unique identifier for this sub-detector
List<DataDimension>	getSupportedDimensions()
void	setDataDimensions(int[] detectorSize)
default void	setTimer(Timer timer)
void	start()
void	stop()
void	writeout(int frames, NXDetectorData dataTree)	add detector data for frames to the returned data type

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

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

Field Details

descriptionLabel

static final String descriptionLabel

See Also:

• Constant Field Values

SERIAL_NUMBER_LABEL

static final String SERIAL_NUMBER_LABEL

See Also:

• Constant Field Values

Method Details

clear

void clear()
    throws DeviceException

Throws:

DeviceException

start

void start()
    throws DeviceException

Throws:

DeviceException

stop

void stop()
   throws DeviceException

Throws:

DeviceException

getDetectorType

String getDetectorType()

getSerialNumber

String getSerialNumber()

A unique identifier for this sub-detector

Returns:

String serial number

writeout

void writeout(int frames,
 NXDetectorData dataTree)
       throws DeviceException

add detector data for frames to the returned data type

Parameters:

frames -

dataTree -

Throws:

DeviceException

getMemorySize

int getMemorySize()
           throws DeviceException

Throws:

DeviceException

getSupportedDimensions

List<DataDimension> getSupportedDimensions()
                                    throws DeviceException

Throws:

DeviceException

setDataDimensions

void setDataDimensions(int[] detectorSize)
                throws DeviceException

Throws:

DeviceException

getDataDimensions

int[] getDataDimensions()
                 throws DeviceException

Throws:

DeviceException

getPixelSize

double getPixelSize()
             throws DeviceException

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

Returns:

pixel size in metres

Throws:

DeviceException

atScanStart

default void atScanStart()
                  throws DeviceException

Throws:

DeviceException

atScanStart

default void atScanStart(ScanInformation info)
                  throws DeviceException

Throws:

DeviceException

atScanEnd

default void atScanEnd()
                throws DeviceException

Throws:

DeviceException

setTimer

default void setTimer(Timer timer)
               throws DeviceException

Throws:

DeviceException

getDetectorProperties

DetectorProperties getDetectorProperties()
                                  throws DeviceException

Throws:

DeviceException