Package gda.device.detector.nexusprocessor.roistats

Class NormalisingRegionProcessor

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.detector.nexusprocessor.DatasetProcessorBase

gda.device.detector.nexusprocessor.roistats.NormalisingRegionProcessor

All Implemented Interfaces:

DatasetProcessor, Configurable, Findable

public class NormalisingRegionProcessor
extends DatasetProcessorBase

Processor which calculates a background subtracted signal using ROIs and normalises using values from transmission and attenuator scannables. Both of these are optional but by default background subtraction is enabled but normalisation is disabled.

Adapted from beamline provided Jython script.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FIELD_NAME_NORM

Constructor Summary

Constructors

Constructor	Description
NormalisingRegionProcessor()

Method Summary

Modifier and Type	Method	Description
protected Collection<String>	_getExtraNames()
protected Collection<String>	_getOutputFormat()
void	atScanStart()
Scannable	getAttenuatorScannable()
String	getAttenuatorScannableName()
List<Integer>	getBackgroundRoiIndices()
RoiStatsProcessor	getRoiStats()
double	getScale()
int	getSignalRoiIndex()
String	getTransmissionFieldName()
boolean	isBackgroundSubtractionEnabled()
boolean	isEnabled()
boolean	isNorm()
GDANexusDetectorData	process(String detectorName, String dataName, org.eclipse.january.dataset.Dataset dataset)	Processes the given dataset, returning a GDANexusDetectorData containing the INexusTrees nodes describing the datasets to be added to the nexus tree.
void	setAttenuatorScannable(Scannable attenuatorScannable)
void	setAttenuatorScannableName(String attenuatorScannableName)
void	setBackgroundRoiIndices(List<Integer> backgroundRoiIndices)
void	setBackgroundSubtractionEnabled(boolean backgroundSubtractionEnabled)
void	setMonitorScannable(Scannable monitorScannable)
void	setNorm(boolean norm)
void	setRoiStats(RoiStatsProcessor roiStats)
void	setScale(double scale)
void	setSignalRoiIndex(int signalRoiIndex)
void	setTransmissionFieldName(String transmissionFieldName)

Methods inherited from class gda.device.detector.nexusprocessor.DatasetProcessorBase

getExtraNames, getOutputFormat, setEnable

Methods inherited from class gda.factory.FindableConfigurableBase

getName, setName

Methods inherited from class gda.factory.ConfigurableBase

configure, isConfigureAtStartup, isConfigured, reconfigure, setConfigured

Methods inherited from class java.lang.Object

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

Methods inherited from interface gda.device.detector.nexusprocessor.DatasetProcessor

atScanEnd, getName, stop

Field Details

FIELD_NAME_NORM

public static final String FIELD_NAME_NORM

See Also:

• Constant Field Values

Constructor Details

NormalisingRegionProcessor

public NormalisingRegionProcessor()

Method Details

atScanStart

public void atScanStart()

process

public GDANexusDetectorData process(String detectorName,
 String dataName,
 org.eclipse.january.dataset.Dataset dataset)
                             throws Exception

Description copied from interface: DatasetProcessor

Processes the given dataset, returning a GDANexusDetectorData containing the INexusTrees nodes describing the datasets to be added to the nexus tree.

Parameters:

detectorName - name of detector

dataName - name of dataset to process

dataset - dataset to process

Returns:

a GDANexusDetectorData with t

Throws:

Exception

_getExtraNames

protected Collection<String> _getExtraNames()

Specified by:

_getExtraNames in class DatasetProcessorBase

_getOutputFormat

protected Collection<String> _getOutputFormat()

Specified by:

_getOutputFormat in class DatasetProcessorBase

getRoiStats

public RoiStatsProcessor getRoiStats()

setRoiStats

public void setRoiStats(RoiStatsProcessor roiStats)

getSignalRoiIndex

public int getSignalRoiIndex()

setSignalRoiIndex

public void setSignalRoiIndex(int signalRoiIndex)

getBackgroundRoiIndices

public List<Integer> getBackgroundRoiIndices()

setBackgroundRoiIndices

public void setBackgroundRoiIndices(List<Integer> backgroundRoiIndices)

isNorm

public boolean isNorm()

setNorm

public void setNorm(boolean norm)

getAttenuatorScannableName

public String getAttenuatorScannableName()

setAttenuatorScannableName

public void setAttenuatorScannableName(String attenuatorScannableName)

getAttenuatorScannable

public Scannable getAttenuatorScannable()

setAttenuatorScannable

public void setAttenuatorScannable(Scannable attenuatorScannable)

getTransmissionFieldName

public String getTransmissionFieldName()

setTransmissionFieldName

public void setTransmissionFieldName(String transmissionFieldName)

getScale

public double getScale()

setScale

public void setScale(double scale)

isBackgroundSubtractionEnabled

public boolean isBackgroundSubtractionEnabled()

setBackgroundSubtractionEnabled

public void setBackgroundSubtractionEnabled(boolean backgroundSubtractionEnabled)

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface DatasetProcessor

Overrides:

isEnabled in class DatasetProcessorBase

Returns:

true if this processor is enabled, false otherwise

setMonitorScannable

public void setMonitorScannable(Scannable monitorScannable)