Package gda.device.detector.xstrip

Interface XCHIPDetector

All Superinterfaces:

Configurable, Detector, Device, EdeDetector, Findable, gda.observable.IObservable, NexusDetector, Scannable, StripDetector

public interface XCHIPDetector
extends StripDetector

Sub-interface for functionality specifically relating the XH and XStrip detectors.

XCHIP relates to the common electronics of those two read heads.

Field Summary

Fields inherited from interface gda.device.Detector

BUSY, FAULT, IDLE, MONITORING, PAUSED, STANDBY

Fields inherited from interface gda.device.detector.EdeDetector

EXCLUDED_PIXELS_PROP_NAME, INITIAL_NO_OF_ROIS, ROIS_PROP_NAME

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Fields inherited from interface gda.device.detector.xstrip.StripDetector

CALIBRATION_PROP_KEY

Method Summary

Modifier and Type	Method	Description
org.eclipse.january.dataset.IDataset[][]	fetchTemperatureData()	Fetches the logged temperatures since the last time startTemperatureLogging called.
int	getNumberScansInFrame(double frameTime, double scanTime, int numberOfFrames)	Given, in seconds, the frame time and the scan time, returns back the number of scans which would be fitted into the frame.
String	getTemperatureLogFile()	This will be a file of format LocalProperties.getVarDir() + getName() + "_temperatures_" + today's date + ".log";
void	startTemperatureLogging()
void	stopTemperatureLogging()

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Detector

collectData, createsOwnFiles, endCollection, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, getFileStructure, getStatus, prepareForCollection, setCollectionTime, waitWhileBusy

Methods inherited from interface gda.device.Device

close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods 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, 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, writeLiveDataFile

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.detector.NexusDetector

readout

Methods 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

Methods inherited from interface gda.device.detector.xstrip.StripDetector

connect, disconnect, fireSoftTrig, getBias, getExcludedStrips, getLoadedParameters, getMaxBias, getMinBias, getNumberChannels, isConnected, loadParameters, loadTemplateParameters, setBias, setExcludedStrips, start

Method Details

getNumberScansInFrame

int getNumberScansInFrame(double frameTime,
 double scanTime,
 int numberOfFrames)
                   throws DeviceException

Given, in seconds, the frame time and the scan time, returns back the number of scans which would be fitted into the frame.

As the rules for this are complicated and potentially variable depending on settings inside da.server, the logic is held within da.server and so this value must be fetched from da.server every time.

Specified by:

getNumberScansInFrame in interface EdeDetector

Parameters:

frameTime -

scanTime -

numberOfFrames -

Returns:

int the number of scans which would fit into the given frame

Throws:

DeviceException

fetchTemperatureData

org.eclipse.january.dataset.IDataset[][] fetchTemperatureData()
                                                       throws DeviceException

Fetches the logged temperatures since the last time startTemperatureLogging called.

time is in epoch seconds.

Returns:

an array of Datasets: time, temp for sensor1, temp for sensor 2 etc.

Throws:

DeviceException

startTemperatureLogging

void startTemperatureLogging()
                      throws DeviceException

Throws:

DeviceException

stopTemperatureLogging

void stopTemperatureLogging()
                     throws DeviceException

Throws:

DeviceException

getTemperatureLogFile

String getTemperatureLogFile()

This will be a file of format LocalProperties.getVarDir() + getName() + "_temperatures_" + today's date + ".log";

Returns:

String - full path to the current fiel being written to.