Package gda.device.detector.xstrip
Interface StripDetector
- All Superinterfaces:
Configurable,Detector,Device,EdeDetector,Findable,gda.observable.IObservable,NexusDetector,Scannable
- All Known Subinterfaces:
XCHIPDetector
Interface for strip detectors on the EDE beamline.
They should return their data as a Nexus file chunk with extraNames columns which are summations of different regions across the strip.
There can be ignored channels at each end of the strip.
The detector is in charge of its own timing for the experiment. The timing information is supplied by a EdeScanParameters object.
-
Field Summary
FieldsFields inherited from interface gda.device.detector.EdeDetector
EXCLUDED_PIXELS_PROP_NAME, INITIAL_NO_OF_ROIS, ROIS_PROP_NAMEFields inherited from interface gda.device.Scannable
ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE -
Method Summary
Modifier and TypeMethodDescriptionvoidconnect()Connect to the underlying hardware.voidDisconnect to the underlying hardwarevoidSend the software trigger continue command.getBias()Integer[]Return the scan that would be run by the next call to collectData or start, or that is underway.intbooleanvoidloadParameters(EdeScanParameters newParameters) Set up the time frames as defined by the supplied object.voidReload the last scan as defined by the last call to loadParameters;voidSets the bias voltage.voidsetExcludedStrips(Integer[] excludedStrips) The numbers of the strips which should be excluded when returning the data and creating region totals.voidstart()Start the time frame sequence supplied by the last call of loadParameters().Methods inherited from interface gda.factory.Configurable
configure, isConfigureAtStartup, isConfigured, reconfigureMethods inherited from interface gda.device.Detector
collectData, createsOwnFiles, endCollection, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, getFileStructure, getStatus, prepareForCollection, setCollectionTime, waitWhileBusyMethods inherited from interface gda.device.Device
close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevelMethods inherited from interface gda.device.detector.EdeDetector
configureDetectorForROI, configureDetectorForTimingGroup, createDatasetForPixel, fetchDetectorSettings, fetchStatus, getAccumulationReadoutTime, getDetectorData, getDetectorSetupType, getEnergyCalibration, getEnergyForChannels, getExcludedPixels, getLastImageAvailable, getLowerChannel, getMaxNumFramesToRead, getMaxPixel, getNumberOfRois, getNumberOfSpectra, getNumberScansInFrame, getNumberScansInFrame, getOrbitWaitMethod, getPixels, getRoiFor, getRois, getSynchroniseBeamOrbitDelay, getSynchroniseToBeamOrbit, getTemperatures, getUpperChannel, isDropFirstFrame, isEnergyCalibrationSet, prepareDetectorwithScanParameters, readFrames, readoutFrames, setAccumulationReadoutTime, setDetectorSetupType, setEnergyCalibration, setExcludedPixels, setLowerChannel, setNumberRois, setNumberScansInFrame, setOrbitWaitMethod, setRois, setSynchroniseBeamOrbitDelay, setSynchroniseToBeamOrbit, setUpperChannel, writeLiveDataFileMethods inherited from interface gda.observable.IObservable
addIObserver, deleteIObserver, deleteIObserversMethods inherited from interface gda.device.detector.NexusDetector
readoutMethods inherited from interface gda.device.Scannable
asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString
-
Field Details
-
CALIBRATION_PROP_KEY
- See Also:
-
-
Method Details
-
loadParameters
Set up the time frames as defined by the supplied object.The time frames are started by the start method.
- Parameters:
newParameters-- Throws:
DeviceException
-
loadTemplateParameters
Reload the last scan as defined by the last call to loadParameters;- Throws:
DeviceException
-
getLoadedParameters
EdeScanParameters getLoadedParameters()Return the scan that would be run by the next call to collectData or start, or that is underway.- Returns:
- EdeScanParameters
-
start
Start the time frame sequence supplied by the last call of loadParameters().- Throws:
DeviceException
-
getNumberChannels
int getNumberChannels()- Returns:
- the size of the mca produced by the detector i.e. the number of strips
-
setBias
Sets the bias voltage. If the given value is 0.0 then the bias will be switched off. If non-zero then the bias will be switched on if necessary and then applied.- Throws:
DeviceException
-
getBias
- Returns:
- the current bias voltage or 0.0 if bias switched off
- Throws:
DeviceException- - thrown if there is a problem reading the current status
-
getMaxBias
Double getMaxBias()- Returns:
- Double - the highest acceptable bias voltage
-
getMinBias
Double getMinBias()- Returns:
- Double - the lowest acceptable bias voltage
-
setExcludedStrips
The numbers of the strips which should be excluded when returning the data and creating region totals.NB: these strips are still to be accounted for by the set/getChannelBiases methods.
- Parameters:
excludedStrips-- Throws:
DeviceException
-
getExcludedStrips
Integer[] getExcludedStrips() -
fireSoftTrig
Send the software trigger continue command.- Throws:
DeviceException
-
connect
Connect to the underlying hardware. These detectors do not connect to the hardware during their configure().- Throws:
DeviceException
-
disconnect
Disconnect to the underlying hardware- Throws:
DeviceException
-
isConnected
boolean isConnected()- Returns:
- true if a successful call to connect() has been made, and not subsequently disconnected.
-