Package uk.ac.gda.analysis.mscan

Class AbstractMalcolmSwmrProcessor<T extends NXobject>

java.lang.Object

uk.ac.gda.analysis.mscan.AbstractMalcolmSwmrProcessor<T>

All Implemented Interfaces:

Findable, MalcolmSwmrProcessor<T>

Direct Known Subclasses:

MaxValProc, MeanProc, NormProc, PlotProc, RoiProc, SumProc

public abstract class AbstractMalcolmSwmrProcessor<T extends NXobject>
extends Object
implements MalcolmSwmrProcessor<T>, Findable

Constructor Summary

Constructors

Constructor	Description
AbstractMalcolmSwmrProcessor()

Method Summary

Modifier and Type	Method	Description
protected abstract void	configureNexusProvider(AbstractNexusObjectProvider<T> nexusObjectProvider)
protected org.eclipse.january.dataset.ILazyWriteableDataset	createField(String fieldName, Class<?> elementType)
String	getDataGroupName()	The name of the NXdata group to add this field to.
String	getName()	Get the object name.
void	initialise(NexusScanInfo scanInfo, AbstractNexusObjectProvider<T> nexusProvider)	Prepare processor to receive data.
boolean	isEnabled()	Check if processor is currently enabled
void	setDataGroupName(String dataGroupName)	Set name of NXdata group to add this field to.
void	setEnabled(boolean enabled)	Set enabled state of processor
void	setName(String name)	Set or change the name of the object (as defined in XML).
protected void	writeStatData(Object stat, org.eclipse.january.dataset.ILazyWriteableDataset statDataset, SliceFromSeriesMetadata metaSlice)

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.gda.analysis.mscan.MalcolmSwmrProcessor

processFrame

Constructor Details

AbstractMalcolmSwmrProcessor

public AbstractMalcolmSwmrProcessor()

Method Details

initialise

public void initialise(NexusScanInfo scanInfo,
 AbstractNexusObjectProvider<T> nexusProvider)

Description copied from interface: MalcolmSwmrProcessor

Prepare processor to receive data. For example create the lazy datasets and add to the NexusObjectWrapper

Specified by:

initialise in interface MalcolmSwmrProcessor<T extends NXobject>

Parameters:

scanInfo - the current scan info

nexusProvider - Nexus provider to write datasets into

configureNexusProvider

protected abstract void configureNexusProvider(AbstractNexusObjectProvider<T> nexusObjectProvider)

isEnabled

public boolean isEnabled()

Description copied from interface: MalcolmSwmrProcessor

Check if processor is currently enabled

Specified by:

isEnabled in interface MalcolmSwmrProcessor<T extends NXobject>

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: MalcolmSwmrProcessor

Set enabled state of processor

Specified by:

setEnabled in interface MalcolmSwmrProcessor<T extends NXobject>

setName

public void setName(String name)

Description copied from interface: Findable

Set or change the name of the object (as defined in XML).

Specified by:

setName in interface Findable

Parameters:

name - the object name

getName

public String getName()

Description copied from interface: Findable

Get the object name. Used by Castor to check if the object name has been set before calling the Findable.setName(String) method.

Specified by:

getName in interface Findable

Returns:

a String containing the object name.

getDataGroupName

public String getDataGroupName()

Description copied from interface: MalcolmSwmrProcessor

The name of the NXdata group to add this field to. This can be used to group stats fields together in a single NXdata group. This property only applies when using new nexus writing (i.e. NexusScanDataWriter).

Specified by:

getDataGroupName in interface MalcolmSwmrProcessor<T extends NXobject>

Returns:

the name of the data group

setDataGroupName

public void setDataGroupName(String dataGroupName)

Description copied from interface: MalcolmSwmrProcessor

Set name of NXdata group to add this field to.

Specified by:

setDataGroupName in interface MalcolmSwmrProcessor<T extends NXobject>

Parameters:

dataGroupName -

See Also:

• the name of the data group

createField

protected org.eclipse.january.dataset.ILazyWriteableDataset createField(String fieldName,
 Class<?> elementType)

writeStatData

protected void writeStatData(Object stat,
 org.eclipse.january.dataset.ILazyWriteableDataset statDataset,
 SliceFromSeriesMetadata metaSlice)