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, bool useLogTimes) override
	method sets up all internal variables necessary to convert from Event Workspace to MDEvent workspace

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

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

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)

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

virtual	~ConvToMDBase ()=default
	virtual destructor

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.

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

uint32_t	m_NSpectra

int	m_NumThreads

std::shared_ptr< MDEventWSWrapper >	m_OutWSWrapper

MDTransf_sptr	m_QConverter

UnitsConversionHelper	m_UnitConversion

bool	m_useLogTimes
	Flag to use log values corresponding to event pulse time instead of average values.

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.

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

template<class T >
bool	setGoniometersFromLogs (const T &ev)

Private Attributes
std::vector< size_t >	m_GonioIndex

Geometry::Goniometer	m_Goniometer

std::vector< std::unique_ptr< Kernel::TimeSeriesProperty< double > > >	m_Logs

Kernel::DblMatrix	m_tmpRot

Kernel::DblMatrix	m_Wtransf

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.

The detailed description of the algorithm is provided at dev-docs/source/WritingCustomConvertToMDTransformation.rst.

Definition at line 36 of file ConvToMDEventsWS.h.

Member Function Documentation

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

privatevirtual

Definition at line 155 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 81 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 15 of file ConvToMDEventsWS.cpp.

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

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, source 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
useLogTimes	– if log values at event pulse time should be used for computing Goniometer matrix or additional dimensions

Definition at line 105 of file ConvToMDEventsWS.cpp.