This is a Python binding to the C++ class Mantid::API::DataProcessorAlgorithm.
bases: mantid.api.Algorithm
Base class workflow-type algorithms
Return the aliases for the algorithm
If an MPI build, assemble the partial workspaces from all MPI processes. Otherwise, simply returns the input workspace
Request that the algorithm stop running
Returns the list of categories this algorithm belongs to
Returns the category containing the algorithm
Copy properties from another algorithm
Creates and intializes a named child algorithm. Output workspaces are given a dummy name.
Return a TableWorkspace containing the information on how to split the input file when processing in chunks
Returns a doc string for the algorithm
Turns history recording on or off for an algorithm.
Runs the algorithm and returns whether it has been successful
Starts the algorithm in a separate thread and returns immediately
Returns whether a property exists
Initialize the algorithm from a string representation
Returns the property of the given name. Use .value to give the value. If property with given name does not exist, returns given default value.
Returns true if logging of start and end messages
Returns a unique identifier for this algorithm object
Returns a reference to this algorithm’s logger
Returns the number of running MPI processes in an MPI build or 1 for a non-MPI build
Returns the optional user message attached to the algorithm
Returns the named property manager from the service or creates a new one if it does not exist
Returns the list of properties managed by this object
Returns the property of the given name. Use .value to give the value
Returns a string representation of the named property’s value
Returns the summary found on the wiki page
Returns whether a property exists
Returns optional URL for algorithm documentation
Initializes the algorithm
Returns a list of the inout properties on the algorithm
Returns True if the algorithm has been marked to run as a child. If True then Output workspaces are NOT stored in the Analysis Data Service but must be retrieved from the property.
Returns True if the algorithm has been executed successfully, False otherwise
Returns True if the algorithm is initialized, False otherwise
Returns True if the algorithm’s logger is turned on, False otherwise
Returns true if this algorithm is the main thread for an MPI build. For non-MPI build it always returns true
Returns True if the algorithm is considered to be running, False otherwise
Loads the given file or workspace data and returns the workspace. If loadQuiet=True then output is not stored in the AnalysisDataService.
Load a chunk of data
Returns a reference to this algorithm’s logger
Returns a list of input and in/out property names that is ordered such that the mandatory properties are first followed by the optional ones.
Returns the name of the algorithm
Return a list of input, in/out and output properties such that the mandatory properties are first followed by the optional ones.
Returns a list of the output properties on the algorithm
Returns the number of properties being managed
Save a workspace as a nexus file. If this is an MPI build then saving only happens for the main thread.
Returns the list of similar algorithms
Set the name of the algorithm called to accumulate a chunk of processed data [Default=Plus]
If true then allow logging of start and end messages
If true then even child algorithms will have their workspaces stored in the ADS.
If true this algorithm is run as a child algorithm. There will be no logging and nothing is stored in the Analysis Data Service
Set the name of the algorithm called using the load() method [Default=Load]
Set the name of the file property for the load algorithm when using the load() method [Default=Filename]
Toggle logging on/off.
Set a collection of properties from a dict
Set the value of the named property
Set the group for a given property
Assign the given IPropertySettings object to the named property
Set the value of the named property via a string
To query whether an algorithm should rethrow exceptions when executing.
(Deprecated.) Set summary for the help.
Returns a summary message describing the algorithm
Cross-check all inputs and return any errors as a dictionary
Returns the list of properties managed by this object
Returns the version number of the algorithm
Returns the name of the input workspace property used by the calling object
Returns a name that will be used when attached as a workspace method. Empty string indicates do not attach
Returns a set of class names that will have the method attached. Empty list indicates all types