Mantid::MDAlgorithms::IDynamicRebinning Class Reference

Class provides commont interface for various classes performing rebinning operations;. More...

#include <IDynamicRebinning.h>

Public Member Functions
virtual uint64_t	finalize_rebinning ()=0
	Calculates signals and errors of the MD image, obtained as the result of one or more rebin_dataset operations and (in some implementations) the locations of the points in the final MDDatapoints array. More...
virtual unsigned int	getNumDataChunks () const =0
	returns the estimate for number of data chunks may be used to rebin the dataset Used by algorithms to estimate the time to complete the rebinning More...
virtual uint64_t	getNumPreselectedPixels () const =0
	function returns the number of pixels which can contribute into a cut (Number of pixels in selected cells – become valid after preselection is done and precelected cells buffer is valid More...
virtual size_t	preselect_cells ()=0
	Function identifies the indexes of the sells of the source image that can contribute into the target image returns number of selected cells and the number of pixels (datapoints, events) contained in these cells which can contribute into the cut. More...
virtual bool	rebin_data_chunk ()=0
	function takes input multidimensional data points (pixels, events) stored in the source data buffer and rebins these data (adds them) to MD image of the taget workspace; Alternative (USA)vdescription: Identifies the locations of the datapoints in the multidimensional grid of the target workspace and calculates the statistical properties of these points More...
virtual bool	rebin_data_chunk_keep_pixels ()=0
	The same as rebin_data_chunk but retains the datapoints (pixels) contributed in the image. More...
virtual	~IDynamicRebinning ()=default
	destructor More...

Static Protected Attributes
static Mantid::Kernel::Logger	bin_log
	logger -> to provide logging, for MD dataset file operations More...

Detailed Description

Class provides commont interface for various classes performing rebinning operations;.

A rebinning class is selected from availible classes which do rebinning operations on user request and the ability to do the job.

TODO: A factory should analyse the demands for the job and user requests and return the method best suitable for the operations but the common interface for the rebinning can be identified and is described here.

Author

Alex Buts, ISIS RAL

Date

16/12/2010

Definition at line 28 of file IDynamicRebinning.h.

Constructor & Destructor Documentation

~IDynamicRebinning()

virtual Mantid::MDAlgorithms::IDynamicRebinning::~IDynamicRebinning ( )

virtualdefault

destructor

Member Function Documentation

finalize_rebinning()

virtual uint64_t Mantid::MDAlgorithms::IDynamicRebinning::finalize_rebinning ( )

pure virtual

Calculates signals and errors of the MD image, obtained as the result of one or more rebin_dataset operations and (in some implementations) the locations of the points in the final MDDatapoints array.

Returns the number of points (events, pixels) contributed into the image;

getNumDataChunks()

virtual unsigned int Mantid::MDAlgorithms::IDynamicRebinning::getNumDataChunks ( ) const

pure virtual

returns the estimate for number of data chunks may be used to rebin the dataset Used by algorithms to estimate the time to complete the rebinning

getNumPreselectedPixels()

virtual uint64_t Mantid::MDAlgorithms::IDynamicRebinning::getNumPreselectedPixels ( ) const

pure virtual

function returns the number of pixels which can contribute into a cut (Number of pixels in selected cells – become valid after preselection is done and precelected cells buffer is valid

preselect_cells()

virtual size_t Mantid::MDAlgorithms::IDynamicRebinning::preselect_cells ( )

pure virtual

Function identifies the indexes of the sells of the source image that can contribute into the target image returns number of selected cells and the number of pixels (datapoints, events) contained in these cells which can contribute into the cut.

rebin_data_chunk()

virtual bool Mantid::MDAlgorithms::IDynamicRebinning::rebin_data_chunk ( )

pure virtual

function takes input multidimensional data points (pixels, events) stored in the source data buffer and rebins these data (adds them) to MD image of the taget workspace; Alternative (USA)vdescription: Identifies the locations of the datapoints in the multidimensional grid of the target workspace and calculates the statistical properties of these points

Outputs: Returns true if more data availible and need to be rebinned;

rebin_data_chunk_keep_pixels()

virtual bool Mantid::MDAlgorithms::IDynamicRebinning::rebin_data_chunk_keep_pixels ( )

pure virtual

The same as rebin_data_chunk but retains the datapoints (pixels) contributed in the image.

This allows to save the image and further rebinning on basis of new MD workspace instead of the old one;

Member Data Documentation

bin_log

Kernel::Logger Mantid::MDAlgorithms::IDynamicRebinning::bin_log

staticprotected

logger -> to provide logging, for MD dataset file operations

Definition at line 75 of file IDynamicRebinning.h.

---

The documentation for this class was generated from the following files:

• Framework/MDAlgorithms/inc/MantidMDAlgorithms/IDynamicRebinning.h
• Framework/MDAlgorithms/src/IDynamicRebinning.cpp