Extracts specified spectra from a workspace and places them in a new workspace. More...

#include <ExtractSpectra.h>

Inheritance diagram for Mantid::Algorithms::ExtractSpectra:

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

const std::string	name () const override
	Algorithms name for identification.

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
	Algorithm's summary for use in the GUI and help.

std::map< std::string, std::string >	validateInputs () override
	Validate the input properties are sane.

int	version () const override
	Algorithm's version for identification.

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 Member Functions
void	checkProperties ()
	Retrieves the optional input properties and checks that they have valid values.

void	cropCommon (API::MatrixWorkspace &workspace, Kernel::cow_ptr< Mantid::HistogramData::HistogramX > XHistogram, int index)
	Crops the given workspace in accordance with m_minX and m_maxX.

void	cropRagged (API::MatrixWorkspace &workspace, int index)
	Zeroes all data points outside the X values given.

void	exec () override
	Executes the algorithm.

void	execEvent ()
	Executes the algorithm.

void	execHistogram ()
	Execute the algorithm in case of a histogrammed data.

const Kernel::cow_ptr< Mantid::HistogramData::HistogramX >	getCroppedXHistogram (const API::MatrixWorkspace &workspace)
	Returns a pointer to a cropped X Histogram to be used as the X Histogram for each of the spectra in the new cropped workspace.

std::size_t	getXMaxIndex (const size_t wsIndex=0)
	Find the X index corresponding to (or just within) the value given in the XMax property.

std::size_t	getXMinIndex (const size_t wsIndex=0)
	Find the X index corresponding to (or just within) the value given in the XMin property.

std::size_t	histXMaxIndex () const

void	init () override
	Initialize the algorithm's properties.

void	propagateBinMasking (API::MatrixWorkspace &workspace, const int i) const
	Propagate bin masking if there is any.

Private Attributes
DataObjects::EventWorkspace_sptr	eventW

bool	m_commonBoundaries = false
	Flag indicating whether the input workspace has common boundaries.

bool	m_croppingInX = false
	Flag indicating whether XMin and/or XMax has been set.

API::MatrixWorkspace_sptr	m_inputWorkspace
	The input workspace.

bool	m_isHistogramData = false
	Flag indicating whether we're dealing with histogram data.

std::size_t	m_maxXIndex = 0
	The bin index to end the cropped workspace at.

std::size_t	m_minXIndex = 0
	The bin index to start the cropped workspace from.

std::vector< size_t >	m_workspaceIndexList
	The list of workspaces to extract.

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

Extracts specified spectra from a workspace and places them in a new workspace.

Definition at line 19 of file ExtractSpectra.h.

Member Function Documentation

◆ category()

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

overridevirtual

Algorithm's category for identification.

See also: Algorithm::category

Implements Mantid::API::IAlgorithm.

Definition at line 44 of file ExtractSpectra.cpp.

◆ checkProperties()

void Mantid::Algorithms::ExtractSpectra::checkProperties ( )

private

Retrieves the optional input properties and checks that they have valid values.

Assigns to the defaults if any property has not been set.

Exceptions

std::invalid_argument	If the input workspace does not have common binning
std::out_of_range	If a property is set to an invalid value for the input workspace

Definition at line 343 of file ExtractSpectra.cpp.

References detectorList, Mantid::API::Algorithm::getProperty(), getXMaxIndex(), getXMinIndex(), Mantid::API::Algorithm::isEmpty(), m_commonBoundaries, m_croppingInX, m_inputWorkspace, m_isHistogramData, m_maxXIndex, m_minXIndex, and m_workspaceIndexList.

Referenced by exec().

◆ cropCommon()

void Mantid::Algorithms::ExtractSpectra::cropCommon	(	API::MatrixWorkspace &	workspace,
		Kernel::cow_ptr< Mantid::HistogramData::HistogramX >	XHistogram,
		int	index
	)

private

Crops the given workspace in accordance with m_minX and m_maxX.

Parameters

workspace	:: The output workspace to crop
XHistogram	:: Pointer to the cropped X Histogram to be used in the output workspace
index	:: The workspace index of the spectrum

Definition at line 200 of file ExtractSpectra.cpp.

References histXMaxIndex(), index, m_minXIndex, and workspace.

Referenced by execHistogram().

◆ cropRagged()

void Mantid::Algorithms::ExtractSpectra::cropRagged	(	API::MatrixWorkspace &	workspace,
		int	index
	)

private

Zeroes all data points outside the X values given.

Parameters

workspace	:: The output workspace to crop
index	:: The workspace index of the spectrum

Definition at line 225 of file ExtractSpectra.cpp.

References getXMaxIndex(), getXMinIndex(), index, m_isHistogramData, workspace, and Mantid::Geometry::Y.

Referenced by execHistogram().

◆ exec()

void Mantid::Algorithms::ExtractSpectra::exec ( )

overrideprivatevirtual

Executes the algorithm.

Exceptions

std::out_of_range If a property is set to an invalid value for the input workspace

Implements Mantid::API::Algorithm.

Definition at line 127 of file ExtractSpectra.cpp.

References checkProperties(), eventW, execEvent(), execHistogram(), Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::isDefault(), m_commonBoundaries, m_inputWorkspace, m_isHistogramData, m_workspaceIndexList, Mantid::Kernel::IPropertyManager::setProperty(), and Mantid::API::Algorithm::setupAsChildAlgorithm().

◆ execEvent()

void Mantid::Algorithms::ExtractSpectra::execEvent ( )

private

Executes the algorithm.

This does not sort the events because the method of removing events outside of range looks at all of the events.

Exceptions

std::out_of_range If a property is set to an invalid value for the input workspace

Definition at line 263 of file ExtractSpectra.cpp.

References eventW, Mantid::API::Algorithm::getProperty(), histXMaxIndex(), Mantid::API::Algorithm::isDefault(), m_commonBoundaries, m_inputWorkspace, m_maxXIndex, m_minXIndex, PARALLEL_CHECK_INTERRUPT_REGION, PARALLEL_END_INTERRUPT_REGION, PARALLEL_FOR_IF, PARALLEL_START_INTERRUPT_REGION, propagateBinMasking(), Mantid::Kernel::ProgressBase::report(), Mantid::Kernel::threadSafe(), Mantid::API::TOF, Mantid::API::WEIGHTED, and Mantid::API::WEIGHTED_NOTIME.

Referenced by exec().

◆ execHistogram()

void Mantid::Algorithms::ExtractSpectra::execHistogram ( )

private

Execute the algorithm in case of a histogrammed data.

Definition at line 161 of file ExtractSpectra.cpp.

References cropCommon(), cropRagged(), getCroppedXHistogram(), m_commonBoundaries, m_inputWorkspace, propagateBinMasking(), and Mantid::Kernel::ProgressBase::report().

Referenced by exec().

◆ getCroppedXHistogram()

const Kernel::cow_ptr< Mantid::HistogramData::HistogramX > Mantid::Algorithms::ExtractSpectra::getCroppedXHistogram ( const API::MatrixWorkspace & workspace )

private

Returns a pointer to a cropped X Histogram to be used as the X Histogram for each of the spectra in the new cropped workspace.

Parameters

workspace :: The workspace from which to get the cropped X Histogram

Returns: XHistogram :: Pointer to cropped X Histogram from the workspace

Definition at line 182 of file ExtractSpectra.cpp.

References histXMaxIndex(), m_minXIndex, and workspace.

Referenced by execHistogram().

◆ getXMaxIndex()

size_t Mantid::Algorithms::ExtractSpectra::getXMaxIndex ( const size_t wsIndex = 0 )

private

Find the X index corresponding to (or just within) the value given in the XMax property.

Sets the default if the property has not been set.

Parameters

wsIndex The workspace index to check (default 0).

Returns: The X index corresponding to the XMax value.

Definition at line 424 of file ExtractSpectra.cpp.

References Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::isEmpty(), m_commonBoundaries, m_inputWorkspace, and Mantid::Geometry::X.

Referenced by checkProperties(), and cropRagged().

◆ getXMinIndex()

size_t Mantid::Algorithms::ExtractSpectra::getXMinIndex ( const size_t wsIndex = 0 )

private

Find the X index corresponding to (or just within) the value given in the XMin property.

Sets the default if the property has not been set.

Parameters

wsIndex The workspace index to check (default 0).

Returns: The X index corresponding to the XMin value.

Definition at line 399 of file ExtractSpectra.cpp.

References Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::isEmpty(), m_commonBoundaries, m_inputWorkspace, and Mantid::Geometry::X.

Referenced by checkProperties(), and cropRagged().

◆ histXMaxIndex()

size_t Mantid::Algorithms::ExtractSpectra::histXMaxIndex ( ) const

private

Definition at line 443 of file ExtractSpectra.cpp.

References m_isHistogramData, and m_maxXIndex.

Referenced by cropCommon(), execEvent(), getCroppedXHistogram(), and propagateBinMasking().

◆ init()

void Mantid::Algorithms::ExtractSpectra::init ( )

overrideprivatevirtual

Initialize the algorithm's properties.

Implements Mantid::API::Algorithm.

Definition at line 84 of file ExtractSpectra.cpp.

References Mantid::API::Algorithm::declareProperty(), Mantid::EMPTY_DBL(), Mantid::EMPTY_INT(), Mantid::Kernel::Direction::Input, and Mantid::Kernel::Direction::Output.

◆ name()

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

overridevirtual

Algorithms name for identification.

See also: Algorithm::name

Implements Mantid::API::Algorithm.

Definition at line 38 of file ExtractSpectra.cpp.

◆ propagateBinMasking()

void Mantid::Algorithms::ExtractSpectra::propagateBinMasking	(	API::MatrixWorkspace &	workspace,
		const int	i
	)		const

private

Propagate bin masking if there is any.

Definition at line 319 of file ExtractSpectra.cpp.

References histXMaxIndex(), m_minXIndex, and workspace.

Referenced by execEvent(), and execHistogram().

◆ seeAlso()

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

inlineoverridevirtual

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

Implements Mantid::API::IAlgorithm.

Definition at line 23 of file ExtractSpectra.h.

◆ summary()

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

overridevirtual

Algorithm's summary for use in the GUI and help.

See also: Algorithm::summary

Implements Mantid::API::Algorithm.

Definition at line 47 of file ExtractSpectra.cpp.

◆ validateInputs()

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

overridevirtual

Validate the input properties are sane.

Implements Mantid::API::IAlgorithm.

Definition at line 53 of file ExtractSpectra.cpp.

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

◆ version()

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

overridevirtual

Algorithm's version for identification.

See also: Algorithm::version

Implements Mantid::API::Algorithm.

Definition at line 41 of file ExtractSpectra.cpp.

Member Data Documentation

◆ eventW

DataObjects::EventWorkspace_sptr Mantid::Algorithms::ExtractSpectra::eventW

private

Definition at line 48 of file ExtractSpectra.h.

Referenced by exec(), and execEvent().

◆ m_commonBoundaries

bool Mantid::Algorithms::ExtractSpectra::m_commonBoundaries = false

private

Flag indicating whether the input workspace has common boundaries.

Definition at line 54 of file ExtractSpectra.h.

Referenced by checkProperties(), exec(), execEvent(), execHistogram(), getXMaxIndex(), and getXMinIndex().

◆ m_croppingInX

bool Mantid::Algorithms::ExtractSpectra::m_croppingInX = false

private

Flag indicating whether XMin and/or XMax has been set.

Definition at line 58 of file ExtractSpectra.h.

Referenced by checkProperties().

◆ m_inputWorkspace

API::MatrixWorkspace_sptr Mantid::Algorithms::ExtractSpectra::m_inputWorkspace

private

The input workspace.

Definition at line 47 of file ExtractSpectra.h.

Referenced by checkProperties(), exec(), execEvent(), execHistogram(), getXMaxIndex(), and getXMinIndex().

◆ m_isHistogramData

bool Mantid::Algorithms::ExtractSpectra::m_isHistogramData = false

private

Flag indicating whether we're dealing with histogram data.

Definition at line 56 of file ExtractSpectra.h.

Referenced by checkProperties(), cropRagged(), exec(), and histXMaxIndex().

◆ m_maxXIndex

std::size_t Mantid::Algorithms::ExtractSpectra::m_maxXIndex = 0

private

The bin index to end the cropped workspace at.

Definition at line 52 of file ExtractSpectra.h.

Referenced by checkProperties(), execEvent(), and histXMaxIndex().

◆ m_minXIndex

std::size_t Mantid::Algorithms::ExtractSpectra::m_minXIndex = 0

private

The bin index to start the cropped workspace from.

Definition at line 50 of file ExtractSpectra.h.

Referenced by checkProperties(), cropCommon(), execEvent(), getCroppedXHistogram(), and propagateBinMasking().

◆ m_workspaceIndexList

std::vector<size_t> Mantid::Algorithms::ExtractSpectra::m_workspaceIndexList

private

The list of workspaces to extract.

Definition at line 60 of file ExtractSpectra.h.

Referenced by checkProperties(), and exec().

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

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ category()

◆ checkProperties()

◆ cropCommon()

◆ cropRagged()

◆ exec()

◆ execEvent()

◆ execHistogram()

◆ getCroppedXHistogram()

◆ getXMaxIndex()

◆ getXMinIndex()

◆ histXMaxIndex()

◆ init()

◆ name()

◆ propagateBinMasking()

◆ seeAlso()

◆ summary()

◆ validateInputs()

◆ version()

Member Data Documentation

◆ eventW

◆ m_commonBoundaries

◆ m_croppingInX

◆ m_inputWorkspace

◆ m_isHistogramData

◆ m_maxXIndex

◆ m_minXIndex

◆ m_workspaceIndexList