Package gda.device.detector.nexusprocessor

Interface DatasetProcessor

All Known Implementing Classes:

DatasetFitter, DatasetPlotter, DatasetProcessorBase, DatasetStats, ExampleDatasetProcessor, ExcaliburNDArraySimulatorParameterReader, NormalisingRegionProcessor, RoiStatsProcessor

public interface DatasetProcessor

interface for processing a dataset. Process method returns ProcessorResults if extraNames or outputFormat changes that inform observers

Method Summary

Modifier and Type	Method	Description
default void	atScanEnd()
default void	atScanStart()
Collection<String>	getExtraNames()
String	getName()
Collection<String>	getOutputFormat()
boolean	isEnabled()
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	setEnable(boolean enable)
default void	stop()

Method Details

getName

String getName()

Returns:

the name of the processor

process

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

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

Collection<String> getExtraNames()

Returns:

the names of the datasets to be added

getOutputFormat

Collection<String> getOutputFormat()

Returns:

output formats for the datasets to be added

isEnabled

boolean isEnabled()

Returns:

true if this processor is enabled, false otherwise

setEnable

void setEnable(boolean enable)

atScanStart

default void atScanStart()

atScanEnd

default void atScanEnd()

stop

default void stop()