Mantid
Loading...
Searching...
No Matches
Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
Mantid::Algorithms::Stitch1D Class Referencefinal

Stitch1D : Stitches two Matrix Workspaces together into a single output. More...

#include <Stitch1D.h>

Inheritance diagram for Mantid::Algorithms::Stitch1D:
Mantid::API::Algorithm Mantid::API::IAlgorithm Mantid::Kernel::IPropertyManager

Public Member Functions

const std::string category () const override
 Algorithm's category for identification. More...
 
bool hasNonzeroErrors (Mantid::API::MatrixWorkspace_sptr &ws)
 Does the x-axis have non-zero errors. More...
 
const std::string name () const override
 Algorithm's name for identification. More...
 
const std::vector< std::string > seeAlso () const override
 Function to return all of the seeAlso algorithms related to this algorithm. More...
 
const std::string summary () const override
 Summary of algorithm's purpose. More...
 
std::map< std::string, std::string > validateInputs () override
 Cross-check properties with each other. More...
 
int version () const override
 Algorithm's version for identification. More...
 
- Public Member Functions inherited from Mantid::API::Algorithm
 Algorithm ()
 Constructor. More...
 
 Algorithm (const Algorithm &)=delete
 
Algorithmoperator= (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...
 
std::map< std::string, std::string > validateInputs () override
 Perform validation of ALL the input properties of the 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::LoggergetLogger () 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< AlgorithmcreateChildAlgorithm (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::PropertytakeProperty (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::PropertygetPointerToProperty (const std::string &name) const override
 Get a property by name. More...
 
Kernel::PropertygetPointerToPropertyOrdinal (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::string category () const override
 function to return a category of the algorithm. 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::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 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 PropertygetPointerToProperty (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...
 
IPropertyManagersetProperty (const std::string &name, const char *value)
 Specialised version of setProperty template method to handle const char *. More...
 
IPropertyManagersetProperty (const std::string &name, const std::string &value)
 Specialised version of setProperty template method to handle std::string. More...
 
template<typename T >
IPropertyManagersetProperty (const std::string &name, const T &value)
 Templated method to set the value of a PropertyWithValue. More...
 
template<typename T >
IPropertyManagersetProperty (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< PropertytakeProperty (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

using SpecialTypeIndexes = std::vector< std::vector< size_t > >
 Helper typedef. More...
 

Private Member Functions

Mantid::API::MatrixWorkspace_sptr conjoinXAxis (Mantid::API::MatrixWorkspace_sptr &inOne, Mantid::API::MatrixWorkspace_sptr &inTwo)
 Conjoin x axis. More...
 
void exec () override
 Overwrites Algorithm method. More...
 
boost::tuple< int, int > findStartEndIndexes (double startOverlap, double endOverlap, Mantid::API::MatrixWorkspace_sptr &workspace)
 Find the start and end indexes. More...
 
double getEndOverlap (const double intesectionMin, const double intesectionMax) const
 Get the end overlap. More...
 
std::vector< double > getRebinParams (Mantid::API::MatrixWorkspace_const_sptr &lhsWS, Mantid::API::MatrixWorkspace_const_sptr &rhsWS, const bool scaleRHS) const
 Get the rebin parameters. More...
 
double getStartOverlap (const double intesectionMin, const double intesectionMax) const
 Get the start overlap. More...
 
void init () override
 Overwrites Algorithm method. More...
 
Mantid::API::MatrixWorkspace_sptr integration (Mantid::API::MatrixWorkspace_sptr &input, const double start, const double stop)
 Perform integration. More...
 
Mantid::API::MatrixWorkspace_sptr maskAllBut (int a1, int a2, Mantid::API::MatrixWorkspace_sptr &source)
 Mask out everything but the data in the ranges. More...
 
void maskInPlace (int a1, int a2, Mantid::API::MatrixWorkspace_sptr &source)
 Mask out everything but the data in the ranges, but do it inplace. More...
 
Mantid::API::MatrixWorkspace_sptr rebin (Mantid::API::MatrixWorkspace_sptr &input, const std::vector< double > &params)
 Perform rebin. More...
 
void reinsertSpecialValues (const Mantid::API::MatrixWorkspace_sptr &ws)
 Add back in any special values. More...
 
void scaleWorkspace (API::MatrixWorkspace_sptr &ws, API::MatrixWorkspace_sptr &scaleFactorWS, API::MatrixWorkspace_const_sptr &dxWS)
 Scale workspace (left hand side or right hand side) More...
 
Mantid::API::MatrixWorkspace_sptr singleValueWS (const double val)
 
Mantid::API::MatrixWorkspace_sptr weightedMean (Mantid::API::MatrixWorkspace_sptr &inOne, Mantid::API::MatrixWorkspace_sptr &inTwo)
 Calculate the weighted mean. More...
 

Private Attributes

double m_errorScaleFactor
 
SpecialTypeIndexes m_infDxIndexes
 
SpecialTypeIndexes m_infEIndexes
 Index per workspace spectra of Infs. More...
 
SpecialTypeIndexes m_infYIndexes
 
SpecialTypeIndexes m_nanDxIndexes
 
SpecialTypeIndexes m_nanEIndexes
 Index per workspace spectra of Nans. More...
 
SpecialTypeIndexes m_nanYIndexes
 
double m_scaleFactor
 Scaling factors. More...
 

Static Private Attributes

static const double range_tolerance = 1e-9
 Range tolerance. 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 PropertygetPointerToPropertyOrdinal (const int &index) const =0
 Get a property by an index. More...
 
template<typename 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< AlgorithmHistorym_history
 Pointer to the history for the algorithm being executed. More...
 
Kernel::Logger m_log
 Logger for this algorithm. More...
 
Kernel::Loggerg_log
 
std::shared_ptr< AlgorithmHistorym_parentHistory
 Pointer to the parent history object (if set) More...
 
std::vector< WorkspaceVectorm_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

Stitch1D : Stitches two Matrix Workspaces together into a single output.

Definition at line 20 of file Stitch1D.h.

Member Typedef Documentation

◆ SpecialTypeIndexes

using Mantid::Algorithms::Stitch1D::SpecialTypeIndexes = std::vector<std::vector<size_t> >
private

Helper typedef.

For storing indexes of special values per spectra per workspace.

Definition at line 39 of file Stitch1D.h.

Member Function Documentation

◆ category()

const std::string Mantid::Algorithms::Stitch1D::category ( ) const
inlineoverridevirtual

Algorithm's category for identification.

See also
Algorithm::category

Implements Mantid::API::IAlgorithm.

Definition at line 27 of file Stitch1D.h.

◆ conjoinXAxis()

MatrixWorkspace_sptr Mantid::Algorithms::Stitch1D::conjoinXAxis ( Mantid::API::MatrixWorkspace_sptr inOne,
Mantid::API::MatrixWorkspace_sptr inTwo 
)
private

Conjoin x axis.

Runs the ConjoinXRuns Algorithm as a child.

Parameters
inOne:: First input workspace
inTwo:: Second input workspace
Returns
A shared pointer to the resulting MatrixWorkspace

Definition at line 384 of file Stitch1D.cpp.

References Mantid::API::Algorithm::createChildAlgorithm(), and Mantid::Kernel::SingletonHolder< T >::Instance().

Referenced by exec().

◆ exec()

void Mantid::Algorithms::Stitch1D::exec ( )
overrideprivatevirtual

◆ findStartEndIndexes()

boost::tuple< int, int > Mantid::Algorithms::Stitch1D::findStartEndIndexes ( double  startOverlap,
double  endOverlap,
Mantid::API::MatrixWorkspace_sptr workspace 
)
private

Find the start and end indexes.

Finds the bins containing the ends of the overlapping region.

Parameters
startOverlap:: The start of the overlapping region
endOverlap:: The end of the overlapping region
workspace:: The workspace to determine the overlaps inside
Returns
a boost::tuple<int,int> containing the bin indexes of the overlaps

Definition at line 404 of file Stitch1D.cpp.

References workspace.

Referenced by exec().

◆ getEndOverlap()

double Mantid::Algorithms::Stitch1D::getEndOverlap ( const double  intesectionMin,
const double  intesectionMax 
) const
private

Get the end overlap.

Gets the end of the overlapping region.

Parameters
intesectionMin:: The minimum possible value for the overlapping region to inhabit
intesectionMax:: The maximum possible value for the overlapping region to inhabit
Returns
a double contianing the end of the overlapping region

Definition at line 213 of file Stitch1D.cpp.

References Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), Mantid::Kernel::Logger::information(), Mantid::Kernel::Property::isDefault(), range_tolerance, and Mantid::Kernel::Logger::warning().

Referenced by exec().

◆ getRebinParams()

std::vector< double > Mantid::Algorithms::Stitch1D::getRebinParams ( Mantid::API::MatrixWorkspace_const_sptr lhsWS,
Mantid::API::MatrixWorkspace_const_sptr rhsWS,
const bool  scaleRHS 
) const
private

Get the rebin parameters.

Gets the rebinning parameters and calculates any missing values.

Parameters
lhsWS:: The left hand side input workspace
rhsWS:: The right hand side input workspace
scaleRHS:: Scale the right hand side workspace
Returns
a vector<double> contianing the rebinning parameters

Definition at line 241 of file Stitch1D.cpp.

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

Referenced by exec().

◆ getStartOverlap()

double Mantid::Algorithms::Stitch1D::getStartOverlap ( const double  intesectionMin,
const double  intesectionMax 
) const
private

Get the start overlap.

Gets the start of the overlapping region.

Parameters
intesectionMin:: The minimum possible value for the overlapping region to inhabit
intesectionMax:: The maximum possible value for the overlapping region to inhabit
Returns
a double contianing the start of the overlapping region

Definition at line 184 of file Stitch1D.cpp.

References Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), Mantid::Kernel::Logger::information(), Mantid::Kernel::Property::isDefault(), range_tolerance, and Mantid::Kernel::Logger::warning().

Referenced by exec().

◆ hasNonzeroErrors()

bool Mantid::Algorithms::Stitch1D::hasNonzeroErrors ( Mantid::API::MatrixWorkspace_sptr ws)

Does the x-axis have non-zero errors.

Determines if a workspace has non zero errors.

Parameters
ws:: The input workspace
Returns
True if there are any non-zero errors in the workspace

Definition at line 421 of file Stitch1D.cpp.

References PARALLEL_CHECK_INTERRUPT_REGION, PARALLEL_CRITICAL, PARALLEL_END_INTERRUPT_REGION, PARALLEL_FOR_IF, PARALLEL_START_INTERRUPT_REGION, and Mantid::Kernel::threadSafe().

Referenced by exec().

◆ init()

void Mantid::Algorithms::Stitch1D::init ( )
overrideprivatevirtual

Overwrites Algorithm method.

Initialize the algorithm's properties.

Implements Mantid::API::Algorithm.

Definition at line 118 of file Stitch1D.cpp.

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

◆ integration()

MatrixWorkspace_sptr Mantid::Algorithms::Stitch1D::integration ( Mantid::API::MatrixWorkspace_sptr input,
const double  start,
const double  stop 
)
private

Perform integration.

Runs the Integration Algorithm as a child.

Parameters
input:: The input workspace
start:: a double defining the start of the region to integrate
stop:: a double defining the end of the region to integrate
Returns
A shared pointer to the resulting MatrixWorkspace

Definition at line 353 of file Stitch1D.cpp.

References Mantid::API::Algorithm::createChildAlgorithm(), Mantid::API::Algorithm::g_log, Mantid::Kernel::Logger::information(), and integration().

Referenced by exec(), and integration().

◆ maskAllBut()

MatrixWorkspace_sptr Mantid::Algorithms::Stitch1D::maskAllBut ( int  a1,
int  a2,
Mantid::API::MatrixWorkspace_sptr source 
)
private

Mask out everything but the data in the ranges.

Zero out all y and e data that is not in the region a1 to a2.

Parameters
a1: Zero based bin index (first one)
a2: Zero based bin index (last one inclusive)
source: Workspace providing the source data.

Definition at line 61 of file Stitch1D.cpp.

References PARALLEL_CHECK_INTERRUPT_REGION, PARALLEL_END_INTERRUPT_REGION, PARALLEL_FOR_IF, PARALLEL_START_INTERRUPT_REGION, and Mantid::Kernel::threadSafe().

Referenced by exec().

◆ maskInPlace()

void Mantid::Algorithms::Stitch1D::maskInPlace ( int  a1,
int  a2,
Mantid::API::MatrixWorkspace_sptr source 
)
private

Mask out everything but the data in the ranges, but do it inplace.

Mask out data in the region between a1 and a2 with zeros.

Operation performed on the original workspace

Parameters
a1: start position in X
a2: end position in X
source: Workspace to mask.
Returns
Masked workspace.

Definition at line 97 of file Stitch1D.cpp.

References PARALLEL_CHECK_INTERRUPT_REGION, PARALLEL_END_INTERRUPT_REGION, PARALLEL_FOR_IF, PARALLEL_START_INTERRUPT_REGION, and Mantid::Kernel::threadSafe().

Referenced by exec().

◆ name()

const std::string Mantid::Algorithms::Stitch1D::name ( ) const
inlineoverridevirtual

Algorithm's name for identification.

See also
Algorithm::name

Implements Mantid::API::Algorithm.

Definition at line 23 of file Stitch1D.h.

◆ rebin()

MatrixWorkspace_sptr Mantid::Algorithms::Stitch1D::rebin ( Mantid::API::MatrixWorkspace_sptr input,
const std::vector< double > &  params 
)
private

Perform rebin.

Runs the Rebin Algorithm as a child and replaces special values.

Parameters
input:: The input workspace
params:: a vector<double> containing rebinning parameters
Returns
A shared pointer to the resulting MatrixWorkspace

Definition at line 295 of file Stitch1D.cpp.

References Mantid::API::Algorithm::createChildAlgorithm(), Mantid::API::Algorithm::g_log, Mantid::Kernel::Logger::information(), m_infEIndexes, m_infYIndexes, m_nanEIndexes, m_nanYIndexes, PARALLEL_CHECK_INTERRUPT_REGION, PARALLEL_END_INTERRUPT_REGION, PARALLEL_FOR_IF, PARALLEL_START_INTERRUPT_REGION, rebin(), Mantid::Kernel::threadSafe(), and value.

Referenced by exec(), and rebin().

◆ reinsertSpecialValues()

void Mantid::Algorithms::Stitch1D::reinsertSpecialValues ( const Mantid::API::MatrixWorkspace_sptr ws)
private

Add back in any special values.

Put special values back.

Parameters
ws: MatrixWorkspace to resinsert special values into.

Definition at line 592 of file Stitch1D.cpp.

References m_infEIndexes, m_infYIndexes, m_nanEIndexes, m_nanYIndexes, PARALLEL_CHECK_INTERRUPT_REGION, PARALLEL_END_INTERRUPT_REGION, PARALLEL_FOR_IF, PARALLEL_START_INTERRUPT_REGION, and Mantid::Kernel::threadSafe().

Referenced by exec().

◆ scaleWorkspace()

void Mantid::Algorithms::Stitch1D::scaleWorkspace ( API::MatrixWorkspace_sptr ws,
API::MatrixWorkspace_sptr scaleFactorWS,
API::MatrixWorkspace_const_sptr dxWS 
)
private

Scale workspace (left hand side or right hand side)

scaleWorkspace will set m_scaleFactor and m_errorScaleFactor

Parameters
ws:: Input workspace
scaleFactorWS:: A MatrixWorkspace holding the scaling factor
dxWS:: A MatrixWorkspace (size of ws) containing Dx values

Definition at line 450 of file Stitch1D.cpp.

References Mantid::API::Algorithm::g_log, m_errorScaleFactor, m_scaleFactor, and Mantid::Kernel::Logger::warning().

Referenced by exec().

◆ seeAlso()

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

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

Implements Mantid::API::IAlgorithm.

Definition at line 30 of file Stitch1D.h.

◆ singleValueWS()

Mantid::API::MatrixWorkspace_sptr Mantid::Algorithms::Stitch1D::singleValueWS ( const double  val)
private

◆ summary()

const std::string Mantid::Algorithms::Stitch1D::summary ( ) const
inlineoverridevirtual

Summary of algorithm's purpose.

Implements Mantid::API::Algorithm.

Definition at line 29 of file Stitch1D.h.

◆ validateInputs()

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

Cross-check properties with each other.

Validate the algorithm's properties.

See also
IAlgorithm::validateInputs
Returns
A map of property names and their issues.

Implements Mantid::API::IAlgorithm.

Definition at line 152 of file Stitch1D.cpp.

References Mantid::Algorithms::RunCombinationHelper::checkCompatibility(), Mantid::API::Algorithm::getProperty(), rhs, and Mantid::Algorithms::RunCombinationHelper::setReferenceProperties().

◆ version()

int Mantid::Algorithms::Stitch1D::version ( ) const
inlineoverridevirtual

Algorithm's version for identification.

See also
Algorithm::version

Implements Mantid::API::Algorithm.

Definition at line 25 of file Stitch1D.h.

◆ weightedMean()

MatrixWorkspace_sptr Mantid::Algorithms::Stitch1D::weightedMean ( Mantid::API::MatrixWorkspace_sptr inOne,
Mantid::API::MatrixWorkspace_sptr inTwo 
)
private

Calculate the weighted mean.

Runs the WeightedMean Algorithm as a child.

Parameters
inOne:: The first input workspace
inTwo:: The second input workspace
Returns
A shared pointer to the resulting MatrixWorkspace

Definition at line 370 of file Stitch1D.cpp.

References Mantid::API::Algorithm::createChildAlgorithm(), and weightedMean().

Referenced by exec(), and weightedMean().

Member Data Documentation

◆ m_errorScaleFactor

double Mantid::Algorithms::Stitch1D::m_errorScaleFactor
private

Definition at line 77 of file Stitch1D.h.

Referenced by exec(), and scaleWorkspace().

◆ m_infDxIndexes

SpecialTypeIndexes Mantid::Algorithms::Stitch1D::m_infDxIndexes
private

Definition at line 88 of file Stitch1D.h.

◆ m_infEIndexes

SpecialTypeIndexes Mantid::Algorithms::Stitch1D::m_infEIndexes
private

Index per workspace spectra of Infs.

Definition at line 86 of file Stitch1D.h.

Referenced by exec(), rebin(), and reinsertSpecialValues().

◆ m_infYIndexes

SpecialTypeIndexes Mantid::Algorithms::Stitch1D::m_infYIndexes
private

Definition at line 87 of file Stitch1D.h.

Referenced by exec(), rebin(), and reinsertSpecialValues().

◆ m_nanDxIndexes

SpecialTypeIndexes Mantid::Algorithms::Stitch1D::m_nanDxIndexes
private

Definition at line 84 of file Stitch1D.h.

◆ m_nanEIndexes

SpecialTypeIndexes Mantid::Algorithms::Stitch1D::m_nanEIndexes
private

Index per workspace spectra of Nans.

Definition at line 82 of file Stitch1D.h.

Referenced by exec(), rebin(), and reinsertSpecialValues().

◆ m_nanYIndexes

SpecialTypeIndexes Mantid::Algorithms::Stitch1D::m_nanYIndexes
private

Definition at line 83 of file Stitch1D.h.

Referenced by exec(), rebin(), and reinsertSpecialValues().

◆ m_scaleFactor

double Mantid::Algorithms::Stitch1D::m_scaleFactor
private

Scaling factors.

Definition at line 76 of file Stitch1D.h.

Referenced by exec(), and scaleWorkspace().

◆ range_tolerance

const double Mantid::Algorithms::Stitch1D::range_tolerance = 1e-9
staticprivate

Range tolerance.

Range tolerance This is required for machine precision reasons.

Used to adjust StartOverlap and EndOverlap so that they are inclusive of bin boundaries if they are sitting ontop of the bin boundaries.

Definition at line 74 of file Stitch1D.h.

Referenced by getEndOverlap(), and getStartOverlap().


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