FilterEvents : Filter Events in EventWorkspace to multiple EventsWorkspace by Splitters. More...

#include <FilterEvents.h>

Inheritance diagram for Mantid::Algorithms::FilterEvents:

Public Member Functions
const std::string	category () const override
	Algorithm's category for identification overriding a virtual method.

	FilterEvents ()
	Constructor.

const std::string	name () const override
	Algorithm's name for identification overriding a virtual method.

const std::vector< std::string >	seeAlso () const override
	Function to return all of the seeAlso algorithms related to this algorithm.

const std::string	summary () const override
	Summary of algorithms purpose.

std::map< std::string, std::string >	validateInputs () override
	Method checking errors on ALL the inputs, before execution.

int	version () const override
	Algorithm's version for identification overriding a virtual method.

Public Member Functions inherited from Mantid::API::Algorithm
	Algorithm ()
	Constructor.

	Algorithm (const Algorithm &)=delete

Algorithm &	operator= (const Algorithm &)=delete

	~Algorithm () override
	Virtual destructor.

void	initialize () override
	Initialization method invoked by the framework.

bool	execute () override final
	The actions to be performed by the algorithm on a dataset.

void	addTimer (const std::string &name, const Kernel::time_point_ns &begin, const Kernel::time_point_ns &end)

void	executeAsChildAlg () override
	Execute as a Child Algorithm.

std::map< std::string, std::string >	validateInputs () override
	Perform validation of ALL the input properties of the algorithm.

ExecutionState	executionState () const override
	Gets the current execution state.

ResultState	resultState () const override
	Gets the current result State.

bool	isInitialized () const override
	Has the Algorithm already been initialized.

bool	isExecuted () const override
	Has the Algorithm already been executed successfully.

bool	isRunning () const override
	True if the algorithm is running.

bool	isReadyForGarbageCollection () const override
	True if the algorithm is ready for garbage collection.

bool	isChild () const override
	To query whether algorithm is a child.

void	setChild (const bool isChild) override
	To set whether algorithm is a child.

void	enableHistoryRecordingForChild (const bool on) override
	Change the state of the history recording flag.

bool	isRecordingHistoryForChild ()

void	setAlwaysStoreInADS (const bool doStore) override
	Do we ALWAYS store in the AnalysisDataService? This is set to true for python algorithms' child algorithms.

bool	getAlwaysStoreInADS () const override
	Returns true if we always store in the AnalysisDataService.

void	setRethrows (const bool rethrow) override
	Set whether the algorithm will rethrow exceptions.

Poco::ActiveResult< bool >	executeAsync () override
	Asynchronous execution.

void	addObserver (const Poco::AbstractObserver &observer) const override
	Add an observer for a notification.

void	removeObserver (const Poco::AbstractObserver &observer) const override
	Remove an observer.

void	cancel () override
	Raises the cancel flag.

bool	getCancel () const
	Returns the cancellation state.

Kernel::Logger &	getLogger () const
	Returns a reference to the logger.

void	setLogging (const bool value) override
	Logging can be disabled by passing a value of false.

bool	isLogging () const override
	returns the status of logging, True = enabled

void	setLoggingOffset (const int value) override
	gets the logging priority offset

int	getLoggingOffset () const override
	returns the logging priority offset

void	setAlgStartupLogging (const bool enabled) override
	disable Logging of start and end messages

bool	getAlgStartupLogging () const override
	get the state of Logging of start and end messages

void	setChildStartProgress (const double startProgress) const override
	setting the child start progress

void	setChildEndProgress (const double endProgress) const override
	setting the child end progress

std::string	toString () const override
	Serialize an object to a string.

::Json::Value	toJson () const override
	Serialize an object to a json object.

virtual std::shared_ptr< Algorithm >	createChildAlgorithm (const std::string &name, const double startProgress=-1., const double endProgress=-1., const bool enableLogging=true, const int &version=-1)
	Create a Child Algorithm.

void	setupAsChildAlgorithm (const Algorithm_sptr &algorithm, const double startProgress=-1., const double endProgress=-1., const bool enableLogging=true)
	Setup algorithm as child algorithm.

void	trackAlgorithmHistory (std::shared_ptr< AlgorithmHistory > parentHist)
	set whether we wish to track the child algorithm's history and pass it the parent object to fill.

void	findWorkspaces (WorkspaceVector &workspaces, unsigned int direction, bool checkADS=false) const
	Populate lists of the workspace properties for a given direction (InOut workspaces are included in both input/output)

virtual bool	checkGroups ()
	Check the input workspace properties for groups.

virtual bool	processGroups ()
	Process WorkspaceGroup inputs.

void	copyNonWorkspaceProperties (IAlgorithm *alg, int periodNum)
	Copy all the non-workspace properties from this to alg.

void	declareProperty (std::unique_ptr< Kernel::Property > p, const std::string &doc="") override
	Add a property to the list of managed properties.

void	declareOrReplaceProperty (std::unique_ptr< Kernel::Property > p, const std::string &doc="") override
	Add or replace property in the list of managed properties.

void	resetProperties () override
	Reset property values back to initial values (blank or default values)

void	setProperties (const std::string &propertiesJson, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false) override
	Set the ordered list of properties by one string of values, separated by semicolons.

void	setProperties (const ::Json::Value &jsonValue, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false) override
	Sets all the declared properties from a json object.

void	setPropertiesWithString (const std::string &propertiesString, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >()) override
	Sets all the declared properties from a string.

void	setPropertyValue (const std::string &name, const std::string &value) override
	Set the value of a property by string N.B.

void	setPropertyValueFromJson (const std::string &name, const Json::Value &value) override
	Set the value of a property by Json::Value object.

void	setPropertyOrdinal (const int &index, const std::string &value) override
	Set the value of a property by an index N.B.

virtual void	copyPropertiesFrom (const Algorithm &alg)
	Make m_properties point to the same PropertyManager as alg.m_properties.

bool	existsProperty (const std::string &name) const override
	Checks whether the named property is already in the list of managed property.

bool	validateProperties () const override
	Validates all the properties in the collection.

size_t	propertyCount () const override
	Count the number of properties under management.

std::string	getPropertyValue (const std::string &name) const override
	Get the value of a property as a string.

const std::vector< Kernel::Property * > &	getProperties () const override
	Get the list of managed properties.

std::vector< std::string >	getDeclaredPropertyNames () const noexcept override
	Return the list of declared property names.

TypedValue	getProperty (const std::string &name) const override
	Get the value of a property.

std::string	asString (bool withDefaultValues=false) const override
	Return the property manager serialized as a string.

::Json::Value	asJson (bool withDefaultValues=false) const override
	Return the property manager serialized as a json object.

bool	isDefault (const std::string &name) const

void	removeProperty (const std::string &name, const bool delproperty=true) override
	Removes the property from management.

std::unique_ptr< Kernel::Property >	takeProperty (const size_t index) override
	Removes the property from management and returns a pointer to it.

void	clear () override
	Clears all properties under management.

void	afterPropertySet (const std::string &) override
	Override this method to perform a custom action right after a property was set.

Kernel::Property *	getPointerToProperty (const std::string &name) const override
	Get a property by name.

Kernel::Property *	getPointerToPropertyOrdinal (const int &index) const override
	Get a property by an index.

virtual void	declareProperty (std::unique_ptr< Property > p, const std::string &doc="")=0
	Function to declare properties (i.e. store them)

template<typename T >
void	declareProperty (const std::string &name, T value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc="", const unsigned int direction=Direction::Input)
	Add a property of the template type to the list of managed properties.

template<typename T >
void	declareProperty (const std::string &name, T value, const std::string &doc, const unsigned int direction=Direction::Input)
	Add a property to the list of managed properties with no validator.

template<typename T >
void	declareProperty (const std::string &name, T value, const unsigned int direction)
	Add a property of the template type to the list of managed properties.

void	declareProperty (const std::string &name, const char *value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc=std::string(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).

void	declareProperty (const std::string &name, const char *value, const std::string &doc, IValidator_sptr validator=std::make_shared< NullValidator >(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).

void	declareProperty (const std::string &name, const char *value, const unsigned int direction)
	Add a property of string type to the list of managed properties.

const std::string	category () const override
	function to return a category of the algorithm.

const std::vector< std::string >	categories () const override
	Function to return all of the categories that contain this algorithm.

const std::string	categorySeparator () const override
	Function to return the separator token for the category string.

const std::vector< std::string >	seeAlso () const override
	Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm.A default implementation is provided.

const std::string	alias () const override
	function to return any aliases to the algorithm; A default implementation is provided

const std::string	aliasDeprecated () const override
	Expiration date (in ISO8601 format) for the algorithm aliases; default implementation for no expiration date.

const std::string	helpURL () const override
	function to return URL for algorithm documentation; A default implementation is provided.

template<typename T , typename = typename std::enable_if<std::is_convertible<T , MatrixWorkspace >::value>::type>
std::tuple< std::shared_ptr< T >, Indexing::SpectrumIndexSet >	getWorkspaceAndIndices (const std::string &name) const
	Mechanism for retriving the index property.

template<typename T1 , typename T2 , typename = typename std::enable_if<std::is_convertible<T1 , MatrixWorkspace >::value>::type, typename = typename std::enable_if<std::is_convertible<T2 , std::string >::value \|\| std::is_convertible<T2 , std::vector<int64_t> >::value>::type>
void	setWorkspaceInputProperties (const std::string &name, const std::shared_ptr< T1 > &wksp, IndexType type, const T2 &list)
	Mechanism for setting the index property with a workspace shared pointer.

template<typename T1 , typename T2 , typename = typename std::enable_if<std::is_convertible<T1 , MatrixWorkspace >::value>::type, typename = typename std::enable_if<std::is_convertible<T2 , std::string >::value \|\| std::is_convertible<T2 , std::vector<int64_t> >::value>::type>
void	setWorkspaceInputProperties (const std::string &name, const std::string &wsName, IndexType type, const T2 &list)
	Mechanism for setting the index property with a workspace shared pointer.

const std::string	workspaceMethodName () const override

const std::vector< std::string >	workspaceMethodOn () const override

const std::string	workspaceMethodInputProperty () const override

AlgorithmID	getAlgorithmID () const override
	Algorithm ID.

Algorithms As Methods
Public Member Functions inherited from Mantid::Kernel::IPropertyManager
void	declareProperty (const std::string &name, const char *value, const std::string &doc, IValidator_sptr validator=std::make_shared< NullValidator >(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).

void	declareProperty (const std::string &name, const char *value, const unsigned int direction)
	Add a property of string type to the list of managed properties.

void	declareProperty (const std::string &name, const char *value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc=std::string(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).

template<typename T >
void	declareProperty (const std::string &name, T value, const std::string &doc, const unsigned int direction=Direction::Input)
	Add a property to the list of managed properties with no validator.

template<typename T >
void	declareProperty (const std::string &name, T value, const unsigned int direction)
	Add a property of the template type to the list of managed properties.

template<typename T >
void	declareProperty (const std::string &name, T value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc="", const unsigned int direction=Direction::Input)
	Add a property of the template type to the list of managed properties.

virtual void	filterByProperty (Mantid::Kernel::LogFilter *, const std::vector< std::string > &)

std::vector< Property * >	getPropertiesInGroup (const std::string &group) const
	Get the list of managed properties in a given group.

IPropertyManager *	setProperty (const std::string &name, const char *value)
	Specialised version of setProperty template method to handle const char *.

IPropertyManager *	setProperty (const std::string &name, const std::string &value)
	Specialised version of setProperty template method to handle std::string.

template<typename T >
IPropertyManager *	setProperty (const std::string &name, const T &value)
	Templated method to set the value of a PropertyWithValue.

template<typename T >
IPropertyManager *	setProperty (const std::string &name, std::unique_ptr< T > value)
	Templated method to set the value of a PropertyWithValue from a std::unique_ptr.

void	setPropertyGroup (const std::string &name, const std::string &group)
	Set the group for a given property.

void	setPropertySettings (const std::string &name, std::unique_ptr< IPropertySettings > settings)

void	updatePropertyValues (const IPropertyManager &other)
	Update values of the existing properties.

virtual	~IPropertyManager ()=default

Private Types
enum	EVENTFILTERSKIP { EventFilterSkipNoDet , EventFilterSkipNoDetTOFCorr }

enum	TOFCorrectionType { NoneCorrect , CustomizedCorrect , DirectCorrect , ElasticCorrect , IndirectCorrect }

Private Member Functions
void	createOutputWorkspaces ()
	create output workspaces

void	examineEventWS ()
	Mark event lists of workspace indexes with no associated detector pixels as not to be split.

void	exec () override
	Execution body.

void	filterEvents (double progressamount)
	Filter events by splitters in format of Splitter.

void	groupOutputWorkspace ()
	group output workspaces

void	init () override
	Declare Inputs.

void	parseInputSplitters ()
	process splitters specified by an input workspace

Kernel::TimeROI	partialROI (const int &index)
	Find the TimeROI associated to a particular destination-workspace index.

void	processAlgorithmProperties ()
	Process user input properties.

void	setupCustomizedTOFCorrection ()
	Set up detector calibration parameters from customized values.

void	setupDetectorTOFCalibration ()
	Set up detector calibration parameters.

API::TimeAtSampleStrategy *	setupDirectTOFCorrection () const
	Set up detector calibration parmaeters for direct inelastic scattering instrument.

API::TimeAtSampleStrategy *	setupElasticTOFCorrection () const
	Set up detector calibration parameters for elastic scattering instrument.

API::TimeAtSampleStrategy *	setupIndirectTOFCorrection () const
	Set up detector calibration parameters for indirect inelastic scattering instrument.

Private Attributes
DataObjects::TableWorkspace_sptr	m_detCorrectWorkspace

std::vector< double >	m_detTofFactors

std::vector< double >	m_detTofOffsets

DataObjects::EventWorkspace_sptr	m_eventWS

bool	m_filterByPulseTime

Types::Core::DateAndTime	m_filterStartTime

bool	m_hasInfoWS

DataObjects::TableWorkspace_sptr	m_informationWS

bool	m_isSplittersRelativeTime

API::MatrixWorkspace_sptr	m_matrixSplitterWS

std::map< int, DataObjects::EventWorkspace_sptr >	m_outputWorkspacesMap

std::string	m_outputWSNameBase
	Base of output workspace's name.

double	m_progress

EVENTFILTERSKIP	m_specSkipType
	Spectrum skip type.

DataObjects::SplittersWorkspace_sptr	m_splittersWorkspace

DataObjects::TableWorkspace_sptr	m_splitterTableWorkspace

std::set< int >	m_targetWorkspaceIndexSet

DataObjects::TimeSplitter	m_timeSplitter

TOFCorrectionType	m_tofCorrType
	TOF detector/sample correction type.

bool	m_toGroupWS
	Flag to group workspace.

std::vector< bool >	m_vecSkip
	Vector for skip information.

std::vector< int >	m_vecSplitterGroup
	Vector for splitting group.

std::vector< int64_t >	m_vecSplitterTime
	Vector for splitting time FIXME - shall we convert this to DateAndTime???.

std::vector< std::string >	m_wsNames

Additional Inherited Members
Public Types inherited from Mantid::API::Algorithm
using	WorkspaceVector = std::vector< std::shared_ptr< Workspace > >

Static Public Member Functions inherited from Mantid::API::Algorithm
static IAlgorithm_sptr	fromString (const std::string &input)
	De-serialize an object from a string.

static IAlgorithm_sptr	fromJson (const Json::Value &input)
	De-serialize an object from a Json.

static IAlgorithm_sptr	fromHistory (const AlgorithmHistory &history)
	Construct an object from a history entry.

Public Attributes inherited from Mantid::API::Algorithm
bool	calledByAlias = false
	Flag to indicate if the algorithm is called by its alias.

Protected Member Functions inherited from Mantid::API::Algorithm
virtual const std::string	workspaceMethodOnTypes () const
	Returns a semi-colon separated list of workspace types to attach this algorithm.

void	cacheWorkspaceProperties ()
	Go through the properties and cache the input/output workspace properties for later use.

void	cacheInputWorkspaceHistories ()
	Cache the histories of any input workspaces so they can be copied over after algorithm completion.

void	setExecutionState (const ExecutionState state)
	Sets the current execution state.

void	setResultState (const ResultState state)
	Sets the result execution state.

void	store ()
	Stores any output workspaces into the AnalysisDataService.

void	progress (double p, const std::string &msg="", double estimatedTime=0.0, int progressPrecision=0)
	Sends ProgressNotification.

void	interruption_point ()
	This is called during long-running operations, and check if the algorithm has requested that it be cancelled.

Poco::NotificationCenter &	notificationCenter () const
	Return a reference to the algorithm's notification dispatcher.

void	handleChildProgressNotification (const Poco::AutoPtr< ProgressNotification > &pNf)
	Observation slot for child algorithm progress notification messages, these are scaled and then signalled for this algorithm.

const Poco::AbstractObserver &	progressObserver () const
	Return a reference to the algorithm's object that is reporting progress.

bool	isWorkspaceProperty (const Kernel::Property *const prop) const
	checks the property is a workspace property

bool	trackingHistory ()
	get whether we are tracking the history for this algorithm,

virtual void	fillHistory ()
	Copy workspace history from input workspaces to output workspaces and record the history for ths algorithm.

void	fillHistory (const std::vector< Workspace_sptr > &outputWorkspaces)
	Copy workspace history from input workspaces to provided vector of output workspaces.

virtual void	setOtherProperties (IAlgorithm *alg, const std::string &propertyName, const std::string &propertyValue, int periodNum)
	Virtual method to set the non workspace properties for this algorithm.

template<typename T , const int AllowedIndexTypes = static_cast<int>(IndexType::WorkspaceIndex), typename... WSPropArgs, typename = typename std::enable_if<std::is_convertible<T , MatrixWorkspace >::value>::type>
void	declareWorkspaceInputProperties (const std::string &propertyName, const std::string &doc, WSPropArgs &&...wsPropArgs)
	Declare a property which defines the workspace and allowed index types, as well as a property for capturing the indices all at once.

Protected Member Functions inherited from Mantid::Kernel::IPropertyManager
template<typename T >
T	getValue (const std::string &name) const
	Templated method to get the value of a property.

template<>
MANTID_KERNEL_DLL PropertyManager_sptr	getValue (const std::string &name) const

template<>
MANTID_KERNEL_DLL PropertyManager_const_sptr	getValue (const std::string &name) const

Static Protected Member Functions inherited from Mantid::API::Algorithm
template<typename NumT >
static bool	isEmpty (const NumT toCheck)
	checks that the value was not set by users, uses the value in empty double/int.

Protected Attributes inherited from Mantid::API::Algorithm
std::atomic< bool >	m_cancel
	Set to true to stop execution.

std::atomic< bool >	m_parallelException
	Set if an exception is thrown, and not caught, within a parallel region.

std::vector< IWorkspaceProperty * >	m_inputWorkspaceProps
	All the WorkspaceProperties that are Input or InOut. Set in execute()

std::shared_ptr< AlgorithmHistory >	m_history
	Pointer to the history for the algorithm being executed.

Kernel::Logger	m_log
	Logger for this algorithm.

Kernel::Logger &	g_log

std::shared_ptr< AlgorithmHistory >	m_parentHistory
	Pointer to the parent history object (if set)

std::vector< WorkspaceVector >	m_unrolledInputWorkspaces
	One vector of workspaces for each input workspace property.

size_t	m_groupSize
	Size of the group(s) being processed.

bool	m_usingBaseProcessGroups = false
	distinguish between base processGroups() and overriden/algorithm specific versions

Static Protected Attributes inherited from Mantid::API::Algorithm
static size_t	g_execCount = 0
	Counter to keep track of algorithm execution order.

Detailed Description

FilterEvents : Filter Events in EventWorkspace to multiple EventsWorkspace by Splitters.

Date: 2012-04-04

Definition at line 37 of file FilterEvents.h.

Member Enumeration Documentation

◆ EVENTFILTERSKIP

enum Mantid::Algorithms::FilterEvents::EVENTFILTERSKIP

private

Enumerator
EventFilterSkipNoDet
EventFilterSkipNoDetTOFCorr

Definition at line 40 of file FilterEvents.h.

◆ TOFCorrectionType

enum Mantid::Algorithms::FilterEvents::TOFCorrectionType

private

Enumerator
NoneCorrect
CustomizedCorrect
DirectCorrect
ElasticCorrect
IndirectCorrect

Definition at line 39 of file FilterEvents.h.

Constructor & Destructor Documentation

◆ FilterEvents()

Mantid::Algorithms::FilterEvents::FilterEvents ( )

Constructor.

Definition at line 55 of file FilterEvents.cpp.

Member Function Documentation

◆ category()

const std::string Mantid::Algorithms::FilterEvents::category ( ) const

inlineoverridevirtual

Algorithm's category for identification overriding a virtual method.

Implements Mantid::API::IAlgorithm.

Definition at line 60 of file FilterEvents.h.

◆ createOutputWorkspaces()

void Mantid::Algorithms::FilterEvents::createOutputWorkspaces ( )

private

create output workspaces

Create a list of EventWorkspace objects to be used as event filtering output.

Sets the TimeROI for each destination workspace

Definition at line 588 of file FilterEvents.cpp.

References Mantid::API::Algorithm::addTimer(), Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::declareProperty(), Mantid::API::Algorithm::existsProperty(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), Mantid::DataObjects::TimeSplitter::getTimeROI(), Mantid::DataObjects::TimeSplitter::getWorkspaceIndexName(), Mantid::Kernel::Logger::information(), Mantid::API::TableRow::Int(), m_eventWS, m_filterStartTime, m_hasInfoWS, m_informationWS, m_outputWorkspacesMap, m_outputWSNameBase, m_progress, m_targetWorkspaceIndexSet, m_timeSplitter, m_toGroupWS, m_wsNames, Mantid::DataObjects::TimeSplitter::NO_TARGET, Mantid::Kernel::Direction::Output, partialROI(), Mantid::API::Algorithm::progress(), Mantid::Kernel::Strings::removeSpace(), Mantid::Kernel::IPropertyManager::setProperty(), Mantid::API::TableRow::String(), Mantid::Kernel::TimeROI::toTimeIntervals(), Mantid::Kernel::TimeROI::update_or_replace_intersection(), and Mantid::Kernel::Logger::warning().

Referenced by exec().

◆ examineEventWS()

void Mantid::Algorithms::FilterEvents::examineEventWS ( )

private

Mark event lists of workspace indexes with no associated detector pixels as not to be split.

Definition at line 332 of file FilterEvents.cpp.

References EventFilterSkipNoDetTOFCorr, Mantid::API::Algorithm::g_log, Mantid::DataObjects::EventList::getNumberEvents(), m_eventWS, m_specSkipType, m_tofCorrType, m_vecSkip, NoneCorrect, Mantid::Kernel::Logger::notice(), and Mantid::Kernel::Logger::warning().

Referenced by exec().

◆ exec()

void Mantid::Algorithms::FilterEvents::exec ( )

overrideprivatevirtual

◆ filterEvents()

void Mantid::Algorithms::FilterEvents::filterEvents ( double progressamount )

private

Filter events by splitters in format of Splitter.

Definition at line 988 of file FilterEvents.cpp.

References Mantid::API::Algorithm::addTimer(), Mantid::Kernel::Logger::debug(), Mantid::DataObjects::EventList::empty(), Mantid::API::Algorithm::g_log, index, m_detTofFactors, m_detTofOffsets, m_eventWS, m_filterByPulseTime, m_outputWorkspacesMap, m_timeSplitter, m_tofCorrType, m_vecSkip, NoneCorrect, PARALLEL_CHECK_INTERRUPT_REGION, PARALLEL_END_INTERRUPT_REGION, PARALLEL_FOR_NO_WSP_CHECK, PARALLEL_START_INTERRUPT_REGION, Mantid::API::Algorithm::progress(), and Mantid::DataObjects::TimeSplitter::splitEventList().

Referenced by exec().

◆ groupOutputWorkspace()

void Mantid::Algorithms::FilterEvents::groupOutputWorkspace ( )

private

group output workspaces

Definition at line 494 of file FilterEvents.cpp.

References Mantid::API::Algorithm::createChildAlgorithm(), Mantid::API::Algorithm::declareProperty(), Mantid::Kernel::Logger::error(), Mantid::API::Algorithm::existsProperty(), Mantid::API::Algorithm::g_log, m_outputWSNameBase, m_progress, m_toGroupWS, m_wsNames, Mantid::Kernel::Direction::Output, Mantid::API::Algorithm::progress(), Mantid::Kernel::DataService< T >::retrieve(), and Mantid::Kernel::IPropertyManager::setProperty().

Referenced by exec().

◆ init()

void Mantid::Algorithms::FilterEvents::init ( )

overrideprivatevirtual

Declare Inputs.

Implements Mantid::API::Algorithm.

Definition at line 64 of file FilterEvents.cpp.

References Mantid::API::Algorithm::declareProperty(), Mantid::EMPTY_DBL(), Mantid::EMPTY_INT(), Mantid::Kernel::Direction::Input, Mantid::Kernel::IS_EQUAL_TO, Mantid::API::PropertyMode::Optional, Mantid::Kernel::Direction::Output, Mantid::Kernel::IPropertyManager::setPropertyGroup(), and Mantid::Kernel::IPropertyManager::setPropertySettings().

◆ name()

const std::string Mantid::Algorithms::FilterEvents::name ( ) const

inlineoverridevirtual

Algorithm's name for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Definition at line 46 of file FilterEvents.h.

◆ parseInputSplitters()

void Mantid::Algorithms::FilterEvents::parseInputSplitters ( )

private

process splitters specified by an input workspace

Convert splitters specified by the input workspace to TimeSplitter Cache a set of all target workspace indexes.

FilterEvents::parseInputSplitters

Definition at line 567 of file FilterEvents.cpp.

References m_filterStartTime, m_isSplittersRelativeTime, m_matrixSplitterWS, m_splittersWorkspace, m_splitterTableWorkspace, m_targetWorkspaceIndexSet, m_timeSplitter, Mantid::DataObjects::TimeSplitter::NO_TARGET, and Mantid::DataObjects::TimeSplitter::outputWorkspaceIndices().

Referenced by exec().

◆ partialROI()

TimeROI Mantid::Algorithms::FilterEvents::partialROI ( const int & index )

private

Find the TimeROI associated to a particular destination-workspace index.

Find the TimeROI associated to the current destination-workspace index.

Caveat: when the destination workspace is the unfiltered workspace, we have the unfortunate coincidence that its index, TimeSplitter::NO_TARGET, is the same as the value denoting the end of a splitting. Illuminating example: TimeSplitter(0.0, 1.0, 1) results in TimeSplitter::m_roi_map = {(0.0, 1), (1.0, NO_TARGET)}, but TimeSplitter(0.0, 1.0, NO_TARGET) is ill-defined, as {(0.0, NO_TARGET), (1.0, NO_TARGET)} is meaningless.

Definition at line 540 of file FilterEvents.cpp.

References Mantid::DataObjects::TimeSplitter::getSplittersMap(), Mantid::DataObjects::TimeSplitter::getTimeROI(), index, m_eventWS, m_filterStartTime, m_timeSplitter, and Mantid::DataObjects::TimeSplitter::NO_TARGET.

Referenced by createOutputWorkspaces().

◆ processAlgorithmProperties()

void Mantid::Algorithms::FilterEvents::processAlgorithmProperties ( )

private

Process user input properties.

Process input properties.

Definition at line 379 of file FilterEvents.cpp.

References CustomizedCorrect, DirectCorrect, ElasticCorrect, Mantid::Kernel::Logger::error(), EventFilterSkipNoDet, EventFilterSkipNoDetTOFCorr, Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::getPropertyValue(), IndirectCorrect, Mantid::API::Algorithm::isDefault(), m_eventWS, m_filterByPulseTime, m_filterStartTime, m_hasInfoWS, m_informationWS, m_isSplittersRelativeTime, m_matrixSplitterWS, m_outputWSNameBase, m_specSkipType, m_splittersWorkspace, m_splitterTableWorkspace, m_tofCorrType, m_toGroupWS, NoneCorrect, and Mantid::Kernel::Logger::warning().

Referenced by exec().

◆ seeAlso()

const std::vector< std::string > Mantid::Algorithms::FilterEvents::seeAlso ( ) const

inlineoverridevirtual

Function to return all of the seeAlso algorithms related to this algorithm.

Implements Mantid::API::IAlgorithm.

Definition at line 55 of file FilterEvents.h.

◆ setupCustomizedTOFCorrection()

void Mantid::Algorithms::FilterEvents::setupCustomizedTOFCorrection ( )

private

Set up detector calibration parameters from customized values.

Set up corrections with customized TOF correction input The first column must be either DetectorID or Spectrum (from 0... as workspace index) The second column must be Correction or CorrectFactor, a number between 0 and 1, i.e, [0, 1] The third column is optional as shift in unit of second.

Definition at line 854 of file FilterEvents.cpp.

References Mantid::API::Algorithm::g_log, Mantid::API::ISpectrum::getDetectorIDs(), Mantid::API::Algorithm::getProperty(), m_detCorrectWorkspace, m_detTofFactors, m_detTofOffsets, m_eventWS, and Mantid::Kernel::Logger::warning().

Referenced by setupDetectorTOFCalibration().

◆ setupDetectorTOFCalibration()

void Mantid::Algorithms::FilterEvents::setupDetectorTOFCalibration ( )

private

Set up detector calibration parameters.

Set up neutron event's TOF correction.

It can be (1) parsed from TOF-correction table workspace to vectors, (2) created according to detector's position in instrument; (3) or no correction,i.e., correction value is equal to 1. Offset should be as F*TOF + B

Definition at line 780 of file FilterEvents.cpp.

References CustomizedCorrect, DirectCorrect, ElasticCorrect, Mantid::API::Correction::factor, IndirectCorrect, m_detTofFactors, m_detTofOffsets, m_eventWS, m_tofCorrType, m_vecSkip, Mantid::API::Correction::offset, Mantid::Kernel::IPropertyManager::setProperty(), setupCustomizedTOFCorrection(), setupDirectTOFCorrection(), setupElasticTOFCorrection(), and setupIndirectTOFCorrection().

Referenced by exec().

◆ setupDirectTOFCorrection()

API::TimeAtSampleStrategy * Mantid::Algorithms::FilterEvents::setupDirectTOFCorrection ( ) const

private

Set up detector calibration parmaeters for direct inelastic scattering instrument.

Definition at line 825 of file FilterEvents.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::isEmpty(), and m_eventWS.

Referenced by setupDetectorTOFCalibration().

◆ setupElasticTOFCorrection()

API::TimeAtSampleStrategy * Mantid::Algorithms::FilterEvents::setupElasticTOFCorrection ( ) const

private

Set up detector calibration parameters for elastic scattering instrument.

Definition at line 820 of file FilterEvents.cpp.

References m_eventWS.

Referenced by setupDetectorTOFCalibration().

◆ setupIndirectTOFCorrection()

API::TimeAtSampleStrategy * Mantid::Algorithms::FilterEvents::setupIndirectTOFCorrection ( ) const

private

Set up detector calibration parameters for indirect inelastic scattering instrument.

Definition at line 843 of file FilterEvents.cpp.

References m_eventWS.

Referenced by setupDetectorTOFCalibration().

◆ summary()

const std::string Mantid::Algorithms::FilterEvents::summary ( ) const

inlineoverridevirtual

Summary of algorithms purpose.

Implements Mantid::API::Algorithm.

Definition at line 48 of file FilterEvents.h.

◆ validateInputs()

std::map< std::string, std::string > Mantid::Algorithms::FilterEvents::validateInputs ( )

overridevirtual

Method checking errors on ALL the inputs, before execution.

For use mostly in dialogs.

Implements Mantid::API::IAlgorithm.

Definition at line 198 of file FilterEvents.cpp.

References Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::getPropertyValue(), and Mantid::API::Algorithm::isEmpty().

◆ version()

int Mantid::Algorithms::FilterEvents::version ( ) const

inlineoverridevirtual

Algorithm's version for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Definition at line 54 of file FilterEvents.h.

Member Data Documentation

◆ m_detCorrectWorkspace

DataObjects::TableWorkspace_sptr Mantid::Algorithms::FilterEvents::m_detCorrectWorkspace

private

Definition at line 110 of file FilterEvents.h.

Referenced by setupCustomizedTOFCorrection().

◆ m_detTofFactors

std::vector<double> Mantid::Algorithms::FilterEvents::m_detTofFactors

private

Definition at line 119 of file FilterEvents.h.

Referenced by filterEvents(), setupCustomizedTOFCorrection(), and setupDetectorTOFCalibration().

◆ m_detTofOffsets

std::vector<double> Mantid::Algorithms::FilterEvents::m_detTofOffsets

private

Definition at line 118 of file FilterEvents.h.

Referenced by filterEvents(), setupCustomizedTOFCorrection(), and setupDetectorTOFCalibration().

◆ m_eventWS

DataObjects::EventWorkspace_sptr Mantid::Algorithms::FilterEvents::m_eventWS

private

Definition at line 106 of file FilterEvents.h.

Referenced by createOutputWorkspaces(), examineEventWS(), exec(), filterEvents(), partialROI(), processAlgorithmProperties(), setupCustomizedTOFCorrection(), setupDetectorTOFCalibration(), setupDirectTOFCorrection(), setupElasticTOFCorrection(), and setupIndirectTOFCorrection().

◆ m_filterByPulseTime

bool Mantid::Algorithms::FilterEvents::m_filterByPulseTime

private

Definition at line 121 of file FilterEvents.h.

Referenced by exec(), filterEvents(), and processAlgorithmProperties().

◆ m_filterStartTime

Types::Core::DateAndTime Mantid::Algorithms::FilterEvents::m_filterStartTime

private

Definition at line 151 of file FilterEvents.h.

Referenced by createOutputWorkspaces(), parseInputSplitters(), partialROI(), and processAlgorithmProperties().

◆ m_hasInfoWS

bool Mantid::Algorithms::FilterEvents::m_hasInfoWS

private

Definition at line 124 of file FilterEvents.h.

Referenced by createOutputWorkspaces(), and processAlgorithmProperties().

◆ m_informationWS

DataObjects::TableWorkspace_sptr Mantid::Algorithms::FilterEvents::m_informationWS

private

Definition at line 123 of file FilterEvents.h.

Referenced by createOutputWorkspaces(), and processAlgorithmProperties().

◆ m_isSplittersRelativeTime

bool Mantid::Algorithms::FilterEvents::m_isSplittersRelativeTime

private

Definition at line 149 of file FilterEvents.h.

Referenced by parseInputSplitters(), and processAlgorithmProperties().

◆ m_matrixSplitterWS

API::MatrixWorkspace_sptr Mantid::Algorithms::FilterEvents::m_matrixSplitterWS

private

Definition at line 109 of file FilterEvents.h.

Referenced by parseInputSplitters(), and processAlgorithmProperties().

◆ m_outputWorkspacesMap

std::map<int, DataObjects::EventWorkspace_sptr> Mantid::Algorithms::FilterEvents::m_outputWorkspacesMap

private

Definition at line 115 of file FilterEvents.h.

Referenced by createOutputWorkspaces(), exec(), and filterEvents().

◆ m_outputWSNameBase

std::string Mantid::Algorithms::FilterEvents::m_outputWSNameBase

private

Base of output workspace's name.

Definition at line 129 of file FilterEvents.h.

Referenced by createOutputWorkspaces(), groupOutputWorkspace(), and processAlgorithmProperties().

◆ m_progress

double Mantid::Algorithms::FilterEvents::m_progress

private

Definition at line 126 of file FilterEvents.h.

Referenced by createOutputWorkspaces(), exec(), and groupOutputWorkspace().

◆ m_specSkipType

EVENTFILTERSKIP Mantid::Algorithms::FilterEvents::m_specSkipType

private

Spectrum skip type.

Definition at line 144 of file FilterEvents.h.

Referenced by examineEventWS(), and processAlgorithmProperties().

◆ m_splittersWorkspace

DataObjects::SplittersWorkspace_sptr Mantid::Algorithms::FilterEvents::m_splittersWorkspace

private

Definition at line 107 of file FilterEvents.h.

Referenced by parseInputSplitters(), and processAlgorithmProperties().

◆ m_splitterTableWorkspace

DataObjects::TableWorkspace_sptr Mantid::Algorithms::FilterEvents::m_splitterTableWorkspace

private

Definition at line 108 of file FilterEvents.h.

Referenced by parseInputSplitters(), and processAlgorithmProperties().

◆ m_targetWorkspaceIndexSet

std::set<int> Mantid::Algorithms::FilterEvents::m_targetWorkspaceIndexSet

private

Definition at line 113 of file FilterEvents.h.

Referenced by createOutputWorkspaces(), and parseInputSplitters().

◆ m_timeSplitter

DataObjects::TimeSplitter Mantid::Algorithms::FilterEvents::m_timeSplitter

private

Definition at line 112 of file FilterEvents.h.

Referenced by createOutputWorkspaces(), filterEvents(), parseInputSplitters(), and partialROI().

◆ m_tofCorrType

TOFCorrectionType Mantid::Algorithms::FilterEvents::m_tofCorrType

private

TOF detector/sample correction type.

Definition at line 141 of file FilterEvents.h.

Referenced by examineEventWS(), filterEvents(), processAlgorithmProperties(), and setupDetectorTOFCalibration().

◆ m_toGroupWS

bool Mantid::Algorithms::FilterEvents::m_toGroupWS

private

Flag to group workspace.

Definition at line 132 of file FilterEvents.h.

Referenced by createOutputWorkspaces(), exec(), groupOutputWorkspace(), and processAlgorithmProperties().

◆ m_vecSkip

std::vector<bool> Mantid::Algorithms::FilterEvents::m_vecSkip

private

Vector for skip information.

Definition at line 146 of file FilterEvents.h.

Referenced by examineEventWS(), filterEvents(), and setupDetectorTOFCalibration().

◆ m_vecSplitterGroup

std::vector<int> Mantid::Algorithms::FilterEvents::m_vecSplitterGroup

private

Vector for splitting group.

Definition at line 138 of file FilterEvents.h.

◆ m_vecSplitterTime

std::vector<int64_t> Mantid::Algorithms::FilterEvents::m_vecSplitterTime

private

Vector for splitting time FIXME - shall we convert this to DateAndTime???.

Need to do speed test!

Definition at line 136 of file FilterEvents.h.

◆ m_wsNames

std::vector<std::string> Mantid::Algorithms::FilterEvents::m_wsNames

private

Definition at line 116 of file FilterEvents.h.

Referenced by createOutputWorkspaces(), and groupOutputWorkspace().

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

Framework/Algorithms/inc/MantidAlgorithms/FilterEvents.h
Framework/Algorithms/src/FilterEvents.cpp

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ EVENTFILTERSKIP

◆ TOFCorrectionType

Constructor & Destructor Documentation

◆ FilterEvents()

Member Function Documentation

◆ category()

◆ createOutputWorkspaces()

◆ examineEventWS()

◆ exec()

◆ filterEvents()

◆ groupOutputWorkspace()

◆ init()

◆ name()

◆ parseInputSplitters()

◆ partialROI()

◆ processAlgorithmProperties()

◆ seeAlso()

◆ setupCustomizedTOFCorrection()

◆ setupDetectorTOFCalibration()

◆ setupDirectTOFCorrection()

◆ setupElasticTOFCorrection()

◆ setupIndirectTOFCorrection()

◆ summary()

◆ validateInputs()

◆ version()

Member Data Documentation

◆ m_detCorrectWorkspace

◆ m_detTofFactors

◆ m_detTofOffsets

◆ m_eventWS

◆ m_filterByPulseTime

◆ m_filterStartTime

◆ m_hasInfoWS

◆ m_informationWS

◆ m_isSplittersRelativeTime

◆ m_matrixSplitterWS

◆ m_outputWorkspacesMap

◆ m_outputWSNameBase

◆ m_progress

◆ m_specSkipType

◆ m_splittersWorkspace

◆ m_splitterTableWorkspace

◆ m_targetWorkspaceIndexSet

◆ m_timeSplitter

◆ m_tofCorrType

◆ m_toGroupWS

◆ m_vecSkip

◆ m_vecSplitterGroup

◆ m_vecSplitterTime

◆ m_wsNames