The class specializes ConvToDataObjectsBase for the case when the conversion occurs from Events WS to the MD events WS. More...

Inheritance diagram for Mantid::MDAlgorithms::ConvToMDEventsWS:

Public Member Functions
size_t	initialize (const MDWSDescription &WSD, std::shared_ptr< MDEventWSWrapper > inWSWrapper, bool ignoreZeros) override
	method sets up all internal variables necessary to convert from Event Workspace to MDEvent workspace More...

void	runConversion (API::Progress *pProgress) override
	method which starts the conversion procedure More...

Public Member Functions inherited from Mantid::MDAlgorithms::ConvToMDBase
	ConvToMDBase ()
	empty default constructor More...

UnitsConversionHelper &	getUnitConversionHelper ()
	method returns unit conversion helper, used to convert input workspace units to the units, used by appropriate MD transformation (if such conversion is necessary) More...

virtual size_t	initialize (const MDWSDescription &WSD, std::shared_ptr< MDEventWSWrapper > inWSWrapper, bool ignoreZeros)
	method which initiates all main class variables More...

virtual void	runConversion (API::Progress *)=0
	method which starts the conversion procedure More...

virtual void	setDisplayNormalization (Mantid::API::IMDEventWorkspace_sptr mdWorkspace, const Mantid::API::MatrixWorkspace_sptr &underlyingWorkspace)
	Set the normalization options. More...

virtual	~ConvToMDBase ()=default
	virtual destructor More...

Protected Attributes
DataObjects::EventWorkspace_const_sptr	m_EventWS

Protected Attributes inherited from Mantid::MDAlgorithms::ConvToMDBase
std::vector< coord_t >	m_Coord

Mantid::Kernel::SpecialCoordinateSystem	m_coordinateSystem
	Any special coordinate system used. More...

std::vector< int32_t >	m_detID

std::vector< size_t >	m_detIDMap

uint16_t	m_ExpInfoIndex

bool	m_ignoreZeros

API::MatrixWorkspace_const_sptr	m_InWS2D

size_t	m_NDims
	number of target ws dimensions More...

uint32_t	m_NSpectra

int	m_NumThreads

std::shared_ptr< MDEventWSWrapper >	m_OutWSWrapper

MDTransf_sptr	m_QConverter

UnitsConversionHelper	m_UnitConversion

Private Member Functions
virtual void	appendEventsFromInputWS (API::Progress *pProgress, const API::BoxController_sptr &bc)

size_t	conversionChunk (size_t workspaceIndex) override
	The method runs conversion for a single event list, corresponding to a particular workspace index. More...

template<class T >
size_t	convertEventList (size_t workspaceIndex)
	function converts particular type of events into MD space and add these events to the workspace itself More...

Additional Inherited Members
Static Protected Attributes inherited from Mantid::MDAlgorithms::ConvToMDBase
static Mantid::Kernel::Logger	g_Log

Detailed Description

The class specializes ConvToDataObjectsBase for the case when the conversion occurs from Events WS to the MD events WS.

See http://www.mantidproject.org/Writing_custom_ConvertTo_MD_transformation for detailed description of this class place in the algorithms hierarchy.

Definition at line 38 of file ConvToMDEventsWS.h.

Member Function Documentation

void Mantid::MDAlgorithms::ConvToMDEventsWS::appendEventsFromInputWS	(	API::Progress *	pProgress,
		const API::BoxController_sptr &	bc
	)

privatevirtual

Definition at line 131 of file ConvToMDEventsWS.cpp.

size_t Mantid::MDAlgorithms::ConvToMDEventsWS::conversionChunk ( size_t workspaceIndex )

overrideprivatevirtual

The method runs conversion for a single event list, corresponding to a particular workspace index.

Definition at line 78 of file ConvToMDEventsWS.cpp.

template<class T >

size_t Mantid::MDAlgorithms::ConvToMDEventsWS::convertEventList ( size_t workspaceIndex )

private

function converts particular type of events into MD space and add these events to the workspace itself

function converts particular list of events of type T into MD workspace and adds these events to the workspace itself

Definition at line 14 of file ConvToMDEventsWS.cpp.

size_t Mantid::MDAlgorithms::ConvToMDEventsWS::initialize	(	const MDWSDescription &	WSD,
		std::shared_ptr< MDEventWSWrapper >	inWSWrapper,
		bool	ignoreZeros
	)

overridevirtual

method sets up all internal variables necessary to convert from Event Workspace to MDEvent workspace

Parameters

WSD	– the class describing the target MD workspace, sorurce Event workspace and the transformations, necessary to perform on these workspaces
inWSWrapper	– the class wrapping the target MD workspace
ignoreZeros	– if zero value signals should be rejected

Definition at line 100 of file ConvToMDEventsWS.cpp.