Package uk.ac.gda.analysis.mscan

Interface MalcolmSwmrProcessor<T extends NXobject>

All Known Implementing Classes:
AbstractMalcolmSwmrProcessor, FilterTransmissionProc, MaxValProc, MeanProc, NormProc, PlotProc, RoiProc, SumProc
public interface MalcolmSwmrProcessor<T extends NXobject>
Consumes datasets provided during a scan in order to perform processing. This form of processing within GDA and the scan is intended to be for lightweight processing only.

  • Method Details

    • initialise

      void initialise(NexusScanInfo info, AbstractNexusObjectProvider<T> nexusProvider)
      Prepare processor to receive data. For example create the lazy datasets and add to the NexusObjectWrapper
      Parameters:
      info - the current scan info
      nexusProvider - Nexus provider to write datasets into

    • processFrame

      void processFrame(org.eclipse.january.dataset.Dataset data, SliceFromSeriesMetadata metaSlice)
      Perform processing for the data. E.g calculate a statistic and write to the NXdata
      Parameters:
      data - current detector frame to process
      metaSlice - metadata fror this frame

    • isEnabled

      boolean isEnabled()
      Check if processor is currently enabled

    • setEnabled

      void setEnabled(boolean enabled)
      Set enabled state of processor

    • getDataGroupName

      String getDataGroupName()
      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).
      Returns:
      the name of the data group

    • setDataGroupName

      void setDataGroupName(String dataGroupName)
      Set name of NXdata group to add this field to.
      Parameters:
      dataGroupName -
      See Also: