Package gda.device.detector.nexusprocessor

Class DatasetStats

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.detector.nexusprocessor.DatasetProcessorBase

gda.device.detector.nexusprocessor.DatasetStats

All Implemented Interfaces:

DatasetProcessor, Configurable, Findable

public class DatasetStats
extends DatasetProcessorBase

Processor to take a Dataset and calculate some statistics on it The available statistics are defined in DatasetStats.Statistic. Which statistics are enabled can be configured using setEnabledStats(List).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DatasetStats.Statistic	Statistics for Dataset processing.

Constructor Summary

Constructors

Constructor	Description
DatasetStats()	On creation the names and formats for each DatasetStats.Statistic are set from defaults but can be changed using e.g.
DatasetStats(List<DatasetStats.Statistic> enabledStats)

Method Summary

Modifier and Type	Method	Description
protected Collection<String>	_getExtraNames()
protected Collection<String>	_getOutputFormat()
void	atScanStart()
Set<DatasetStats.Statistic>	getEnabledStats()
Map<String,String>	getNodeNames()
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	setEnabledStats(List<DatasetStats.Statistic> stats)	Set the DatasetStats.Statistics that should be computed.
void	setPrefixLocalNameWithDataName(boolean prefixLocalNameWithDataName)
void	setStatFormat(DatasetStats.Statistic stat, String format)
void	setStatFormats(Map<DatasetStats.Statistic,String> formats)
void	setStatName(DatasetStats.Statistic stat, String name)
void	setStatNames(Map<DatasetStats.Statistic,String> names)
void	setUseSingleDataGroup(boolean useSingleDataGroup)
String	toString()

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

getExtraNames, getOutputFormat, isEnabled, 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, wait, wait, wait

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

atScanEnd, getName, stop

Constructor Details

DatasetStats

public DatasetStats()

On creation the names and formats for each DatasetStats.Statistic are set from defaults but can be changed using e.g. setStatName(Statistic, String).

DatasetStats

public DatasetStats(List<DatasetStats.Statistic> enabledStats)

Method Details

setUseSingleDataGroup

public void setUseSingleDataGroup(boolean useSingleDataGroup)

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

atScanStart

public void atScanStart()

_getExtraNames

protected Collection<String> _getExtraNames()

Specified by:

_getExtraNames in class DatasetProcessorBase

_getOutputFormat

protected Collection<String> _getOutputFormat()

Specified by:

_getOutputFormat in class DatasetProcessorBase

toString

public String toString()

Overrides:

toString in class Object

setPrefixLocalNameWithDataName

public void setPrefixLocalNameWithDataName(boolean prefixLocalNameWithDataName)

setEnabledStats

public void setEnabledStats(List<DatasetStats.Statistic> stats)

Set the DatasetStats.Statistics that should be computed. Note that only those included in the provided list parameter will be used, the defaults will be cleared.

Parameters:

stats - list of DatasetStats.Statistic to compute for each point

getEnabledStats

public Set<DatasetStats.Statistic> getEnabledStats()

setStatName

public void setStatName(DatasetStats.Statistic stat,
 String name)

setStatFormat

public void setStatFormat(DatasetStats.Statistic stat,
 String format)

setStatNames

public void setStatNames(Map<DatasetStats.Statistic,String> names)

setStatFormats

public void setStatFormats(Map<DatasetStats.Statistic,String> formats)

getNodeNames

public Map<String,String> getNodeNames()