Package gda.px.detector

Interface IPilatusDetector

All Superinterfaces:

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

All Known Subinterfaces:

IAreaDetectorPilatus

All Known Implementing Classes:

AreaDetectorPilatusBase, DummyAreaDetectorPilatus, EpicsAreaDetectorPilatus

public interface IPilatusDetector
extends Detector

Method Summary

Modifier and Type	Method	Description
String	getActualGain()
int	getFilenumber()
String	getGain()
String	getImageMode()
String	getMode()
String	getModel()
double[]	getPixelSize()
String	getShortName()
double	getThresholdEnergy()	Returns the threshold energy (in eV).
int	getThresholdTime()
void	sendParameters(PilatusDetectorCollectionParameters params)
void	setAutoApplyThresholdGain(boolean autoApply)	Sets whether changes to threshold/gain take effect immediately.
void	setAutoIncrement(String modeName)
void	setDelayTime(double delaySec)
void	setExposurePeriod(double time)
void	setExposureTime(double time)
void	setFileformat(String format)
void	setFileHeader(String str)
void	setFilenumber(int fileNumber)
void	setFilepath(String pathname)
void	setFileprefix(String prefix)
void	setGain(String gain)
void	setGapFill(int gapFill)
void	setImageMode(String modeName)	Sets the image mode.
void	setMode(String modeName)	Sets the trigger mode.
void	setNumberOfExposures(int numExposures)
void	setNumberOfImages(int numImages)
void	setThresholdEnergy(double threshold)	Sets the threshold energy (in eV).

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.px.detector.Detector

abort, disableRoiMode, enableRoiMode, getAutoRunNumberUtils, getDetectorStatus, getDimensionInMm, getFullDimensionInMm, getFullSizeX, getFullSizeY, getId, getImageMB, getLastImageName, getMaxDimension, getMaxFullDimension, getMinExposureTime, getMinStillExposureTime, getSizeX, getSizeY, getSuffix, getTypeString, initialiseDataSet, isBusy, isInRoiMode, start, waitForReady

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

Methods inherited from interface gda.device.Stoppable

stop

Method Details

setAutoApplyThresholdGain

void setAutoApplyThresholdGain(boolean autoApply)
                        throws DeviceException

Sets whether changes to threshold/gain take effect immediately.

Throws:

DeviceException

setThresholdEnergy

void setThresholdEnergy(double threshold)
                 throws DeviceException

Sets the threshold energy (in eV).

Parameters:

threshold - threshold energy, in eV

Throws:

DeviceException

getThresholdEnergy

double getThresholdEnergy()
                   throws DeviceException

Returns the threshold energy (in eV).

Returns:

threshold energy, in eV

Throws:

DeviceException

setGain

void setGain(String gain)
      throws DeviceException

Throws:

DeviceException

getGain

String getGain()
        throws DeviceException

Throws:

DeviceException

getActualGain

String getActualGain()
              throws DeviceException

Throws:

DeviceException

getImageMode

String getImageMode()
             throws DeviceException

Returns:

the image mode

Throws:

DeviceException

setImageMode

void setImageMode(String modeName)
           throws DeviceException

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

Throws:

DeviceException

getMode

String getMode()
        throws DeviceException

Returns:

the trigger mode

Throws:

DeviceException

setMode

void setMode(String modeName)
      throws DeviceException

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

Throws:

DeviceException

sendParameters

void sendParameters(PilatusDetectorCollectionParameters params)

setFilepath

void setFilepath(String pathname)
          throws DeviceException

Throws:

DeviceException

setFileprefix

void setFileprefix(String prefix)
            throws DeviceException

Parameters:

prefix - file name

Throws:

DeviceException

setFilenumber

void setFilenumber(int fileNumber)
            throws DeviceException

Parameters:

fileNumber - next file #

Throws:

DeviceException

getFilenumber

int getFilenumber()
           throws DeviceException

Throws:

DeviceException

setAutoIncrement

void setAutoIncrement(String modeName)
               throws DeviceException

Throws:

DeviceException

setFileformat

void setFileformat(String format)
            throws DeviceException

Throws:

DeviceException

setGapFill

void setGapFill(int gapFill)
         throws DeviceException

Throws:

DeviceException

setNumberOfExposures

void setNumberOfExposures(int numExposures)
                   throws DeviceException

Throws:

DeviceException

setNumberOfImages

void setNumberOfImages(int numImages)
                throws DeviceException

Throws:

DeviceException

setDelayTime

void setDelayTime(double delaySec)
           throws DeviceException

Throws:

DeviceException

setExposureTime

void setExposureTime(double time)
              throws DeviceException

Throws:

DeviceException

setExposurePeriod

void setExposurePeriod(double time)
                throws DeviceException

Throws:

DeviceException

getThresholdTime

int getThresholdTime()
              throws DeviceException

Throws:

DeviceException

setFileHeader

void setFileHeader(String str)
            throws DeviceException

Throws:

DeviceException

getModel

String getModel()

getShortName

String getShortName()

getPixelSize

double[] getPixelSize()