An algorithm for grouping detectors and their associated spectra into single spectra and DetectorGroups. More...

#include <GroupDetectors2.h>

Inheritance diagram for Mantid::DataHandling::GroupDetectors2:

Classes
class	RangeHelper
	provides a function that expands pairs of integers separated with a hyphen into a list of all the integers between those values More...

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

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

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. More...

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

std::map< std::string, std::string >	validateInputs () override
	Validate inputs. More...

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

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

	Algorithm (const Algorithm &)=delete

Algorithm &	operator= (const Algorithm &)=delete

	~Algorithm () override
	Virtual destructor. More...

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

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

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. More...

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

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

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

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

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

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

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

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

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

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. More...

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

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

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

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

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

void	cancel () override
	Raises the cancel flag. More...

bool	getCancel () const
	Returns the cancellation state. More...

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

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

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

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

int	getLoggingOffset () const override
	returns the logging priority offset More...

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

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

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

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

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

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

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. More...

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

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. More...

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) More...

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

virtual bool	processGroups ()
	Process WorkspaceGroup inputs. More...

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

const Parallel::Communicator &	communicator () const
	Returns a const reference to the (MPI) communicator of the algorithm. More...

void	setCommunicator (const Parallel::Communicator &communicator)
	Sets the (MPI) communicator of the algorithm. More...

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

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

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

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. More...

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. More...

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. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	clear () override
	Clears all properties under management. More...

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

void	filterByTime (const Types::Core::DateAndTime &, const Types::Core::DateAndTime &) override

void	splitByTime (std::vector< Kernel::SplittingInterval > &, std::vector< Kernel::PropertyManager * >) const override

void	filterByProperty (const Kernel::TimeSeriesProperty< bool > &, const std::vector< std::string > &) override

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

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

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

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. More...

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. More...

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. More...

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). More...

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). More...

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. More...

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

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

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

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

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

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

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)

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)

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. More...

virtual void	addObserver (const Poco::AbstractObserver &observer) const =0
	Add an observer for a notification. More...

virtual const std::string	alias () const =0
	function to return any aliases of the algorithm. More...

virtual const std::string	aliasDeprecated () const =0
	Expiration date (in ISO8601 format) for the algorithm aliases. Empty if no expiration date. More...

virtual void	cancel ()=0
	Raises the cancel flag. More...

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

virtual const std::string	category () const =0
	function to return a category of the algorithm. More...

virtual const std::string	categorySeparator () const =0
	Function to return the separator token for the category string. More...

virtual void	enableHistoryRecordingForChild (const bool on)=0
	If true history will be recorded for a child. More...

virtual bool	execute ()=0
	System execution. More...

virtual void	executeAsChildAlg ()=0
	Execute as a Child Algorithm, with try/catch. More...

virtual Poco::ActiveResult< bool >	executeAsync ()=0
	Asynchronous execution of the algorithm. More...

virtual ExecutionState	executionState () const =0
	Gets the current execution state. More...

virtual AlgorithmID	getAlgorithmID () const =0
	Algorithm ID. More...

virtual bool	getAlgStartupLogging () const =0
	get the state of Logging of start and end messages More...

virtual bool	getAlwaysStoreInADS () const =0
	To query whether the output is stored in the analysis data service. More...

virtual int	getLoggingOffset () const =0
	returns the logging priority offset More...

virtual const std::string	helpURL () const =0
	function to return an optional URL for documentation. More...

virtual void	initialize ()=0
	Initialization method invoked by the framework. More...

virtual bool	isChild () const =0
	To query whether algorithm is a child. Default to false. More...

virtual bool	isExecuted () const =0
	Check whether the algorithm has been executed sucessfully. More...

virtual bool	isInitialized () const =0
	Check whether the algorithm is initialized properly. More...

virtual bool	isLogging () const =0
	returns the status of logging, True = enabled More...

virtual bool	isReadyForGarbageCollection () const =0
	True if the algorithm is ready for garbage collection. More...

virtual bool	isRunning () const =0
	True if the algorithm is running. More...

virtual const std::string	name () const =0
	function to return a name of the algorithm, must be overridden in all algorithms More...

virtual void	removeObserver (const Poco::AbstractObserver &observer) const =0
	Remove an observer. More...

virtual ResultState	resultState () const =0
	Gets the currnet result State. More...

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

virtual void	setAlgStartupLogging (const bool enabled)=0
	disable Logging of start and end messages More...

virtual void	setAlwaysStoreInADS (const bool doStore)=0
	Set whether we always store the output in the analysis data service. More...

virtual void	setChild (const bool isChild)=0
	To set whether algorithm is a child. More...

virtual void	setChildEndProgress (const double endProgress) const =0
	setting the child end progress More...

virtual void	setChildStartProgress (const double startProgress) const =0
	setting the child start progress More...

virtual void	setLogging (const bool value)=0
	Logging can be disabled by passing a value of false. More...

virtual void	setLoggingOffset (const int value)=0
	gets the logging priority offset More...

virtual void	setRethrows (const bool rethrow)=0
	To query whether an algorithm should rethrow exceptions when executing. More...

virtual const std::string	summary () const =0
	function returns a summary message that will be displayed in the default GUI, and in the help. More...

virtual ::Json::Value	toJson () const =0
	Serialize an algorithm as Json. More...

virtual std::string	toString () const =0
	Serialize an algorithm. More...

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

virtual int	version () const =0
	function to return a version of the algorithm, must be overridden in all algorithms More...

Algorithms As Methods
Public Member Functions inherited from Mantid::Kernel::IPropertyManager
virtual ::Json::Value	asJson (bool withDefaultValues=false) const =0
	Return the property manager serialized as a json object. More...

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

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

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). More...

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. More...

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). More...

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. More...

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. More...

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. More...

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

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

virtual void	filterByProperty (const TimeSeriesProperty< bool > &, const std::vector< std::string > &)=0

virtual void	filterByTime (const Types::Core::DateAndTime &, const Types::Core::DateAndTime &)=0

virtual std::vector< std::string >	getDeclaredPropertyNames () const noexcept=0
	Get the list of managed property names. More...

virtual Property *	getPointerToProperty (const std::string &name) const =0
	Get a pointer to property by name. More...

virtual const std::vector< Property * > &	getProperties () const =0
	Get the list of managed properties. More...

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

virtual TypedValue	getProperty (const std::string &name) const =0
	Get the value of a property. More...

virtual std::string	getPropertyValue (const std::string &name) const =0
	Get the value of a property as a string. More...

virtual size_t	propertyCount () const =0
	Returns the number of properties under management. More...

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

virtual void	resetProperties ()=0

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

virtual void	setProperties (const std::string &propertiesJson, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)=0
	Sets all properties from a string. More...

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

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

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

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

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. More...

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

virtual void	setPropertyOrdinal (const int &index, const std::string &value)=0
	Set the value of a property by an index. More...

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

virtual void	setPropertyValue (const std::string &name, const std::string &value)=0
	Sets property value from a string. More...

virtual void	setPropertyValueFromJson (const std::string &name, const Json::Value &value)=0
	Sets property value from a Json::Value. More...

virtual void	splitByTime (std::vector< SplittingInterval > &, std::vector< PropertyManager * >) const =0

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

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

virtual bool	validateProperties () const =0
	Validates all the properties in the collection. More...

virtual	~IPropertyManager ()=default

Private Types
enum	{ USED = 1000 - INT_MAX , EMPTY_LINE = 1001 - INT_MAX , IGNORE_SPACES = Mantid::Kernel::StringTokenizer::TOK_TRIM }
	flag values More...

using	storage_map = std::map< specnum_t, std::vector< size_t > >
	used to store the lists of WORKSPACE INDICES that will be grouped, the keys are not used More...

Private Member Functions
void	exec () override
	Virtual method - must be overridden by concrete algorithm. More...

void	execEvent ()

double	fileReadProg (DataHandling::GroupDetectors2::storage_map::size_type numGroupsRead, DataHandling::GroupDetectors2::storage_map::size_type numInHists)
	Estimate how much what has been read from the input file constitutes progress for the algorithm. More...

size_t	formGroups (const API::MatrixWorkspace_const_sptr &inputWS, const API::MatrixWorkspace_sptr &outputWS, const double prog4Copy, const bool keepAll, const std::set< int64_t > &unGroupedSet, Indexing::IndexInfo &indexInfo)
	Copy the and combine the histograms that the user requested from the input into the output workspace. More...

size_t	formGroupsEvent (const DataObjects::EventWorkspace_const_sptr &inputWS, const DataObjects::EventWorkspace_sptr &outputWS, const double prog4Copy)
	Copy the and combine the event lists that the user requested from the input into the output workspace. More...

void	getGroups (const API::MatrixWorkspace_const_sptr &workspace, std::vector< int64_t > &unUsedSpec)
	read in the input parameters and see what findout what will be to grouped More...

void	init () override
	Virtual method - must be overridden by concrete algorithm. More...

template<class TIn , class TOut >
void	moveOthers (const std::set< int64_t > &unGroupedSet, const TIn &inputWS, TOut &outputWS, size_t outIndex)
	Copy the ungrouped spectra from the input workspace to the output. More...

void	processFile (const std::string &fname, const API::MatrixWorkspace_const_sptr &workspace, std::vector< int64_t > &unUsedSpec)
	gets the list of spectra index numbers from a file of spectra numbers More...

void	processGroupingWorkspace (const DataObjects::GroupingWorkspace_const_sptr &groupWS, const API::MatrixWorkspace_const_sptr &workspace, std::vector< int64_t > &unUsedSpec)
	Get groupings from groupingworkspace. More...

void	processMatrixWorkspace (const API::MatrixWorkspace_const_sptr &groupWS, const API::MatrixWorkspace_const_sptr &workspace, std::vector< int64_t > &unUsedSpec)
	Get groupings from a matrix workspace. More...

void	processXMLFile (const std::string &fname, const API::MatrixWorkspace_const_sptr &workspace, std::vector< int64_t > &unUsedSpec)
	gets groupings from XML file More...

void	readFile (const spec2index_map &specs2index, std::istream &File, size_t &lineNum, std::vector< int64_t > &unUsedSpec, const bool ignoreGroupNumber)
	Reads from the file getting in order: an unused integer, on the next line the number of spectra in the group and next one or more lines the spectra numbers, (format in GroupDetectors.h) More...

int	readInt (const std::string &line)
	used while reading the file turns the string into an integer number (if possible), white space and # comments ignored More...

void	readSpectraIndexes (const std::string &line, const spec2index_map &specs2index, std::vector< size_t > &output, std::vector< int64_t > &unUsedSpec, const std::string &seperator="#")
	used while reading the file reads reads spectra numbers from the string and returns spectra indexes More...

Private Attributes
double	m_FracCompl = 0.0
	An estimate of the percentage of the algorithm runtimes that has been completed. More...

storage_map	m_GroupWsInds
	stores lists of spectra indexes to group, although we never do an index search on it More...

Static Private Attributes
static const double	CHECKBINS = 0.10
	a (worse case) estimate of the time More...

static const int	INTERVAL = 128
	reading it will take this percentage of the algorithm execution time More...

static const double	OPENINGFILE = 0.03
	required to check that the X bin boundaries are the same as a percentage of total algorithm run time More...

static const double	READFILE = 0.15
	if a file must be read in estimate that More...

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. More...

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

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

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

Protected Member Functions inherited from Mantid::API::Algorithm
void	exec (Parallel::ExecutionMode executionMode)
	Runs the algorithm with the specified execution mode. More...

virtual void	execDistributed ()
	Runs the algorithm in `distributed` execution mode. More...

virtual void	execMasterOnly ()
	Runs the algorithm in `master-only` execution mode. More...

virtual Parallel::ExecutionMode	getParallelExecutionMode (const std::map< std::string, Parallel::StorageMode > &storageModes) const
	Get correct execution mode based on input storage modes for an MPI run. More...

virtual const std::string	workspaceMethodOnTypes () const
	Returns a semi-colon separated list of workspace types to attach this algorithm. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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. More...

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)

Protected Member Functions inherited from Mantid::Kernel::IPropertyManager
virtual void	afterPropertySet (const std::string &)
	Override this method to perform a custom action right after a property was set. More...

virtual void	clear ()=0
	Clears all properties under management. More...

virtual Property *	getPointerToPropertyOrdinal (const int &index) const =0
	Get a property by an index. More...

template<typename T >
T	getValue (const std::string &name) const
	Templated method to get the value of a property. More...

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. More...

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

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

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

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

Kernel::Logger	m_log
	Logger for this algorithm. More...

Kernel::Logger &	g_log

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

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

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

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

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

Detailed Description

An algorithm for grouping detectors and their associated spectra into single spectra and DetectorGroups.

This algorithm can only be used on a workspace that has common X bins.

Required Properties:

InputWorkspace - The name of the Workspace2D to take as input
OutputWorkspace - The name of the workspace in which to store the result

Optional Properties:

MapFile - A file that containing lists of spectra to group, its format is given below
SpectraList - An array containing a list of the indexes of the spectra to combine
DetectorList - An array of detector ID's
WorkspaceIndexList - An array of workspace indices to combine
KeepUngroupedSpectra - If true ungrouped spectra will be copied to the output workspace

Any input file must have the following format:

| The format of the grouping file each phrase in "" is replaced by | a single integer (ignore all | and my insersions in []). Extra space | and comments starting with # are both allowed

| "unused number" |[in some implementations this is the number of groups in the file but here all groups in the file are read regardless] | "unused number" |[a positive integer must be here but the group's spectra number is the spectra number of the first spectra that went into the group and its index number is the number of groups in the list before it] | "number_of_input_spectra1" |[this number must equal the number of spectra numbers on the next lines] | "input spec1" "input spec2" "input spec3" "input spec4" |[these spectra numbers can be listed over any number of lines]

| "input spec5 input spec6" |

| "unused number" |[this section of the file is repeated once for each group to form] | "number_of_input_spectra2" |[not all the input sectra have to be included in a group | "input spec1" "input spec2" "input spec3" "input spec4" |

| "input spec5 input spec6" |

An example of an input file follows: 2 1 64 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 2 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128

Author: Steve Williams and Russell Taylor (Tessella Support Services plc)

Date: 27/07/2009

Definition at line 93 of file GroupDetectors2.h.

Member Typedef Documentation

◆ storage_map

using Mantid::DataHandling::GroupDetectors2::storage_map = std::map<specnum_t, std::vector<size_t> >

private

used to store the lists of WORKSPACE INDICES that will be grouped, the keys are not used

Definition at line 137 of file GroupDetectors2.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

flag values

Enumerator

USED

goes in the unGrouped spectra list to say that a

EMPTY_LINE

spectrum will be included in a group, any other value and it isn't.

Spectra numbers should always be positive so we shouldn't accidientally set a spectrum number to this when reading from the input file this

IGNORE_SPACES

value means that we found any empty line

equal to

Definition at line 196 of file GroupDetectors2.h.

Member Function Documentation

◆ category()

const std::string Mantid::DataHandling::GroupDetectors2::category ( ) const

inlineoverridevirtual

Algorithm's category for identification overriding a virtual method.

Reimplemented from Mantid::API::Algorithm.

Definition at line 110 of file GroupDetectors2.h.

◆ exec()

void Mantid::DataHandling::GroupDetectors2::exec ( )

overrideprivatevirtual

Virtual method - must be overridden by concrete algorithm.

Implements Mantid::API::Algorithm.

Definition at line 147 of file GroupDetectors2.cpp.

References CHECKBINS, Mantid::DataObjects::create(), execEvent(), formGroups(), getGroups(), Mantid::API::Algorithm::getProperty(), Mantid::Kernel::SingletonHolder< T >::Instance(), Mantid::API::Algorithm::interruption_point(), m_FracCompl, m_GroupWsInds, moveOthers(), Mantid::API::Algorithm::progress(), and Mantid::Kernel::IPropertyManager::setProperty().

◆ execEvent()

void Mantid::DataHandling::GroupDetectors2::execEvent ( )

private

Definition at line 217 of file GroupDetectors2.cpp.

References CHECKBINS, Mantid::DataObjects::create(), formGroupsEvent(), getGroups(), Mantid::API::Algorithm::getProperty(), Mantid::Kernel::SingletonHolder< T >::Instance(), Mantid::API::Algorithm::interruption_point(), m_FracCompl, m_GroupWsInds, moveOthers(), Mantid::API::Algorithm::progress(), and Mantid::Kernel::IPropertyManager::setProperty().

Referenced by exec().

◆ fileReadProg()

double Mantid::DataHandling::GroupDetectors2::fileReadProg	(	DataHandling::GroupDetectors2::storage_map::size_type	numGroupsRead,
		DataHandling::GroupDetectors2::storage_map::size_type	numInHists
	)

private

Estimate how much what has been read from the input file constitutes progress for the algorithm.

Called while reading input file to report progress (doesn't update m_FracCompl ) and check for algorithm cancel messages, doesn't look at file size to estimate progress.

Parameters

numGroupsRead	:: number of groups read from the file so far (not the number of spectra)
numInHists	:: the total number of histograms in the input workspace

Returns: estimate of the amount of algorithm progress obtained by reading from the file

Definition at line 835 of file GroupDetectors2.cpp.

References Mantid::API::Algorithm::interruption_point(), m_FracCompl, Mantid::API::Algorithm::progress(), and READFILE.

Referenced by processFile(), and readFile().

◆ formGroups()

size_t Mantid::DataHandling::GroupDetectors2::formGroups	(	const API::MatrixWorkspace_const_sptr &	inputWS,
		const API::MatrixWorkspace_sptr &	outputWS,
		const double	prog4Copy,
		const bool	keepAll,
		const std::set< int64_t > &	unGroupedSet,
		Indexing::IndexInfo &	indexInfo
	)

private

Copy the and combine the histograms that the user requested from the input into the output workspace.

Move the user selected spectra in the input workspace into groups in the output workspace.

Parameters

inputWS	:: user selected input workspace for the algorithm
outputWS	:: user selected output workspace for the algorithm
prog4Copy	:: the amount of algorithm progress to attribute to moving a single spectra
keepAll	:: whether or not to keep ungrouped spectra
unGroupedSet	:: the set of workspace indexes that are left ungrouped
indexInfo	:: an IndexInfo object that will contain the desired indexing after grouping

Returns: number of new grouped spectra

Definition at line 862 of file GroupDetectors2.cpp.

References count, Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::interruption_point(), INTERVAL, m_FracCompl, m_GroupWsInds, n, and Mantid::API::Algorithm::progress().

Referenced by exec().

◆ formGroupsEvent()

size_t Mantid::DataHandling::GroupDetectors2::formGroupsEvent	(	const DataObjects::EventWorkspace_const_sptr &	inputWS,
		const DataObjects::EventWorkspace_sptr &	outputWS,
		const double	prog4Copy
	)

private

Copy the and combine the event lists that the user requested from the input into the output workspace.

Move the user selected spectra in the input workspace into groups in the output workspace.

Parameters

inputWS	:: user selected input workspace for the algorithm
outputWS	:: user selected output workspace for the algorithm
prog4Copy	:: the amount of algorithm progress to attribute to moving a single spectra

Returns: number of new grouped spectra

Definition at line 980 of file GroupDetectors2.cpp.

References Mantid::API::ISpectrum::addDetectorIDs(), Mantid::API::ISpectrum::clearDetectorIDs(), Mantid::API::Algorithm::createChildAlgorithm(), Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, Mantid::API::ISpectrum::getDetectorIDs(), Mantid::API::Algorithm::getProperty(), Mantid::Kernel::SingletonHolder< T >::Instance(), Mantid::API::Algorithm::interruption_point(), INTERVAL, m_FracCompl, m_GroupWsInds, name(), Mantid::API::Algorithm::progress(), and Mantid::API::ISpectrum::setSpectrumNo().

Referenced by execEvent().

◆ getGroups()

void Mantid::DataHandling::GroupDetectors2::getGroups	(	const API::MatrixWorkspace_const_sptr &	workspace,
		std::vector< int64_t > &	unUsedSpec
	)

private

read in the input parameters and see what findout what will be to grouped

Make a map containing spectra indexes to group, the indexes could have come from a file, or an array, spectra numbers ...

Parameters

workspace	:: the user selected input workspace
unUsedSpec	:: spectra indexes that are not members of any group

Definition at line 286 of file GroupDetectors2.cpp.

References Mantid::Kernel::Logger::debug(), detectorList, Mantid::Kernel::Logger::error(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), Mantid::API::SpectraAxis::getSpectraIndexMap(), index, Mantid::Kernel::Logger::information(), m_GroupWsInds, name(), processFile(), processGroupingWorkspace(), processMatrixWorkspace(), processXMLFile(), readFile(), USED, Mantid::Kernel::Logger::warning(), and workspace.

Referenced by exec(), and execEvent().

◆ init()

void Mantid::DataHandling::GroupDetectors2::init ( )

overrideprivatevirtual

Virtual method - must be overridden by concrete algorithm.

Implements Mantid::API::Algorithm.

Definition at line 99 of file GroupDetectors2.cpp.

References Mantid::API::Algorithm::declareProperty(), Mantid::Kernel::Direction::Input, Mantid::API::PropertyMode::Optional, Mantid::API::FileProperty::OptionalLoad, and Mantid::Kernel::Direction::Output.

◆ moveOthers()

template<class TIn , class TOut >

void Mantid::DataHandling::GroupDetectors2::moveOthers	(	const std::set< int64_t > &	unGroupedSet,
		const TIn &	inputWS,
		TOut &	outputWS,
		size_t	outIndex
	)

private

Copy the ungrouped spectra from the input workspace to the output.

Only to be used if the KeepUnGrouped property is true, moves the spectra that were not selected to be in a group to the end of the output spectrum.

Parameters

unGroupedSet	:: list of WORKSPACE indexes that were included in a group
inputWS	:: user selected input workspace for the algorithm
outputWS	:: user selected output workspace for the algorithm
outIndex	:: the next spectra index available after the grouped spectra

Definition at line 233 of file GroupDetectors2.h.

References Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::interruption_point(), INTERVAL, m_FracCompl, name(), Mantid::API::Algorithm::progress(), and USED.

Referenced by exec(), and execEvent().

◆ name()

const std::string Mantid::DataHandling::GroupDetectors2::name ( ) const

inlineoverridevirtual

Algorithm's name for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Definition at line 96 of file GroupDetectors2.h.

Referenced by formGroupsEvent(), getGroups(), moveOthers(), and readSpectraIndexes().

◆ processFile()

void Mantid::DataHandling::GroupDetectors2::processFile	(	const std::string &	fname,
		const API::MatrixWorkspace_const_sptr &	workspace,
		std::vector< int64_t > &	unUsedSpec
	)

private

gets the list of spectra index numbers from a file of spectra numbers

Read the spectra numbers in from the input file (the file format is in the source file "GroupDetectors2.h" and make an array of spectra indexes to group.

Parameters

fname	:: the full path name of the file to open
workspace	:: a pointer to the input workspace, used to get spectra indexes from numbers
unUsedSpec	:: the list of spectra indexes that have been included in a group (so far)

Exceptions

FileError if there's any problem with the file or its format

Definition at line 416 of file GroupDetectors2.cpp.

References Mantid::Kernel::Logger::debug(), EMPTY_LINE, error, fileReadProg(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), Mantid::API::SpectraAxis::getSpectraIndexMap(), Mantid::API::Algorithm::interruption_point(), m_FracCompl, m_GroupWsInds, OPENINGFILE, Mantid::API::Algorithm::progress(), readFile(), readInt(), std::to_string(), Mantid::Kernel::Logger::warning(), and workspace.

Referenced by getGroups().

◆ processGroupingWorkspace()

void Mantid::DataHandling::GroupDetectors2::processGroupingWorkspace	(	const DataObjects::GroupingWorkspace_const_sptr &	groupWS,
		const API::MatrixWorkspace_const_sptr &	workspace,
		std::vector< int64_t > &	unUsedSpec
	)

private

Get groupings from groupingworkspace.

Parameters

groupWS	:: the grouping workspace to use
workspace	:: a pointer to the input workspace, used to get spectra indexes from numbers
unUsedSpec	:: the list of spectra indexes that have been not included in a group (so far)

Definition at line 587 of file GroupDetectors2.cpp.

References m_GroupWsInds, USED, and workspace.

Referenced by getGroups().

◆ processMatrixWorkspace()

void Mantid::DataHandling::GroupDetectors2::processMatrixWorkspace	(	const API::MatrixWorkspace_const_sptr &	groupWS,
		const API::MatrixWorkspace_const_sptr &	workspace,
		std::vector< int64_t > &	unUsedSpec
	)

private

Get groupings from a matrix workspace.

Parameters

groupWS	:: the matrix workspace to use
workspace	:: a pointer to the input workspace, used to get spectra indexes from numbers
unUsedSpec	:: the list of spectra indexes that have been not included in a group (so far)

Definition at line 632 of file GroupDetectors2.cpp.

References m_GroupWsInds, USED, and workspace.

Referenced by getGroups().

◆ processXMLFile()

void Mantid::DataHandling::GroupDetectors2::processXMLFile	(	const std::string &	fname,
		const API::MatrixWorkspace_const_sptr &	workspace,
		std::vector< int64_t > &	unUsedSpec
	)

private

gets groupings from XML file

Get groupings from XML file.

Parameters

fname	:: the full path name of the file to open
workspace	:: a pointer to the input workspace, used to get spectra indexes from numbers
unUsedSpec	:: the list of spectra indexes that have been included in a group (so far)

Exceptions

FileError if there's any problem with the file or its format

Definition at line 500 of file GroupDetectors2.cpp.

References Mantid::Kernel::Logger::error(), Mantid::API::Algorithm::g_log, Mantid::DataHandling::LoadGroupXMLFile::getGroupDetectorsMap(), Mantid::DataHandling::LoadGroupXMLFile::getGroupSpectraMap(), Mantid::API::Algorithm::getProperty(), Mantid::API::SpectraAxis::getSpectraIndexMap(), Mantid::DataHandling::LoadGroupXMLFile::loadXMLFile(), m_GroupWsInds, Mantid::DataHandling::LoadGroupXMLFile::setDefaultStartingGroupID(), USED, and workspace.

Referenced by getGroups().

◆ readFile()

void Mantid::DataHandling::GroupDetectors2::readFile	(	const spec2index_map &	specs2index,
		std::istream &	File,
		size_t &	lineNum,
		std::vector< int64_t > &	unUsedSpec,
		const bool	ignoreGroupNumber
	)

private

Reads from the file getting in order: an unused integer, on the next line the number of spectra in the group and next one or more lines the spectra numbers, (format in GroupDetectors.h)

Parameters

specs2index	:: a map that links spectra numbers to indexes
File	:: the input stream that is linked to the file
lineNum	:: the last line read in the file, is updated by this function
unUsedSpec	:: list of spectra that haven't yet been included in a group
ignoreGroupNumber	:: ignore group numbers when numbering spectra

Exceptions

invalid_argument if there is any problem with the file

Definition at line 719 of file GroupDetectors2.cpp.

References EMPTY_LINE, fileReadProg(), INTERVAL, m_GroupWsInds, readInt(), readSpectraIndexes(), and std::to_string().

Referenced by getGroups(), and processFile().

◆ readInt()

int Mantid::DataHandling::GroupDetectors2::readInt ( const std::string & line )

private

used while reading the file turns the string into an integer number (if possible), white space and # comments ignored

The function expects that the string passed to it contains an integer number, it reads the number and returns it.

Parameters

line	:: a line read from the file, we'll interpret this

Returns: the integer read from the line, error code if not readable

Exceptions

invalid_argument	when the line contains more just an integer
boost::bad_lexical_cast	when the string can't be interpreted as an integer

Definition at line 680 of file GroupDetectors2.cpp.

References Mantid::Kernel::StringTokenizer::begin(), Mantid::Kernel::StringTokenizer::count(), Mantid::Kernel::Logger::debug(), EMPTY_LINE, Mantid::Kernel::StringTokenizer::end(), Mantid::API::Algorithm::g_log, and Mantid::Kernel::StringTokenizer::TOK_TRIM.

Referenced by processFile(), and readFile().

◆ readSpectraIndexes()

void Mantid::DataHandling::GroupDetectors2::readSpectraIndexes	(	const std::string &	line,
		const spec2index_map &	specs2index,
		std::vector< size_t > &	output,
		std::vector< int64_t > &	unUsedSpec,
		const std::string &	seperator = `"#"`
	)

private

used while reading the file reads reads spectra numbers from the string and returns spectra indexes

The function expects that the string passed to it contains a series of integers, ranges specified with a '-' are possible.

Parameters

line	:: a line read from the file, we'll interpret this
specs2index	:: a map with spectra numbers as indexes and index numbers as values
output	:: the list of integers, with any ranges expanded
unUsedSpec	:: the list of spectra indexes that have been included in a group (so far)
seperator	:: the symbol for the index range separator

Exceptions

invalid_argument when a number couldn't be found or the number is not in the spectra map

Definition at line 792 of file GroupDetectors2.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, Mantid::DataHandling::GroupDetectors2::RangeHelper::getList(), IGNORE_SPACES, name(), std::to_string(), and USED.

Referenced by readFile().

◆ seeAlso()

const std::vector< std::string > Mantid::DataHandling::GroupDetectors2::seeAlso ( ) const

inlineoverridevirtual

Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm.A default implementation is provided.

Reimplemented from Mantid::API::Algorithm.

Definition at line 108 of file GroupDetectors2.h.

◆ summary()

const std::string Mantid::DataHandling::GroupDetectors2::summary ( ) const

inlineoverridevirtual

Summary of algorithms purpose.

Implements Mantid::API::Algorithm.

Definition at line 98 of file GroupDetectors2.h.

◆ validateInputs()

std::map< std::string, std::string > Mantid::DataHandling::GroupDetectors2::validateInputs ( void )

overridevirtual

Validate inputs.

Used to validate the inputs for GroupDetectors2.

Returns: : A map of the invalid property names to what the problem is.

Reimplemented from Mantid::API::Algorithm.

Definition at line 1134 of file GroupDetectors2.cpp.

References Mantid::API::Algorithm::getPropertyValue(), and IGNORE_SPACES.

◆ version()

int Mantid::DataHandling::GroupDetectors2::version ( ) const

inlineoverridevirtual

Algorithm's version for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Definition at line 107 of file GroupDetectors2.h.

Member Data Documentation

◆ CHECKBINS

const double Mantid::DataHandling::GroupDetectors2::CHECKBINS = 0.10

staticprivate

a (worse case) estimate of the time

Definition at line 209 of file GroupDetectors2.h.

Referenced by exec(), and execEvent().

◆ INTERVAL

const int Mantid::DataHandling::GroupDetectors2::INTERVAL = 128

staticprivate

reading it will take this percentage of the algorithm execution time

copy this many histograms and then check for an algorithm notification and update the progress bar

Definition at line 217 of file GroupDetectors2.h.

Referenced by formGroups(), formGroupsEvent(), moveOthers(), and readFile().

◆ m_FracCompl

double Mantid::DataHandling::GroupDetectors2::m_FracCompl = 0.0

private

An estimate of the percentage of the algorithm runtimes that has been completed.

Definition at line 141 of file GroupDetectors2.h.

Referenced by exec(), execEvent(), fileReadProg(), formGroups(), formGroupsEvent(), moveOthers(), and processFile().

◆ m_GroupWsInds

storage_map Mantid::DataHandling::GroupDetectors2::m_GroupWsInds

private

stores lists of spectra indexes to group, although we never do an index search on it

Definition at line 144 of file GroupDetectors2.h.

Referenced by exec(), execEvent(), formGroups(), formGroupsEvent(), getGroups(), processFile(), processGroupingWorkspace(), processMatrixWorkspace(), processXMLFile(), and readFile().

◆ OPENINGFILE

const double Mantid::DataHandling::GroupDetectors2::OPENINGFILE = 0.03

staticprivate

required to check that the X bin boundaries are the same as a percentage of total algorithm run time

gives the progress bar a nudge when the file opens

Definition at line 213 of file GroupDetectors2.h.

Referenced by processFile().

◆ READFILE

const double Mantid::DataHandling::GroupDetectors2::READFILE = 0.15

staticprivate

if a file must be read in estimate that

Definition at line 214 of file GroupDetectors2.h.

Referenced by fileReadProg().

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

Framework/DataHandling/inc/MantidDataHandling/GroupDetectors2.h
Framework/DataHandling/src/GroupDetectors2.cpp

Classes

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

| "input spec5 input spec6" |

| "input spec5 input spec6" |

Member Typedef Documentation

◆ storage_map

Member Enumeration Documentation

◆ anonymous enum

Member Function Documentation

◆ category()

◆ exec()

◆ execEvent()

◆ fileReadProg()

◆ formGroups()

◆ formGroupsEvent()

◆ getGroups()

◆ init()

◆ moveOthers()

◆ name()

◆ processFile()

◆ processGroupingWorkspace()

◆ processMatrixWorkspace()

◆ processXMLFile()

◆ readFile()

◆ readInt()

◆ readSpectraIndexes()

◆ seeAlso()

◆ summary()

◆ validateInputs()

◆ version()

Member Data Documentation

◆ CHECKBINS

◆ INTERVAL

◆ m_FracCompl

◆ m_GroupWsInds

◆ OPENINGFILE

◆ READFILE