Package uk.ac.gda.analysis.mscan

Class FilterTransmissionProc

java.lang.Object

uk.ac.gda.analysis.mscan.FilterTransmissionProc

All Implemented Interfaces:

MalcolmSwmrProcessor<NXdetector>

public class FilterTransmissionProc
extends Object
implements MalcolmSwmrProcessor<NXdetector>

Intended to be used to append an additional dataset to a Malcolm scan where per point data is provided by Malcolm but requires a transformation using parameters known by GDA.

Constructor Summary

Constructors

Constructor	Description
FilterTransmissionProc()

Method Summary

Modifier and Type	Method	Description
String	getDataGroupName()	The name of the NXdata group to add this field to.
Function<Integer,Double>	getTransmissionCalc()
void	initialise(NexusScanInfo info, AbstractNexusObjectProvider<NXdetector> nexusProvider)	Prepare processor to receive data.
boolean	isEnabled()	Check if processor is currently enabled
void	processFrame(org.eclipse.january.dataset.Dataset data, SliceFromSeriesMetadata metaSlice)	Perform processing for the data.
void	setDataGroupName(String dataGroupName)	Set name of NXdata group to add this field to.
void	setEnabled(boolean enabled)	Set enabled state of processor
void	setTransmissionCalc(Function<Integer,Double> transmissionCalc)

Methods inherited from class java.lang.Object

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

Constructor Details

FilterTransmissionProc

public FilterTransmissionProc()

Method Details

getTransmissionCalc

public Function<Integer,Double> getTransmissionCalc()

setTransmissionCalc

public void setTransmissionCalc(Function<Integer,Double> transmissionCalc)

initialise

public void initialise(NexusScanInfo info,
 AbstractNexusObjectProvider<NXdetector> 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<NXdetector>

Parameters:

info - the current scan info

nexusProvider - Nexus provider to write datasets into

processFrame

public void processFrame(org.eclipse.january.dataset.Dataset data,
 SliceFromSeriesMetadata metaSlice)

Description copied from interface: MalcolmSwmrProcessor

Perform processing for the data. E.g calculate a statistic and write to the NXdata

Specified by:

processFrame in interface MalcolmSwmrProcessor<NXdetector>

Parameters:

data - current detector frame to process

metaSlice - metadata fror this frame

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: MalcolmSwmrProcessor

Set enabled state of processor

Specified by:

setEnabled in interface MalcolmSwmrProcessor<NXdetector>

isEnabled

public boolean isEnabled()

Description copied from interface: MalcolmSwmrProcessor

Check if processor is currently enabled

Specified by:

isEnabled in interface MalcolmSwmrProcessor<NXdetector>

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<NXdetector>

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<NXdetector>

Parameters:

dataGroupName -

See Also:

• the name of the data group