Package gda.px.detector

Class AreaDetectorPilatusBase

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.px.detector.DetectorBase

gda.px.detector.AreaDetectorPilatusBase

All Implemented Interfaces:

Device, Stoppable, Configurable, Findable, gda.observable.IObservable, Detector, IAreaDetectorPilatus, IPilatusDetector

Direct Known Subclasses:

DummyAreaDetectorPilatus, EpicsAreaDetectorPilatus

public abstract class AreaDetectorPilatusBase
extends DetectorBase
implements IAreaDetectorPilatus

Field Summary

Fields inherited from class gda.px.detector.DetectorBase

defaultSuffix

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AreaDetectorPilatusBase()

Method Summary

Modifier and Type	Method	Description
protected abstract void	_abort()
protected abstract int	_getAutoIncrement()
protected abstract int	_getGain()
protected abstract int	_getImageMode()
protected abstract int	_getMode()
protected abstract boolean	_isAcquiring()	only way to guarantee that an acquire is done is by looking at the acquire state, according to Ulrik P
protected abstract boolean	_isBusy()
protected abstract void	_setAlpha(double alpha)
protected abstract void	_setAutoIncrement(PilatusAutoIncrement selectedMode)
protected abstract void	_setBeamX(double beamX)
protected abstract void	_setBeamY(double beamY)
protected abstract void	_setCbfTemplate(String cbfTemplate)
protected abstract void	_setChi(double chi)
protected abstract void	_setChiIncrement(double chiIncrement)
protected abstract void	_setDetectorDistance(double distanceInMm)
protected abstract void	_setDetectorVOffset(double offset)
protected abstract void	_setFlux(double flux)
protected abstract void	_setGain(PilatusGain gain)
protected abstract void	_setGapFill(int gapFillMenuEntry)
protected abstract void	_setImageMode(PilatusImageMode selectedMode)
protected abstract void	_setKappa(double kappa)
protected abstract void	_setMode(PilatusTriggerMode selectedMode)
protected abstract void	_setOmega(double omega)
protected abstract void	_setOmegaIncrement(double omegaIncrement)
protected abstract void	_setOscillationAxis(String oscAxis)
protected abstract void	_setOscillationSize(double oscSize)
protected abstract void	_setPhi(double phi)
protected abstract void	_setPhiIncrement(double phiIncrement)
protected abstract void	_setPolarization(double polarization)
protected abstract void	_setStartAngle(double startAngle)
protected abstract void	_setTransmission(double transmission)
protected abstract void	_setTwoTheta(double twoTheta)
protected abstract void	_setWavelength(double wavelength)
protected abstract void	_start()
protected abstract void	_waitForArmed(int timeoutInSeconds)
void	abort()	Aborts the current action by the detector.
void	addIObserver(gda.observable.IObserver observer)
void	close()	Close and unconfigure the device.
void	deleteIObserver(gda.observable.IObserver observer)
void	deleteIObservers()
String	getActualGain()
Object	getAttribute(String attributeName)	Get the value of the specified attribute
String	getAutoIncrement()
AutoRunNumberUtils	getAutoRunNumberUtils()
DetectorStatus	getDetectorStatus()	Returns current status of detector
DetectorDimension	getDimensionInMm()
String	getGain()
double	getImageMB()	Returns the size of images produced, in MB
String	getImageMode()
String	getLastImageName()	Returns the filename of the last image created.
double	getMaxDimension()	Returns the largest dimension of the detector face in mm.
double	getMinExposureTime()
double	getMinStillExposureTime()
String	getMode()
String	getModel()
double[]	getPixelSize()
int	getProtectionLevel()
String	getShortName()
int	getSizeX()
int	getSizeY()
int	getThresholdTime()
String	getTypeString()	Return Pilatus model type
void	initialiseDataSet(DetectorCollectionParameters datasetParameters)	Informs the detector that a collection of images with incremental names will be created.
boolean	isBusy()
boolean	isSpecialMode()
void	reconfigure()	Re-initialisation of values and states.
void	sendParameters(PilatusDetectorCollectionParameters params)
void	setAttribute(String attributeName, Object value)	Set any attribute the implementing classes may provide
void	setAutoIncrement(String modeName)
void	setAutoRunNumberUtils(AutoRunNumberUtils autoRunNumberUtils)
void	setGain(String gain)
void	setGapFill(int gapFill)
void	setImageMode(String modeName)	Sets the image mode.
void	setMinExposureTime(double minExposureTime)
void	setMinStillExposureTime(double minStillExposureTime)
void	setMode(String modeName)	Sets the trigger mode.
void	setModel(String model)
void	setPilatusType(String type)
void	setProtectionLevel(int newLevel)	Sets the permission level for this object.
void	setSpecialMode(boolean specialMode)
void	start(String file, double omegaStart)	Start data collection
void	stop()	Stops the current operation.
protected void	throwRoiModeUnsupportedException()
void	waitForReady()	Returns when the detector has finished its currently operation.

Methods inherited from class gda.px.detector.DetectorBase

getCurrentParameters, getId, getSuffix, isRoiModeAllowed, setCurrentParameters, setDetectorStatus, setId, setMaxDimension, setRoiModeAllowed, setSuffix, setTypeString

Methods inherited from class gda.device.DeviceBase

getName, isBeingObserved, isConfigureAtStartup, notifyIObservers, setConfigureAtStartup, setName

Methods inherited from class gda.factory.ConfigurableBase

configure, isConfigured, setConfigured

Methods inherited from class java.lang.Object

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

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured

Methods inherited from interface gda.px.detector.Detector

disableRoiMode, enableRoiMode, getFullDimensionInMm, getFullSizeX, getFullSizeY, getId, getMaxFullDimension, getSuffix, isInRoiMode

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.px.detector.IAreaDetectorPilatus

applyThreshold, getEnergyDemand, setEnergyDemand

Methods inherited from interface gda.px.detector.IPilatusDetector

getFilenumber, getThresholdEnergy, setAutoApplyThresholdGain, setDelayTime, setExposurePeriod, setExposureTime, setFileformat, setFileHeader, setFilenumber, setFilepath, setFileprefix, setNumberOfExposures, setNumberOfImages, setThresholdEnergy

Constructor Details

AreaDetectorPilatusBase

protected AreaDetectorPilatusBase()

Method Details

setPilatusType

public void setPilatusType(String type)

Specified by:

setPilatusType in interface IAreaDetectorPilatus

getDimensionInMm

public DetectorDimension getDimensionInMm()

Specified by:

getDimensionInMm in interface Detector

getMaxDimension

public double getMaxDimension()

Description copied from interface: Detector

Returns the largest dimension of the detector face in mm.

Specified by:

getMaxDimension in interface Detector

Overrides:

getMaxDimension in class DetectorBase

Returns:

double

getImageMB

public double getImageMB()
                  throws DeviceException

Description copied from interface: Detector

Returns the size of images produced, in MB

Specified by:

getImageMB in interface Detector

Returns:

double

Throws:

DeviceException

getSizeX

public int getSizeX()

Specified by:

getSizeX in interface Detector

Returns:

horizontal size of image, in pixels

getSizeY

public int getSizeY()

Specified by:

getSizeY in interface Detector

Returns:

vertical size of image, in pixels

getThresholdTime

public int getThresholdTime()
                     throws DeviceException

Specified by:

getThresholdTime in interface IPilatusDetector

Throws:

DeviceException

getModel

public String getModel()

Specified by:

getModel in interface IPilatusDetector

setModel

public void setModel(String model)

Specified by:

setModel in interface IAreaDetectorPilatus

getShortName

public String getShortName()

Specified by:

getShortName in interface IPilatusDetector

getPixelSize

public double[] getPixelSize()

Specified by:

getPixelSize in interface IPilatusDetector

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

addIObserver

public void addIObserver(gda.observable.IObserver observer)

Specified by:

addIObserver in interface gda.observable.IObservable

Overrides:

addIObserver in class DeviceBase

deleteIObserver

public void deleteIObserver(gda.observable.IObserver observer)

Specified by:

deleteIObserver in interface gda.observable.IObservable

Overrides:

deleteIObserver in class DeviceBase

deleteIObservers

public void deleteIObservers()

Specified by:

deleteIObservers in interface gda.observable.IObservable

Overrides:

deleteIObservers in class DeviceBase

getTypeString

public String getTypeString()

Return Pilatus model type

Specified by:

getTypeString in interface Detector

Overrides:

getTypeString in class DetectorBase

Returns:

String

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

isSpecialMode

public boolean isSpecialMode()

Specified by:

isSpecialMode in interface IAreaDetectorPilatus

setSpecialMode

public void setSpecialMode(boolean specialMode)

Specified by:

setSpecialMode in interface IAreaDetectorPilatus

getGain

public String getGain()

Specified by:

getGain in interface IPilatusDetector

setGain

public void setGain(String gain)

Specified by:

setGain in interface IPilatusDetector

getActualGain

public String getActualGain()

Specified by:

getActualGain in interface IPilatusDetector

_getGain

protected abstract int _getGain()

_setGain

protected abstract void _setGain(PilatusGain gain)

getImageMode

public String getImageMode()
                    throws DeviceException

Specified by:

getImageMode in interface IPilatusDetector

Returns:

the image mode

Throws:

DeviceException

_getImageMode

protected abstract int _getImageMode()
                              throws DeviceException

Throws:

DeviceException

setImageMode

public void setImageMode(String modeName)
                  throws DeviceException

Description copied from interface: IPilatusDetector

Sets the image mode. See PilatusImageMode for the allowed labels.

Specified by:

setImageMode in interface IPilatusDetector

Throws:

DeviceException

_setImageMode

protected abstract void _setImageMode(PilatusImageMode selectedMode)
                               throws DeviceException

Throws:

DeviceException

getMode

public String getMode()
               throws DeviceException

Specified by:

getMode in interface IPilatusDetector

Returns:

the trigger mode

Throws:

DeviceException

_getMode

protected abstract int _getMode()
                         throws DeviceException

Throws:

DeviceException

setMode

public void setMode(String modeName)
             throws DeviceException

Description copied from interface: IPilatusDetector

Sets the trigger mode. See PilatusTriggerMode for the allowed labels.

Specified by:

setMode in interface IPilatusDetector

Throws:

DeviceException

_setMode

protected abstract void _setMode(PilatusTriggerMode selectedMode)
                          throws DeviceException

Throws:

DeviceException

sendParameters

public void sendParameters(PilatusDetectorCollectionParameters params)

Specified by:

sendParameters in interface IPilatusDetector

_setWavelength

protected abstract void _setWavelength(double wavelength)
                                throws IOException

Throws:

IOException

_setDetectorDistance

protected abstract void _setDetectorDistance(double distanceInMm)
                                      throws IOException

Throws:

IOException

_setDetectorVOffset

protected abstract void _setDetectorVOffset(double offset)
                                     throws IOException

Throws:

IOException

_setBeamX

protected abstract void _setBeamX(double beamX)
                           throws IOException

Throws:

IOException

_setBeamY

protected abstract void _setBeamY(double beamY)
                           throws IOException

Throws:

IOException

_setFlux

protected abstract void _setFlux(double flux)
                          throws IOException

Throws:

IOException

_setTransmission

protected abstract void _setTransmission(double transmission)
                                  throws IOException

Throws:

IOException

_setStartAngle

protected abstract void _setStartAngle(double startAngle)
                                throws IOException

Throws:

IOException

_setOscillationSize

protected abstract void _setOscillationSize(double oscSize)
                                     throws IOException

Throws:

IOException

_setOscillationAxis

protected abstract void _setOscillationAxis(String oscAxis)
                                     throws IOException

Throws:

IOException

_setPolarization

protected abstract void _setPolarization(double polarization)
                                  throws IOException

Throws:

IOException

_setAlpha

protected abstract void _setAlpha(double alpha)
                           throws IOException

Throws:

IOException

_setKappa

protected abstract void _setKappa(double kappa)
                           throws IOException

Throws:

IOException

_setPhi

protected abstract void _setPhi(double phi)
                         throws IOException

Throws:

IOException

_setPhiIncrement

protected abstract void _setPhiIncrement(double phiIncrement)
                                  throws IOException

Throws:

IOException

_setChi

protected abstract void _setChi(double chi)
                         throws IOException

Throws:

IOException

_setChiIncrement

protected abstract void _setChiIncrement(double chiIncrement)
                                  throws IOException

Throws:

IOException

_setOmega

protected abstract void _setOmega(double omega)
                           throws IOException

Throws:

IOException

_setTwoTheta

protected abstract void _setTwoTheta(double twoTheta)
                              throws IOException

Throws:

IOException

_setOmegaIncrement

protected abstract void _setOmegaIncrement(double omegaIncrement)
                                    throws IOException

Throws:

IOException

_setCbfTemplate

protected abstract void _setCbfTemplate(String cbfTemplate)
                                 throws IOException

Throws:

IOException

getAutoIncrement

public String getAutoIncrement()
                        throws DeviceException

Specified by:

getAutoIncrement in interface IAreaDetectorPilatus

Throws:

DeviceException

_getAutoIncrement

protected abstract int _getAutoIncrement()
                                  throws DeviceException

Throws:

DeviceException

setAutoIncrement

public void setAutoIncrement(String modeName)
                      throws DeviceException

Specified by:

setAutoIncrement in interface IPilatusDetector

Throws:

DeviceException

_setAutoIncrement

protected abstract void _setAutoIncrement(PilatusAutoIncrement selectedMode)
                                   throws DeviceException

Throws:

DeviceException

setGapFill

public void setGapFill(int gapFill)
                throws DeviceException

Specified by:

setGapFill in interface IPilatusDetector

Throws:

DeviceException

_setGapFill

protected abstract void _setGapFill(int gapFillMenuEntry)
                             throws DeviceException

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

setProtectionLevel

public void setProtectionLevel(int newLevel)

Description copied from interface: Device

Sets the permission level for this object. If this is not set then a default value will be applied.

Specified by:

setProtectionLevel in interface Device

Overrides:

setProtectionLevel in class DeviceBase

Parameters:

newLevel -

getProtectionLevel

public int getProtectionLevel()

Specified by:

getProtectionLevel in interface Device

Overrides:

getProtectionLevel in class DeviceBase

Returns:

int - the permission level for this object.

abort

public void abort()
           throws DeviceException

Description copied from interface: Detector

Aborts the current action by the detector. The detector should be left in a state such that data collection can continue without further resetting. This method should also work when the detector is idle.

Specified by:

abort in interface Detector

Throws:

DeviceException

_abort

protected abstract void _abort()
                        throws IOException

Throws:

IOException

start

public void start(String file,
 double omegaStart)
           throws DeviceException

Description copied from interface: Detector

Start data collection

Specified by:

start in interface Detector

Parameters:

file - - the name of the file to create

omegaStart - - the starting angle of data collection (to go into image header)

Throws:

DeviceException

_start

protected abstract void _start()
                        throws DeviceException

Throws:

DeviceException

_waitForArmed

protected abstract void _waitForArmed(int timeoutInSeconds)
                               throws DeviceException

Throws:

DeviceException

getDetectorStatus

public DetectorStatus getDetectorStatus()
                                 throws DeviceException

Description copied from interface: Detector

Returns current status of detector

Specified by:

getDetectorStatus in interface Detector

Overrides:

getDetectorStatus in class DetectorBase

Returns:

DetectorStatus

Throws:

DeviceException

getLastImageName

public String getLastImageName()
                        throws DeviceException

Description copied from interface: Detector

Returns the filename of the last image created.

Specified by:

getLastImageName in interface Detector

Returns:

String

Throws:

DeviceException

initialiseDataSet

public void initialiseDataSet(DetectorCollectionParameters datasetParameters)
                       throws DeviceException

Description copied from interface: Detector

Informs the detector that a collection of images with incremental names will be created. This is not simply called setCurrentParameters to show that this method may often do more work than simply changing an instance field.

Specified by:

initialiseDataSet in interface Detector

Parameters:

datasetParameters -

Throws:

DeviceException

stop

public void stop()
          throws DeviceException

Description copied from interface: Stoppable

Stops the current operation.

Specified by:

stop in interface Stoppable

Throws:

DeviceException

waitForReady

public void waitForReady()
                  throws DeviceException

Description copied from interface: Detector

Returns when the detector has finished its currently operation. If its idle then returns immediately.

Specified by:

waitForReady in interface Detector

Throws:

DeviceException

_isBusy

protected abstract boolean _isBusy()
                            throws IOException

Throws:

IOException

_isAcquiring

protected abstract boolean _isAcquiring()
                                 throws IOException

only way to guarantee that an acquire is done is by looking at the acquire state, according to Ulrik P

Throws:

IOException

isBusy

public boolean isBusy()
               throws DeviceException

Specified by:

isBusy in interface Detector

Throws:

DeviceException

setAutoRunNumberUtils

public void setAutoRunNumberUtils(AutoRunNumberUtils autoRunNumberUtils)

getAutoRunNumberUtils

public AutoRunNumberUtils getAutoRunNumberUtils()

Specified by:

getAutoRunNumberUtils in interface Detector

getMinExposureTime

public double getMinExposureTime()

Specified by:

getMinExposureTime in interface Detector

setMinExposureTime

public void setMinExposureTime(double minExposureTime)

getMinStillExposureTime

public double getMinStillExposureTime()

Specified by:

getMinStillExposureTime in interface Detector

setMinStillExposureTime

public void setMinStillExposureTime(double minStillExposureTime)

throwRoiModeUnsupportedException

protected void throwRoiModeUnsupportedException()