Mantid
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Mantid::MDAlgorithms::MDNormDirectSC Class Reference

MDNormSCD : Generate MD normalization for single crystal diffraction. More...

#include <MDNormDirectSC.h>

Inheritance diagram for Mantid::MDAlgorithms::MDNormDirectSC:
Mantid::MDAlgorithms::SlicingAlgorithm Mantid::API::Algorithm Mantid::API::IAlgorithm Mantid::Kernel::IPropertyManager

Public Member Functions

const std::string category () const override
 Algorithm's category for identification. More...
 
 MDNormDirectSC ()
 Constructor. More...
 
const std::string name () const override
 Algorithm's name for use in the GUI and help. More...
 
const std::vector< std::string > seeAlso () const override
 Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm.A default implementation is provided. More...
 
const std::string summary () const override
 Algorithm's summary for use in the GUI and help. More...
 
int version () const override
 Algorithm's version for identification. More...
 
- Public Member Functions inherited from Mantid::MDAlgorithms::SlicingAlgorithm
 SlicingAlgorithm ()
 Constructor. 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::vector< std::string > categories () const override
 Function to return all of the categories that contain this algorithm. More...
 
const std::string categorySeparator () const override
 Function to return the separator token for the category string. More...
 
const std::string alias () const override
 function to return any aliases to the algorithm; A default implementation is provided More...
 
const std::string aliasDeprecated () const override
 Expiration date (in ISO8601 format) for the algorithm aliases; default implementation for no expiration date. More...
 
const std::string helpURL () const override
 function to return URL for algorithm documentation; A default implementation is provided. More...
 
template<typename T , typename = typename std::enable_if<std::is_convertible<T *, MatrixWorkspace *>::value>::type>
std::tuple< std::shared_ptr< T >, Indexing::SpectrumIndexSet > getWorkspaceAndIndices (const std::string &name) const
 
template<typename T1 , typename T2 , typename = typename std::enable_if<std::is_convertible<T1 *, MatrixWorkspace *>::value>::type, typename = typename std::enable_if<std::is_convertible<T2 *, std::string *>::value || std::is_convertible<T2 *, std::vector<int64_t> *>::value>::type>
void setWorkspaceInputProperties (const std::string &name, const std::shared_ptr< T1 > &wksp, IndexType type, const T2 &list)
 
template<typename T1 , typename T2 , typename = typename std::enable_if<std::is_convertible<T1 *, MatrixWorkspace *>::value>::type, typename = typename std::enable_if<std::is_convertible<T2 *, std::string *>::value || std::is_convertible<T2 *, std::vector<int64_t> *>::value>::type>
void setWorkspaceInputProperties (const std::string &name, const std::string &wsName, IndexType type, const T2 &list)
 
const std::string workspaceMethodName () const override
 
const std::vector< std::string > workspaceMethodOn () const override
 
const std::string workspaceMethodInputProperty () const override
 
AlgorithmID getAlgorithmID () const override
 Algorithm ID. More...
 
virtual void addObserver (const Poco::AbstractObserver &observer) const =0
 Add an observer for a notification. More...
 
virtual const std::string alias () const =0
 function to return any aliases of the algorithm. More...
 
virtual const std::string aliasDeprecated () const =0
 Expiration date (in ISO8601 format) for the algorithm aliases. Empty if no expiration date. More...
 
virtual void cancel ()=0
 Raises the cancel flag. More...
 
virtual const std::vector< std::string > categories () const =0
 Function to return all of the categories that contain this algorithm. More...
 
virtual const std::string category () const =0
 function to return a category of the algorithm. More...
 
virtual const std::string categorySeparator () const =0
 Function to return the separator token for the category string. More...
 
virtual void enableHistoryRecordingForChild (const bool on)=0
 If true history will be recorded for a child. More...
 
virtual bool execute ()=0
 System execution. More...
 
virtual void executeAsChildAlg ()=0
 Execute as a Child Algorithm, with try/catch. More...
 
virtual Poco::ActiveResult< bool > executeAsync ()=0
 Asynchronous execution of the algorithm. More...
 
virtual ExecutionState executionState () const =0
 Gets the current execution state. More...
 
virtual AlgorithmID getAlgorithmID () const =0
 Algorithm ID. More...
 
virtual bool getAlgStartupLogging () const =0
 get the state of Logging of start and end messages More...
 
virtual bool getAlwaysStoreInADS () const =0
 To query whether the output is stored in the analysis data service. More...
 
virtual int getLoggingOffset () const =0
 returns the logging priority offset More...
 
virtual const std::string helpURL () const =0
 function to return an optional URL for documentation. More...
 
virtual void initialize ()=0
 Initialization method invoked by the framework. More...
 
virtual bool isChild () const =0
 To query whether algorithm is a child. Default to false. More...
 
virtual bool isExecuted () const =0
 Check whether the algorithm has been executed sucessfully. More...
 
virtual bool isInitialized () const =0
 Check whether the algorithm is initialized properly. More...
 
virtual bool isLogging () const =0
 returns the status of logging, True = enabled More...
 
virtual bool isReadyForGarbageCollection () const =0
 True if the algorithm is ready for garbage collection. More...
 
virtual bool isRunning () const =0
 True if the algorithm is running. More...
 
virtual const std::string name () const =0
 function to return a name of the algorithm, must be overridden in all algorithms More...
 
virtual void removeObserver (const Poco::AbstractObserver &observer) const =0
 Remove an observer. More...
 
virtual ResultState resultState () const =0
 Gets the currnet result State. More...
 
virtual const std::vector< std::string > seeAlso () const =0
 Function to return all of the seeAlso algorithms related to this algorithm. More...
 
virtual void setAlgStartupLogging (const bool enabled)=0
 disable Logging of start and end messages More...
 
virtual void setAlwaysStoreInADS (const bool doStore)=0
 Set whether we always store the output in the analysis data service. More...
 
virtual void setChild (const bool isChild)=0
 To set whether algorithm is a child. More...
 
virtual void setChildEndProgress (const double endProgress) const =0
 setting the child end progress More...
 
virtual void setChildStartProgress (const double startProgress) const =0
 setting the child start progress More...
 
virtual void setLogging (const bool value)=0
 Logging can be disabled by passing a value of false. More...
 
virtual void setLoggingOffset (const int value)=0
 gets the logging priority offset More...
 
virtual void setRethrows (const bool rethrow)=0
 To query whether an algorithm should rethrow exceptions when executing. More...
 
virtual const std::string summary () const =0
 function returns a summary message that will be displayed in the default GUI, and in the help. More...
 
virtual ::Json::Value toJson () const =0
 Serialize an algorithm as Json. More...
 
virtual std::string toString () const =0
 Serialize an algorithm. More...
 
virtual std::map< std::string, std::string > validateInputs ()=0
 Method checking errors on ALL the inputs, before execution. More...
 
virtual int version () const =0
 function to return a version of the algorithm, must be overridden in all algorithms More...
 
Algorithms As Methods
- Public Member Functions inherited from Mantid::Kernel::IPropertyManager
virtual ::Json::Value asJson (bool withDefaultValues=false) const =0
 Return the property manager serialized as a json object. More...
 
virtual std::string asString (bool withDefaultValues=false) const =0
 Return the property manager serialized as a string. More...
 
virtual void declareOrReplaceProperty (std::unique_ptr< Property > p, const std::string &doc="")=0
 Function to declare properties (i.e. store them) More...
 
void declareProperty (const std::string &name, const char *value, const std::string &doc, IValidator_sptr validator=std::make_shared< NullValidator >(), const unsigned int direction=Direction::Input)
 Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string). More...
 
void declareProperty (const std::string &name, const char *value, const unsigned int direction)
 Add a property of string type to the list of managed properties. More...
 
void declareProperty (const std::string &name, const char *value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc=std::string(), const unsigned int direction=Direction::Input)
 Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string). More...
 
template<typename T >
void declareProperty (const std::string &name, T value, const std::string &doc, const unsigned int direction=Direction::Input)
 Add a property to the list of managed properties with no validator. More...
 
template<typename T >
void declareProperty (const std::string &name, T value, const unsigned int direction)
 Add a property of the template type to the list of managed properties. More...
 
template<typename T >
void declareProperty (const std::string &name, T value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc="", const unsigned int direction=Direction::Input)
 Add a property of the template type to the list of managed properties. More...
 
virtual void declareProperty (std::unique_ptr< Property > p, const std::string &doc="")=0
 Function to declare properties (i.e. store them) More...
 
virtual bool existsProperty (const std::string &name) const =0
 Checks whether the named property is already in the list of managed property. More...
 
virtual void filterByProperty (const TimeSeriesProperty< bool > &, const std::vector< std::string > &)=0
 
virtual void filterByTime (const Types::Core::DateAndTime &, const Types::Core::DateAndTime &)=0
 
virtual std::vector< std::string > getDeclaredPropertyNames () const noexcept=0
 Get the list of managed property names. More...
 
virtual 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 Member Functions

DataObjects::MDHistoWorkspace_sptr binInputWS ()
 Runs the BinMD algorithm on the input to provide the output workspace All slicing algorithm properties are passed along. More...
 
void cacheDimensionXValues ()
 Stores the X values from each H,K,L,E dimension as member variables Energy dimension is transformed to final wavevector. More...
 
void cacheInputs ()
 Set up starting values for cached variables. More...
 
void calculateIntersections (std::vector< std::array< double, 4 > > &intersections, const double theta, const double phi)
 Calculate the points of intersection for the given detector with cuboid surrounding the detector position in HKL. More...
 
void calculateNormalization (const std::vector< coord_t > &otherValues, const Kernel::Matrix< coord_t > &affineTrans, uint16_t expInfoIndex)
 Computed the normalization for the input workspace. More...
 
void createNormalizationWS (const DataObjects::MDHistoWorkspace &dataWS)
 Create & cached the normalization workspace. More...
 
void exec () override
 Execute the algorithm. More...
 
Kernel::Matrix< coord_tfindIntergratedDimensions (const std::vector< coord_t > &otherDimValues, bool &skipNormalization)
 Checks the normalization workspace against the indices of the original dimensions. More...
 
std::vector< coord_tgetValuesFromOtherDimensions (bool &skipNormalization, uint16_t expInfoIndex=0) const
 Retrieve logged values from non-HKL dimensions. More...
 
void init () override
 Initialize the algorithm's properties. More...
 
std::string inputEnergyMode () const
 Currently looks for the ConvertToMD algorithm in the history. More...
 

Private Attributes

std::string convention
 ki-kf for Inelastic convention; kf-ki for Crystallography convention More...
 
bool m_accumulate {false}
 internal flag to accumulate to an existing workspace More...
 
Kernel::V3D m_beamDir
 Beam direction. More...
 
bool m_dEIntegrated
 
coord_t m_dEmax
 
coord_t m_dEmin
 
double m_Ei
 cached values for incident energy and momentum, final momentum min/max More...
 
size_t m_eIdx
 
std::vector< double > m_eX
 
size_t m_hIdx
 index of h,k,l, dE dimensions in the output workspaces More...
 
bool m_hIntegrated
 flag for integrated h,k,l, dE dimensions More...
 
coord_t m_hmax
 
coord_t m_hmin
 limits for h,k,l, dE dimensions More...
 
std::vector< double > m_hX
 cached X values along dimensions h,k,l. dE More...
 
API::IMDEventWorkspace_sptr m_inputWS
 Input workspace. More...
 
double m_kfmax
 
double m_kfmin
 
double m_ki
 
size_t m_kIdx
 
bool m_kIntegrated
 
coord_t m_kmax
 
coord_t m_kmin
 
std::vector< double > m_kX
 
size_t m_lIdx
 
bool m_lIntegrated
 
coord_t m_lmax
 
coord_t m_lmin
 
std::vector< double > m_lX
 
DataObjects::MDHistoWorkspace_sptr m_normWS
 Normalization workspace. More...
 
uint16_t m_numExptInfos
 number of experiment infos More...
 
Mantid::Kernel::DblMatrix m_rubw
 (2*PiRUBW)^-1 More...
 
Kernel::V3D m_samplePos
 Sample position. 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::MDAlgorithms::SlicingAlgorithm
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...
 
- 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::MDAlgorithms::SlicingAlgorithm
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::MDImplicitFunctiongetGeneralImplicitFunction (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::MDImplicitFunctiongetImplicitFunctionForChunk (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
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::MDAlgorithms::SlicingAlgorithm
bool m_axisAligned
 Set to true if the cut is aligned with the axes. More...
 
std::vector< Mantid::Kernel::VMDm_bases
 Basis vectors of the output dimensions, normalized to unity length. More...
 
std::vector< Mantid::Geometry::MDHistoDimension_sptrm_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::CoordTransformm_transform
 Coordinate transformation to apply. More...
 
std::unique_ptr< DataObjects::CoordTransformAffinem_transformFromIntermediate
 Coordinate transformation to save in the output WS, from the intermediate WS. More...
 
std::unique_ptr< API::CoordTransformm_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::CoordTransformAffinem_transformToIntermediate
 Coordinate transformation to save in the intermediate WS. More...
 
std::unique_ptr< API::CoordTransformm_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< 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

MDNormSCD : Generate MD normalization for single crystal diffraction.

Definition at line 20 of file MDNormDirectSC.h.

Constructor & Destructor Documentation

◆ MDNormDirectSC()

Mantid::MDAlgorithms::MDNormDirectSC::MDNormDirectSC ( )

Constructor.

Definition at line 44 of file MDNormDirectSC.cpp.

Member Function Documentation

◆ binInputWS()

MDHistoWorkspace_sptr Mantid::MDAlgorithms::MDNormDirectSC::binInputWS ( )
private

Runs the BinMD algorithm on the input to provide the output workspace All slicing algorithm properties are passed along.

Returns
MDHistoWorkspace as a result of the binning

Definition at line 247 of file MDNormDirectSC.cpp.

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

Referenced by exec().

◆ cacheDimensionXValues()

void Mantid::MDAlgorithms::MDNormDirectSC::cacheDimensionXValues ( )
private

Stores the X values from each H,K,L,E dimension as member variables Energy dimension is transformed to final wavevector.

Definition at line 386 of file MDNormDirectSC.cpp.

References Mantid::PhysicalConstants::h, m_dEIntegrated, m_Ei, m_eIdx, m_eX, m_hIdx, m_hIntegrated, m_hX, m_kIdx, m_kIntegrated, m_kX, m_lIdx, m_lIntegrated, m_lX, m_normWS, Mantid::PhysicalConstants::meV, and Mantid::PhysicalConstants::NeutronMass.

Referenced by exec().

◆ cacheInputs()

void Mantid::MDAlgorithms::MDNormDirectSC::cacheInputs ( )
private

◆ calculateIntersections()

void Mantid::MDAlgorithms::MDNormDirectSC::calculateIntersections ( std::vector< std::array< double, 4 > > &  intersections,
const double  theta,
const double  phi 
)
private

Calculate the points of intersection for the given detector with cuboid surrounding the detector position in HKL.

Parameters
intersectionsA list of intersections in HKL space
thetaPolar angle with detector
phiAzimuthal angle with detector

Definition at line 540 of file MDNormDirectSC.cpp.

References convention, fabs, m_dEIntegrated, m_eX, m_hIntegrated, m_hmax, m_hmin, m_hX, m_kfmax, m_kfmin, m_ki, m_kIntegrated, m_kmax, m_kmin, m_kX, m_lIntegrated, m_lmax, m_lmin, m_lX, m_rubw, Mantid::Kernel::V3D::X(), Mantid::Kernel::V3D::Y(), and Mantid::Kernel::V3D::Z().

Referenced by calculateNormalization().

◆ calculateNormalization()

void Mantid::MDAlgorithms::MDNormDirectSC::calculateNormalization ( const std::vector< coord_t > &  otherValues,
const Kernel::Matrix< coord_t > &  affineTrans,
uint16_t  expInfoIndex 
)
private

◆ category()

const std::string Mantid::MDAlgorithms::MDNormDirectSC::category ( ) const
overridevirtual

Algorithm's category for identification.

See also
Algorithm::category

Reimplemented from Mantid::API::Algorithm.

Definition at line 54 of file MDNormDirectSC.cpp.

◆ createNormalizationWS()

void Mantid::MDAlgorithms::MDNormDirectSC::createNormalizationWS ( const DataObjects::MDHistoWorkspace dataWS)
private

Create & cached the normalization workspace.

Parameters
dataWSThe binned workspace that will be used for the data

Definition at line 267 of file MDNormDirectSC.cpp.

References Mantid::DataObjects::MDHistoWorkspace::clone(), Mantid::API::Algorithm::getProperty(), m_accumulate, m_normWS, and tmp.

Referenced by exec().

◆ exec()

void Mantid::MDAlgorithms::MDNormDirectSC::exec ( )
overrideprivatevirtual

◆ findIntergratedDimensions()

Kernel::Matrix< coord_t > Mantid::MDAlgorithms::MDNormDirectSC::findIntergratedDimensions ( const std::vector< coord_t > &  otherDimValues,
bool &  skipNormalization 
)
private

Checks the normalization workspace against the indices of the original dimensions.

If not found, the corresponding dimension is integrated

Parameters
otherDimValuesValues from non-HKL dimensions
skipNormalization[InOut] Sets the flag true if normalization values are outside of original inputs
Returns
Affine trasform matrix

Definition at line 319 of file MDNormDirectSC.cpp.

References m_dEIntegrated, m_dEmax, m_dEmin, m_eIdx, m_hIdx, m_hIntegrated, m_hmax, m_hmin, m_kIdx, m_kIntegrated, m_kmax, m_kmin, m_lIdx, m_lIntegrated, m_lmax, m_lmin, m_normWS, Mantid::Kernel::Matrix< T >::numCols(), and Mantid::Kernel::Matrix< T >::numRows().

Referenced by exec().

◆ getValuesFromOtherDimensions()

std::vector< coord_t > Mantid::MDAlgorithms::MDNormDirectSC::getValuesFromOtherDimensions ( bool &  skipNormalization,
uint16_t  expInfoIndex = 0 
) const
private

Retrieve logged values from non-HKL dimensions.

Parameters
skipNormalization[InOut] Updated to false if any values are outside range measured by input workspace
expInfoIndexcurrent experiment info index
Returns
A vector of values from other dimensions to be include in normalized MD position calculation

Definition at line 287 of file MDNormDirectSC.cpp.

References m_inputWS, and value.

Referenced by exec().

◆ init()

void Mantid::MDAlgorithms::MDNormDirectSC::init ( )
overrideprivatevirtual

◆ inputEnergyMode()

std::string Mantid::MDAlgorithms::MDNormDirectSC::inputEnergyMode ( ) const
private

Currently looks for the ConvertToMD algorithm in the history.

Returns
A string donating the energy transfer mode of the input workspace

Definition at line 222 of file MDNormDirectSC.cpp.

References m_inputWS.

Referenced by cacheInputs().

◆ name()

const std::string Mantid::MDAlgorithms::MDNormDirectSC::name ( ) const
overridevirtual

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

See also
Algorithm::name

Implements Mantid::API::Algorithm.

Definition at line 63 of file MDNormDirectSC.cpp.

◆ seeAlso()

const std::vector< std::string > Mantid::MDAlgorithms::MDNormDirectSC::seeAlso ( ) const
inlineoverridevirtual

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

Reimplemented from Mantid::API::Algorithm.

Definition at line 26 of file MDNormDirectSC.h.

◆ summary()

const std::string Mantid::MDAlgorithms::MDNormDirectSC::summary ( ) const
overridevirtual

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

See also
Algorithm::summary

Implements Mantid::API::Algorithm.

Definition at line 57 of file MDNormDirectSC.cpp.

◆ version()

int Mantid::MDAlgorithms::MDNormDirectSC::version ( ) const
overridevirtual

Algorithm's version for identification.

See also
Algorithm::version

Implements Mantid::API::Algorithm.

Definition at line 51 of file MDNormDirectSC.cpp.

Member Data Documentation

◆ convention

std::string Mantid::MDAlgorithms::MDNormDirectSC::convention
private

ki-kf for Inelastic convention; kf-ki for Crystallography convention

Definition at line 69 of file MDNormDirectSC.h.

Referenced by calculateIntersections(), and exec().

◆ m_accumulate

bool Mantid::MDAlgorithms::MDNormDirectSC::m_accumulate {false}
private

internal flag to accumulate to an existing workspace

Definition at line 71 of file MDNormDirectSC.h.

Referenced by calculateNormalization(), createNormalizationWS(), and exec().

◆ m_beamDir

Kernel::V3D Mantid::MDAlgorithms::MDNormDirectSC::m_beamDir
private

Beam direction.

Definition at line 67 of file MDNormDirectSC.h.

Referenced by cacheInputs(), and calculateNormalization().

◆ m_dEIntegrated

bool Mantid::MDAlgorithms::MDNormDirectSC::m_dEIntegrated
private

◆ m_dEmax

coord_t Mantid::MDAlgorithms::MDNormDirectSC::m_dEmax
private

Definition at line 53 of file MDNormDirectSC.h.

Referenced by cacheInputs(), and findIntergratedDimensions().

◆ m_dEmin

coord_t Mantid::MDAlgorithms::MDNormDirectSC::m_dEmin
private

Definition at line 53 of file MDNormDirectSC.h.

Referenced by cacheInputs(), and findIntergratedDimensions().

◆ m_Ei

double Mantid::MDAlgorithms::MDNormDirectSC::m_Ei
private

cached values for incident energy and momentum, final momentum min/max

Definition at line 55 of file MDNormDirectSC.h.

Referenced by cacheDimensionXValues(), cacheInputs(), and calculateNormalization().

◆ m_eIdx

size_t Mantid::MDAlgorithms::MDNormDirectSC::m_eIdx
private

Definition at line 61 of file MDNormDirectSC.h.

Referenced by cacheDimensionXValues(), and findIntergratedDimensions().

◆ m_eX

std::vector<double> Mantid::MDAlgorithms::MDNormDirectSC::m_eX
private

Definition at line 63 of file MDNormDirectSC.h.

Referenced by cacheDimensionXValues(), and calculateIntersections().

◆ m_hIdx

size_t Mantid::MDAlgorithms::MDNormDirectSC::m_hIdx
private

index of h,k,l, dE dimensions in the output workspaces

Definition at line 61 of file MDNormDirectSC.h.

Referenced by cacheDimensionXValues(), and findIntergratedDimensions().

◆ m_hIntegrated

bool Mantid::MDAlgorithms::MDNormDirectSC::m_hIntegrated
private

flag for integrated h,k,l, dE dimensions

Definition at line 57 of file MDNormDirectSC.h.

Referenced by cacheDimensionXValues(), calculateIntersections(), and findIntergratedDimensions().

◆ m_hmax

coord_t Mantid::MDAlgorithms::MDNormDirectSC::m_hmax
private

Definition at line 53 of file MDNormDirectSC.h.

Referenced by cacheInputs(), calculateIntersections(), and findIntergratedDimensions().

◆ m_hmin

coord_t Mantid::MDAlgorithms::MDNormDirectSC::m_hmin
private

limits for h,k,l, dE dimensions

Definition at line 53 of file MDNormDirectSC.h.

Referenced by cacheInputs(), calculateIntersections(), and findIntergratedDimensions().

◆ m_hX

std::vector<double> Mantid::MDAlgorithms::MDNormDirectSC::m_hX
private

cached X values along dimensions h,k,l. dE

Definition at line 63 of file MDNormDirectSC.h.

Referenced by cacheDimensionXValues(), and calculateIntersections().

◆ m_inputWS

API::IMDEventWorkspace_sptr Mantid::MDAlgorithms::MDNormDirectSC::m_inputWS
private

Input workspace.

Definition at line 51 of file MDNormDirectSC.h.

Referenced by cacheInputs(), calculateNormalization(), exec(), getValuesFromOtherDimensions(), and inputEnergyMode().

◆ m_kfmax

double Mantid::MDAlgorithms::MDNormDirectSC::m_kfmax
private

Definition at line 55 of file MDNormDirectSC.h.

Referenced by cacheInputs(), and calculateIntersections().

◆ m_kfmin

double Mantid::MDAlgorithms::MDNormDirectSC::m_kfmin
private

Definition at line 55 of file MDNormDirectSC.h.

Referenced by cacheInputs(), and calculateIntersections().

◆ m_ki

double Mantid::MDAlgorithms::MDNormDirectSC::m_ki
private

Definition at line 55 of file MDNormDirectSC.h.

Referenced by cacheInputs(), and calculateIntersections().

◆ m_kIdx

size_t Mantid::MDAlgorithms::MDNormDirectSC::m_kIdx
private

Definition at line 61 of file MDNormDirectSC.h.

Referenced by cacheDimensionXValues(), and findIntergratedDimensions().

◆ m_kIntegrated

bool Mantid::MDAlgorithms::MDNormDirectSC::m_kIntegrated
private

◆ m_kmax

coord_t Mantid::MDAlgorithms::MDNormDirectSC::m_kmax
private

Definition at line 53 of file MDNormDirectSC.h.

Referenced by cacheInputs(), calculateIntersections(), and findIntergratedDimensions().

◆ m_kmin

coord_t Mantid::MDAlgorithms::MDNormDirectSC::m_kmin
private

Definition at line 53 of file MDNormDirectSC.h.

Referenced by cacheInputs(), calculateIntersections(), and findIntergratedDimensions().

◆ m_kX

std::vector<double> Mantid::MDAlgorithms::MDNormDirectSC::m_kX
private

Definition at line 63 of file MDNormDirectSC.h.

Referenced by cacheDimensionXValues(), and calculateIntersections().

◆ m_lIdx

size_t Mantid::MDAlgorithms::MDNormDirectSC::m_lIdx
private

Definition at line 61 of file MDNormDirectSC.h.

Referenced by cacheDimensionXValues(), and findIntergratedDimensions().

◆ m_lIntegrated

bool Mantid::MDAlgorithms::MDNormDirectSC::m_lIntegrated
private

◆ m_lmax

coord_t Mantid::MDAlgorithms::MDNormDirectSC::m_lmax
private

Definition at line 53 of file MDNormDirectSC.h.

Referenced by cacheInputs(), calculateIntersections(), and findIntergratedDimensions().

◆ m_lmin

coord_t Mantid::MDAlgorithms::MDNormDirectSC::m_lmin
private

Definition at line 53 of file MDNormDirectSC.h.

Referenced by cacheInputs(), calculateIntersections(), and findIntergratedDimensions().

◆ m_lX

std::vector<double> Mantid::MDAlgorithms::MDNormDirectSC::m_lX
private

Definition at line 63 of file MDNormDirectSC.h.

Referenced by cacheDimensionXValues(), and calculateIntersections().

◆ m_normWS

DataObjects::MDHistoWorkspace_sptr Mantid::MDAlgorithms::MDNormDirectSC::m_normWS
private

Normalization workspace.

Definition at line 49 of file MDNormDirectSC.h.

Referenced by cacheDimensionXValues(), calculateNormalization(), createNormalizationWS(), exec(), and findIntergratedDimensions().

◆ m_numExptInfos

uint16_t Mantid::MDAlgorithms::MDNormDirectSC::m_numExptInfos
private

number of experiment infos

Definition at line 73 of file MDNormDirectSC.h.

Referenced by calculateNormalization(), and exec().

◆ m_rubw

Mantid::Kernel::DblMatrix Mantid::MDAlgorithms::MDNormDirectSC::m_rubw
private

(2*PiRUBW)^-1

Definition at line 59 of file MDNormDirectSC.h.

Referenced by calculateIntersections(), and calculateNormalization().

◆ m_samplePos

Kernel::V3D Mantid::MDAlgorithms::MDNormDirectSC::m_samplePos
private

Sample position.

Definition at line 65 of file MDNormDirectSC.h.

Referenced by cacheInputs(), and calculateNormalization().


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