Package gda.device.detector.xmap
Class NexusXmapFluorescenceDetectorAdapter
java.lang.Object
gda.device.detector.xmap.NexusXmapFluorescenceDetectorAdapter
- All Implemented Interfaces:
Findable,gda.observable.IObservable,org.springframework.beans.factory.InitializingBean,FluorescenceDetector
@ServiceInterface(FluorescenceDetector.class)
public class NexusXmapFluorescenceDetectorAdapter
extends Object
implements FluorescenceDetector, org.springframework.beans.factory.InitializingBean, gda.observable.IObservable
This adapter class allows NexusXmap to be used as a FluorescenceDetector
and use the same interface as
,
and
.
Detectors using this interface can be RMI exported from server to client and used in
.
invalid reference
Xspress2Detector
invalid reference
Xspress3Detector
invalid reference
Xspress4Detector
invalid reference
FluorescenceDetectorComposite
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddIObserver(gda.observable.IObserver observer) voidvoidConfigure the detector using the given parametersvoiddeleteIObserver(gda.observable.IObserver observer) voiddouble[]intdouble[][]getMCAData(double time) Perform a 'snapshot' data collection and return the MCA data.intgetName()Get the object name.intgetXmap()booleanbooleanThis class is used for step scans and no HDF file are produced.voidsetMcaCollectionUsesTfg(boolean mcaDataUsesTfg) voidSet or change the name of the object (as defined in XML).voidsetWriteHDF5Files(boolean writeHDF5Files) Set to true to configure the detector to write an HDF5 file during a scan.
-
Field Details
-
xmap
-
-
Constructor Details
-
NexusXmapFluorescenceDetectorAdapter
-
-
Method Details
-
getMCAData
Description copied from interface:FluorescenceDetectorPerform a 'snapshot' data collection and return the MCA data. No file writing is involved.- Specified by:
getMCADatain interfaceFluorescenceDetector- Parameters:
time- The collection time in milliseconds- Returns:
- the MCA data as a double array: [detector element][MCA channel]
- Throws:
DeviceException
-
getNumberOfElements
public int getNumberOfElements()- Specified by:
getNumberOfElementsin interfaceFluorescenceDetector- Returns:
- The number of detector elements (sometimes also called channels but this risks confusion with the channels which make up the MCA)
-
getMCASize
public int getMCASize()- Specified by:
getMCASizein interfaceFluorescenceDetector- Returns:
- The number of channels in the MCA (Multi-Channel Analyser)
-
getMaxNumberOfRois
public int getMaxNumberOfRois()- Specified by:
getMaxNumberOfRoisin interfaceFluorescenceDetector- Returns:
- The maximum number of ROIs per channel
-
applyConfigurationParameters
public void applyConfigurationParameters(FluorescenceDetectorParameters parameters) throws Exception Description copied from interface:FluorescenceDetectorConfigure the detector using the given parameters- Specified by:
applyConfigurationParametersin interfaceFluorescenceDetector- Parameters:
parameters-- Throws:
Exception
-
getConfigurationParameters
- Specified by:
getConfigurationParametersin interfaceFluorescenceDetector- Returns:
- The current detector configuration
-
afterPropertiesSet
- Specified by:
afterPropertiesSetin interfaceorg.springframework.beans.factory.InitializingBean- Throws:
Exception
-
setName
Description copied from interface:FindableSet or change the name of the object (as defined in XML). -
getName
Description copied from interface:FindableGet the object name. Used by Castor to check if the object name has been set before calling theFindable.setName(String)method. -
addIObserver
public void addIObserver(gda.observable.IObserver observer) - Specified by:
addIObserverin interfacegda.observable.IObservable
-
deleteIObserver
public void deleteIObserver(gda.observable.IObserver observer) - Specified by:
deleteIObserverin interfacegda.observable.IObservable
-
deleteIObservers
public void deleteIObservers()- Specified by:
deleteIObserversin interfacegda.observable.IObservable
-
getXmap
-
isMcaCollectionUsesTfg
public boolean isMcaCollectionUsesTfg() -
setMcaCollectionUsesTfg
public void setMcaCollectionUsesTfg(boolean mcaDataUsesTfg) -
isWriteHDF5Files
public boolean isWriteHDF5Files()This class is used for step scans and no HDF file are produced.- Specified by:
isWriteHDF5Filesin interfaceFluorescenceDetector- Returns:
- true if detector creates an HDF5 file during a scan. This is normally created by Epics via the HDF plugin of the area detector.
-
setWriteHDF5Files
public void setWriteHDF5Files(boolean writeHDF5Files) Description copied from interface:FluorescenceDetectorSet to true to configure the detector to write an HDF5 file during a scan.- Specified by:
setWriteHDF5Filesin interfaceFluorescenceDetector- Parameters:
writeHDF5Files-
-
getDeadtimeCorrectionFactors
- Specified by:
getDeadtimeCorrectionFactorsin interfaceFluorescenceDetector- Returns:
- An array of 'deadtime correction' factor values (one for each element of the detector)
- Throws:
DeviceException
-