Mantid
|
Abstract Algorithm class that will be used by: BinMD and SliceMD and shares code for getting a slice from one workspace to another. More...
#include <SlicingAlgorithm.h>
Public Member Functions | |
SlicingAlgorithm () | |
Constructor. 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... | |
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::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::string | name () const override=0 |
function to return a name of the algorithm, must be overridden in all algorithms More... | |
int | version () const override=0 |
function to return a version of the algorithm, must be overridden in all algorithms More... | |
const std::string | summary () const override=0 |
function returns a summary message that will be displayed in the default GUI, and in the help. 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 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 |
Static Public Member Functions | |
static std::string | getDimensionChars () |
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... | |
Protected Member Functions | |
void | createAlignedTransform () |
Using the parameters, create a coordinate transformation for aligned cuts. More... | |
void | createGeneralTransform () |
Loads the dimensions and create the coordinate transform, using the inputs. More... | |
void | createTransform () |
Read the algorithm properties and creates the appropriate transforms for slicing the MDEventWorkspace. More... | |
std::unique_ptr< Mantid::Geometry::MDImplicitFunction > | getGeneralImplicitFunction (const size_t *const chunkMin, const size_t *const chunkMax) |
Create an implicit function for picking boxes, based on the indexes in the output MDHistoWorkspace. More... | |
std::unique_ptr< Mantid::Geometry::MDImplicitFunction > | getImplicitFunctionForChunk (const size_t *const chunkMin, const size_t *const chunkMax) |
Create an implicit function for picking boxes, based on the indexes in the output MDHistoWorkspace. More... | |
void | initSlicingProps () |
Initialise the properties. More... | |
void | makeAlignedDimensionFromString (const std::string &str) |
Generate a MDHistoDimension_sptr from a comma-sep string (for AlignedDim0, etc.) Must be called in order X,Y,Z,T. More... | |
void | makeBasisVectorFromString (const std::string &str) |
Generate the MDHistoDimension and basis vector for a given string from BasisVector0 etc. More... | |
void | processGeneralTransformProperties () |
Reads the various Properties for the general (non-aligned) case and fills in members on the Algorithm for later use. More... | |
~SlicingAlgorithm ()=default | |
Protected Member Functions inherited from Mantid::API::Algorithm | |
virtual void | init ()=0 |
Virtual method - must be overridden by concrete algorithm. More... | |
virtual void | exec ()=0 |
Virtual method - must be overridden by concrete algorithm. More... | |
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 |
Protected Attributes | |
bool | m_axisAligned |
Set to true if the cut is aligned with the axes. More... | |
std::vector< Mantid::Kernel::VMD > | m_bases |
Basis vectors of the output dimensions, normalized to unity length. More... | |
std::vector< Mantid::Geometry::MDHistoDimension_sptr > | m_binDimensions |
Bin dimensions to actually use. More... | |
std::vector< double > | m_binningScaling |
Scaling factor to apply for each basis vector (to map to the bins). More... | |
std::vector< size_t > | m_dimensionToBinFrom |
Index of the dimension in the MDEW for the dimension in the output. More... | |
Mantid::Kernel::VMD | m_inputMinPoint |
Coordinates in the INPUT workspace corresponding to the minimum edge in all dimensions. More... | |
Mantid::API::IMDWorkspace_sptr | m_intermediateWS |
Intermediate original workspace. More... | |
Mantid::API::IMDWorkspace_sptr | m_inWS |
Input workspace. More... | |
std::vector< double > | m_maxExtents |
For non-aligned, the maximum coordinate extents in each OUTPUT dimension. More... | |
std::vector< double > | m_minExtents |
For non-aligned, the minimum coordinate extents in each OUTPUT dimension. More... | |
bool | m_NormalizeBasisVectors |
The NormalizeBasisVectors option. More... | |
std::vector< int > | m_numBins |
For non-aligned, the number of bins in each OUTPUT dimension. More... | |
Mantid::API::IMDWorkspace_sptr | m_originalWS |
Original (MDEventWorkspace) that inWS was based on. More... | |
size_t | m_outD |
Number of dimensions in the output (binned) workspace. More... | |
std::unique_ptr< API::CoordTransform > | m_transform |
Coordinate transformation to apply. More... | |
std::unique_ptr< DataObjects::CoordTransformAffine > | m_transformFromIntermediate |
Coordinate transformation to save in the output WS, from the intermediate WS. More... | |
std::unique_ptr< API::CoordTransform > | m_transformFromOriginal |
Coordinate transformation to save in the output workspace (original->binned) More... | |
std::vector< double > | m_transformScaling |
Scaling factor to apply for each basis vector to transfor to the output dimensions. More... | |
std::unique_ptr< DataObjects::CoordTransformAffine > | m_transformToIntermediate |
Coordinate transformation to save in the intermediate WS. More... | |
std::unique_ptr< API::CoordTransform > | m_transformToOriginal |
Coordinate transformation to save in the output workspace (binned->original) More... | |
Mantid::Kernel::VMD | m_translation |
Translation from the OUTPUT to the INPUT workspace i.e. 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... | |
Private Member Functions | |
Mantid::Geometry::MDFrame_uptr | createMDFrameForNonAxisAligned (const std::string &units, const Mantid::Kernel::VMD &basisVector) const |
Create an MDFrame for the Non-Axis-Aligned case. More... | |
Mantid::Geometry::MDFrame_uptr | extractMDFrameForNonAxisAligned (std::vector< size_t > indicesWithProjection, const std::string &units) const |
Extract the MDFrame. More... | |
std::vector< size_t > | getIndicesWithProjection (const Mantid::Kernel::VMD &basisVector, const std::vector< Mantid::Kernel::VMD > &oldBasis) const |
Get indices which have a projection contribution. More... | |
std::vector< Mantid::Kernel::VMD > | getOldBasis (size_t dimension) const |
bool | isProjectingOnFrame (const Mantid::Kernel::VMD &oldVector, const Mantid::Kernel::VMD &basisVector) const |
Check if the two vectors are orthogonal or not. More... | |
void | setTargetUnits (Mantid::Geometry::MDFrame_uptr &frame, const std::string &units) const |
Additional Inherited Members | |
Public Types inherited from Mantid::API::Algorithm | |
using | WorkspaceVector = std::vector< std::shared_ptr< Workspace > > |
Public Attributes inherited from Mantid::API::Algorithm | |
bool | calledByAlias = false |
Flag to indicate if the algorithm is called by its alias. More... | |
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... | |
Static Protected Attributes inherited from Mantid::API::Algorithm | |
static size_t | g_execCount = 0 |
Counter to keep track of algorithm execution order. More... | |
Abstract Algorithm class that will be used by: BinMD and SliceMD and shares code for getting a slice from one workspace to another.
Definition at line 33 of file SlicingAlgorithm.h.
Mantid::MDAlgorithms::SlicingAlgorithm::SlicingAlgorithm | ( | ) |
Constructor.
Definition at line 33 of file SlicingAlgorithm.cpp.
|
protecteddefault |
|
protected |
Using the parameters, create a coordinate transformation for aligned cuts.
Definition at line 491 of file SlicingAlgorithm.cpp.
References Mantid::Geometry::d, Mantid::API::Algorithm::g_log, getDimensionChars(), Mantid::API::Algorithm::getPropertyValue(), Mantid::Kernel::Matrix< T >::Invert(), m_bases, m_binDimensions, m_dimensionToBinFrom, m_inWS, m_outD, m_transform, m_transformFromOriginal, m_transformToOriginal, m_translation, makeAlignedDimensionFromString(), Mantid::Kernel::Strings::strip(), tmp, and Mantid::Kernel::Logger::warning().
Referenced by createTransform().
|
protected |
Loads the dimensions and create the coordinate transform, using the inputs.
This is for the general (i.e. non-aligned) case
Definition at line 338 of file SlicingAlgorithm.cpp.
References Mantid::API::CoordTransform::applyVMD(), Mantid::Geometry::d, Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), Mantid::Kernel::Logger::information(), m_bases, m_binDimensions, m_binningScaling, m_inputMinPoint, m_inWS, m_originalWS, m_outD, m_transform, m_transformFromOriginal, m_transformScaling, m_transformToOriginal, m_translation, Mantid::Kernel::VMDBase< VMD_t >::makeVectorsOrthogonal(), processGeneralTransformProperties(), and Mantid::DataObjects::CoordTransformAffine::setMatrix().
Referenced by createTransform().
|
private |
Create an MDFrame for the Non-Axis-Aligned case.
Make sure that MDFrames onto which the basis vector projects are not mixed, e.g. no mixing of HKL and GenerFrame
units | the units |
basisVector | the basis vector |
Definition at line 838 of file SlicingAlgorithm.cpp.
References extractMDFrameForNonAxisAligned(), getIndicesWithProjection(), getOldBasis(), and m_inWS.
Referenced by makeBasisVectorFromString().
|
protected |
Read the algorithm properties and creates the appropriate transforms for slicing the MDEventWorkspace.
NOTE: The m_inWS member must be set first. If the workspace is based on another, e.g. result from BinMD, m_inWS will be modified to be the original workspace and the transformations will be altered to match.
The m_transform, m_transformFromOriginal and m_transformToOriginal transforms will be set.
Definition at line 583 of file SlicingAlgorithm.cpp.
References createAlignedTransform(), createGeneralTransform(), Mantid::API::Algorithm::g_log, Mantid::API::LogManager::getProperty(), Mantid::API::Algorithm::getProperty(), Mantid::API::LogManager::hasProperty(), Mantid::Kernel::Matrix< T >::Invert(), m_axisAligned, m_intermediateWS, m_inWS, m_originalWS, m_transform, m_transformFromIntermediate, m_transformToIntermediate, m_transformToOriginal, Mantid::API::CoordTransform::makeAffineMatrix(), Mantid::API::Algorithm::name(), Mantid::Kernel::Logger::notice(), and Mantid::Kernel::Property::value().
Referenced by Mantid::MDAlgorithms::BinMD::exec(), and Mantid::MDAlgorithms::SliceMD::exec().
|
private |
Extract the MDFrame.
Make sure that all MDFrames are compatible – if not throw
indicesWithProjection | list of indices of dimensions which have a projection |
units | the units |
Definition at line 896 of file SlicingAlgorithm.cpp.
References Mantid::API::Algorithm::g_log, index, m_inWS, setTargetUnits(), and Mantid::Kernel::Logger::warning().
Referenced by createMDFrameForNonAxisAligned().
|
inlinestatic |
Definition at line 39 of file SlicingAlgorithm.h.
Referenced by createAlignedTransform(), Mantid::MDAlgorithms::MDNormDirectSC::init(), Mantid::MDAlgorithms::MDNormSCD::init(), initSlicingProps(), and processGeneralTransformProperties().
|
protected |
Create an implicit function for picking boxes, based on the indexes in the output MDHistoWorkspace.
This needs to be in the space of the INPUT MDEventWorkspace.
In the most general case, this function assumes ORTHOGONAL BASIS VECTORS! However, in the case of N dimensions with N or N-1 bases then non-orthogonal basis vectors are allowed.
chunkMin | :: the minimum index in each dimension to consider "valid" (inclusive). NULL to use the entire range. |
chunkMax | :: the maximum index in each dimension to consider "valid" (exclusive) NULL to use the entire range. |
Definition at line 698 of file SlicingAlgorithm.cpp.
References Mantid::Geometry::d, Mantid::API::Algorithm::g_log, Mantid::Kernel::VMDBase< VMD_t >::getNormalVector(), m_bases, m_binDimensions, m_inWS, m_translation, Mantid::Kernel::VMDBase< TYPE >::size(), std::to_string(), Mantid::Kernel::Logger::warning(), and Mantid::Geometry::x.
Referenced by getImplicitFunctionForChunk().
|
protected |
Create an implicit function for picking boxes, based on the indexes in the output MDHistoWorkspace.
This needs to be in the space of the INPUT MDEventWorkspace
chunkMin | :: the minimum index in each dimension to consider "valid" (inclusive). NULL to use the entire range. |
chunkMax | :: the maximum index in each dimension to consider "valid" (exclusive) NULL to use the entire range. |
Definition at line 804 of file SlicingAlgorithm.cpp.
References Mantid::Geometry::d, getGeneralImplicitFunction(), m_axisAligned, m_binDimensions, m_dimensionToBinFrom, m_inWS, and m_outD.
Referenced by Mantid::MDAlgorithms::BinMD::binByIterating(), and Mantid::MDAlgorithms::SliceMD::slice().
|
private |
Get indices which have a projection contribution.
basisVector | the vector under investigation |
oldBasis | the old basis vectors |
Definition at line 877 of file SlicingAlgorithm.cpp.
References index, and isProjectingOnFrame().
Referenced by createMDFrameForNonAxisAligned().
|
private |
Definition at line 850 of file SlicingAlgorithm.cpp.
Referenced by createMDFrameForNonAxisAligned().
|
protected |
Initialise the properties.
Initialize the algorithm's properties.
Definition at line 40 of file SlicingAlgorithm.cpp.
References Mantid::API::Algorithm::declareProperty(), getDimensionChars(), Mantid::Kernel::Direction::Input, Mantid::Kernel::IS_EQUAL_TO, Mantid::Kernel::IPropertyManager::setPropertyGroup(), Mantid::Kernel::IPropertyManager::setPropertySettings(), and Mantid::Kernel::Strings::toString().
Referenced by Mantid::MDAlgorithms::BinMD::init().
|
private |
Check if the two vectors are orthogonal or not.
oldVector | the old vector |
basisVector | the vector under investigation |
Definition at line 866 of file SlicingAlgorithm.cpp.
References Mantid::Kernel::VMDBase< TYPE >::scalar_prod().
Referenced by getIndicesWithProjection().
|
protected |
Generate a MDHistoDimension_sptr from a comma-sep string (for AlignedDim0, etc.) Must be called in order X,Y,Z,T.
str | :: name,minimum,maximum,number_of_bins |
Definition at line 415 of file SlicingAlgorithm.cpp.
References Mantid::Kernel::Strings::convert(), m_binDimensions, m_dimensionToBinFrom, m_inWS, n, Mantid::API::Algorithm::name(), and Mantid::Kernel::Strings::strip().
Referenced by createAlignedTransform().
|
protected |
Generate the MDHistoDimension and basis vector for a given string from BasisVector0 etc.
If the workspace being binned has an original workspace, then the vector is transformed to THOSE coordinates.
"Format: 'name, units, x,y,z,..'.\n" Adds values to m_bases, m_binDimensions, m_binningScaling and m_transformScaling
str | :: name,number_of_bins |
Definition at line 135 of file SlicingAlgorithm.cpp.
References Mantid::API::CoordTransform::applyVMD(), Mantid::Kernel::Strings::convert(), createMDFrameForNonAxisAligned(), Mantid::Geometry::d, m_bases, m_binDimensions, m_binningScaling, m_inWS, m_maxExtents, m_minExtents, m_NormalizeBasisVectors, m_numBins, m_originalWS, m_transformScaling, n, Mantid::API::Algorithm::name(), Mantid::Kernel::VMDBase< TYPE >::norm(), Mantid::Kernel::VMDBase< TYPE >::normalize(), Mantid::Kernel::Strings::strip(), and Mantid::Kernel::Strings::toString().
Referenced by processGeneralTransformProperties().
|
protected |
Reads the various Properties for the general (non-aligned) case and fills in members on the Algorithm for later use.
if | some of the inputs are invalid |
Definition at line 261 of file SlicingAlgorithm.cpp.
References Mantid::Geometry::d, getDimensionChars(), Mantid::Kernel::VMDBase< TYPE >::getNumDims(), Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::getPropertyValue(), m_binDimensions, m_binningScaling, m_inWS, m_maxExtents, m_minExtents, m_NormalizeBasisVectors, m_numBins, m_outD, m_transformScaling, m_translation, makeBasisVectorFromString(), Mantid::Kernel::Strings::strip(), and Mantid::Kernel::Strings::toString().
Referenced by createGeneralTransform().
|
private |
Definition at line 924 of file SlicingAlgorithm.cpp.
Referenced by extractMDFrameForNonAxisAligned().
|
protected |
Set to true if the cut is aligned with the axes.
Definition at line 97 of file SlicingAlgorithm.h.
Referenced by createTransform(), and getImplicitFunctionForChunk().
|
protected |
Basis vectors of the output dimensions, normalized to unity length.
Definition at line 103 of file SlicingAlgorithm.h.
Referenced by createAlignedTransform(), createGeneralTransform(), Mantid::MDAlgorithms::BinMD::exec(), getGeneralImplicitFunction(), and makeBasisVectorFromString().
|
protected |
Bin dimensions to actually use.
These are NEW dimensions created, or copied (not pointing to) the original workspace.
Definition at line 69 of file SlicingAlgorithm.h.
Referenced by Mantid::MDAlgorithms::BinMD::binByIterating(), createAlignedTransform(), createGeneralTransform(), Mantid::MDAlgorithms::BinMD::exec(), getGeneralImplicitFunction(), getImplicitFunctionForChunk(), makeAlignedDimensionFromString(), makeBasisVectorFromString(), processGeneralTransformProperties(), and Mantid::MDAlgorithms::SliceMD::slice().
|
protected |
Scaling factor to apply for each basis vector (to map to the bins).
i.e.. MULTIPLY the distance in the INPUT workspace by this = an index into the bin
Definition at line 108 of file SlicingAlgorithm.h.
Referenced by createGeneralTransform(), makeBasisVectorFromString(), and processGeneralTransformProperties().
|
protected |
Index of the dimension in the MDEW for the dimension in the output.
Only for axis-aligned slices
Definition at line 73 of file SlicingAlgorithm.h.
Referenced by createAlignedTransform(), getImplicitFunctionForChunk(), and makeAlignedDimensionFromString().
|
protected |
Coordinates in the INPUT workspace corresponding to the minimum edge in all dimensions.
Definition at line 122 of file SlicingAlgorithm.h.
Referenced by createGeneralTransform().
|
protected |
Intermediate original workspace.
Output -> intermediate (MDHisto) -> original (MDEvent)
Definition at line 89 of file SlicingAlgorithm.h.
Referenced by createTransform(), and Mantid::MDAlgorithms::BinMD::exec().
|
protected |
Input workspace.
Definition at line 61 of file SlicingAlgorithm.h.
Referenced by createAlignedTransform(), createGeneralTransform(), createMDFrameForNonAxisAligned(), createTransform(), Mantid::MDAlgorithms::BinMD::exec(), Mantid::MDAlgorithms::SliceMD::exec(), extractMDFrameForNonAxisAligned(), getGeneralImplicitFunction(), getImplicitFunctionForChunk(), makeAlignedDimensionFromString(), makeBasisVectorFromString(), and processGeneralTransformProperties().
|
protected |
For non-aligned, the maximum coordinate extents in each OUTPUT dimension.
Definition at line 128 of file SlicingAlgorithm.h.
Referenced by makeBasisVectorFromString(), and processGeneralTransformProperties().
|
protected |
For non-aligned, the minimum coordinate extents in each OUTPUT dimension.
Definition at line 125 of file SlicingAlgorithm.h.
Referenced by makeBasisVectorFromString(), and processGeneralTransformProperties().
|
protected |
The NormalizeBasisVectors option.
Definition at line 134 of file SlicingAlgorithm.h.
Referenced by makeBasisVectorFromString(), and processGeneralTransformProperties().
|
protected |
For non-aligned, the number of bins in each OUTPUT dimension.
Definition at line 131 of file SlicingAlgorithm.h.
Referenced by makeBasisVectorFromString(), and processGeneralTransformProperties().
|
protected |
Original (MDEventWorkspace) that inWS was based on.
Used during basis vector constructor
Definition at line 65 of file SlicingAlgorithm.h.
Referenced by createGeneralTransform(), createTransform(), and makeBasisVectorFromString().
|
protected |
Number of dimensions in the output (binned) workspace.
Definition at line 100 of file SlicingAlgorithm.h.
Referenced by Mantid::MDAlgorithms::BinMD::binByIterating(), Mantid::MDAlgorithms::BinMD::binMDBox(), createAlignedTransform(), createGeneralTransform(), Mantid::MDAlgorithms::SliceMD::doExec(), getImplicitFunctionForChunk(), and processGeneralTransformProperties().
|
protected |
Coordinate transformation to apply.
This transformation contains the scaling that makes the output coordinate = bin indexes in the output MDHistoWorkspace.
Definition at line 78 of file SlicingAlgorithm.h.
Referenced by Mantid::MDAlgorithms::BinMD::binMDBox(), createAlignedTransform(), createGeneralTransform(), and createTransform().
|
protected |
Coordinate transformation to save in the output WS, from the intermediate WS.
Definition at line 92 of file SlicingAlgorithm.h.
Referenced by createTransform(), and Mantid::MDAlgorithms::BinMD::exec().
|
protected |
Coordinate transformation to save in the output workspace (original->binned)
Definition at line 82 of file SlicingAlgorithm.h.
Referenced by createAlignedTransform(), createGeneralTransform(), Mantid::MDAlgorithms::BinMD::exec(), and Mantid::MDAlgorithms::SliceMD::slice().
|
protected |
Scaling factor to apply for each basis vector to transfor to the output dimensions.
i.e.. MULTIPLY the distance in the INPUT workspace by this = a distance in the OUTPUT dimension
Definition at line 114 of file SlicingAlgorithm.h.
Referenced by createGeneralTransform(), makeBasisVectorFromString(), and processGeneralTransformProperties().
|
protected |
Coordinate transformation to save in the intermediate WS.
Definition at line 94 of file SlicingAlgorithm.h.
Referenced by createTransform(), and Mantid::MDAlgorithms::BinMD::exec().
|
protected |
Coordinate transformation to save in the output workspace (binned->original)
Definition at line 85 of file SlicingAlgorithm.h.
Referenced by createAlignedTransform(), createGeneralTransform(), createTransform(), and Mantid::MDAlgorithms::BinMD::exec().
|
protected |
Translation from the OUTPUT to the INPUT workspace i.e.
this position in the input workspace = 0,0,0 in the output.
Definition at line 118 of file SlicingAlgorithm.h.
Referenced by createAlignedTransform(), createGeneralTransform(), Mantid::MDAlgorithms::BinMD::exec(), getGeneralImplicitFunction(), and processGeneralTransformProperties().