Mantid
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
Mantid::Algorithms::DetectorDiagnostic Class Reference

A base class for a detector diagnostic algorithm. More...

#include <DetectorDiagnostic.h>

Inheritance diagram for Mantid::Algorithms::DetectorDiagnostic:
Mantid::API::Algorithm Mantid::API::IAlgorithm Mantid::Kernel::IPropertyManager Mantid::Algorithms::CreatePSDBleedMask Mantid::Algorithms::DetectorEfficiencyVariation Mantid::Algorithms::FindDetectorsOutsideLimits Mantid::Algorithms::MedianDetectorTest

Public Member Functions

const std::string category () const override
 Algorithm's category for identification. More...
 
 DetectorDiagnostic ()
 Default constructor. More...
 
const std::string name () const override
 Algorithm's name for identification overriding a virtual method. More...
 
const std::vector< std::string > seeAlso () const override
 Function to return all of the seeAlso algorithms related to this algorithm. More...
 
const std::string summary () const override
 Summary of algorithms purpose. More...
 
int version () const override
 Algorithm's version for identification overriding a virtual method. More...
 
virtual ~DetectorDiagnostic ()=default
 Default destructor. More...
 
- Public Member Functions inherited from Mantid::API::Algorithm
 Algorithm ()
 Constructor. More...
 
 Algorithm (const Algorithm &)=delete
 
Algorithmoperator= (const Algorithm &)=delete
 
 ~Algorithm () override
 Virtual destructor. More...
 
void initialize () override
 Initialization method invoked by the framework. More...
 
bool execute () override final
 The actions to be performed by the algorithm on a dataset. More...
 
void addTimer (const std::string &name, const Kernel::time_point_ns &begin, const Kernel::time_point_ns &end)
 
void executeAsChildAlg () override
 Execute as a Child Algorithm. More...
 
std::map< std::string, std::string > validateInputs () override
 Perform validation of ALL the input properties of the algorithm. More...
 
ExecutionState executionState () const override
 Gets the current execution state. More...
 
ResultState resultState () const override
 Gets the current result State. More...
 
bool isInitialized () const override
 Has the Algorithm already been initialized. More...
 
bool isExecuted () const override
 Has the Algorithm already been executed successfully. More...
 
bool isRunning () const override
 True if the algorithm is running. More...
 
bool isReadyForGarbageCollection () const override
 True if the algorithm is ready for garbage collection. More...
 
bool isChild () const override
 To query whether algorithm is a child. More...
 
void setChild (const bool isChild) override
 To set whether algorithm is a child. More...
 
void enableHistoryRecordingForChild (const bool on) override
 Change the state of the history recording flag. More...
 
bool isRecordingHistoryForChild ()
 
void setAlwaysStoreInADS (const bool doStore) override
 Do we ALWAYS store in the AnalysisDataService? This is set to true for python algorithms' child algorithms. More...
 
bool getAlwaysStoreInADS () const override
 Returns true if we always store in the AnalysisDataService. More...
 
void setRethrows (const bool rethrow) override
 Set whether the algorithm will rethrow exceptions. More...
 
Poco::ActiveResult< bool > executeAsync () override
 Asynchronous execution. More...
 
void addObserver (const Poco::AbstractObserver &observer) const override
 Add an observer for a notification. More...
 
void removeObserver (const Poco::AbstractObserver &observer) const override
 Remove an observer. More...
 
void cancel () override
 Raises the cancel flag. More...
 
bool getCancel () const
 Returns the cancellation state. More...
 
Kernel::LoggergetLogger () const
 Returns a reference to the logger. More...
 
void setLogging (const bool value) override
 Logging can be disabled by passing a value of false. More...
 
bool isLogging () const override
 returns the status of logging, True = enabled More...
 
void setLoggingOffset (const int value) override
 gets the logging priority offset More...
 
int getLoggingOffset () const override
 returns the logging priority offset More...
 
void setAlgStartupLogging (const bool enabled) override
 disable Logging of start and end messages More...
 
bool getAlgStartupLogging () const override
 get the state of Logging of start and end messages More...
 
void setChildStartProgress (const double startProgress) const override
 setting the child start progress More...
 
void setChildEndProgress (const double endProgress) const override
 setting the child end progress More...
 
std::string toString () const override
 Serialize an object to a string. More...
 
::Json::Value toJson () const override
 Serialize an object to a json object. More...
 
virtual std::shared_ptr< AlgorithmcreateChildAlgorithm (const std::string &name, const double startProgress=-1., const double endProgress=-1., const bool enableLogging=true, const int &version=-1)
 Create a Child Algorithm. More...
 
void setupAsChildAlgorithm (const Algorithm_sptr &algorithm, const double startProgress=-1., const double endProgress=-1., const bool enableLogging=true)
 Setup algorithm as child algorithm. More...
 
void trackAlgorithmHistory (std::shared_ptr< AlgorithmHistory > parentHist)
 set whether we wish to track the child algorithm's history and pass it the parent object to fill. More...
 
void findWorkspaces (WorkspaceVector &workspaces, unsigned int direction, bool checkADS=false) const
 Populate lists of the workspace properties for a given direction (InOut workspaces are included in both input/output) More...
 
virtual bool checkGroups ()
 Check the input workspace properties for groups. More...
 
virtual bool processGroups ()
 Process WorkspaceGroup inputs. More...
 
void copyNonWorkspaceProperties (IAlgorithm *alg, int periodNum)
 Copy all the non-workspace properties from this to alg. More...
 
const Parallel::Communicator & communicator () const
 Returns a const reference to the (MPI) communicator of the algorithm. More...
 
void setCommunicator (const Parallel::Communicator &communicator)
 Sets the (MPI) communicator of the algorithm. More...
 
void declareProperty (std::unique_ptr< Kernel::Property > p, const std::string &doc="") override
 Add a property to the list of managed properties. More...
 
void declareOrReplaceProperty (std::unique_ptr< Kernel::Property > p, const std::string &doc="") override
 Add or replace property in the list of managed properties. More...
 
void resetProperties () override
 Reset property values back to initial values (blank or default values) More...
 
void setProperties (const std::string &propertiesJson, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false) override
 Set the ordered list of properties by one string of values, separated by semicolons. More...
 
void setProperties (const ::Json::Value &jsonValue, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false) override
 Sets all the declared properties from a json object. More...
 
void setPropertiesWithString (const std::string &propertiesString, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >()) override
 Sets all the declared properties from a string. More...
 
void setPropertyValue (const std::string &name, const std::string &value) override
 Set the value of a property by string N.B. More...
 
void setPropertyValueFromJson (const std::string &name, const Json::Value &value) override
 Set the value of a property by Json::Value object. More...
 
void setPropertyOrdinal (const int &index, const std::string &value) override
 Set the value of a property by an index N.B. More...
 
virtual void copyPropertiesFrom (const Algorithm &alg)
 Make m_properties point to the same PropertyManager as alg.m_properties. More...
 
bool existsProperty (const std::string &name) const override
 Checks whether the named property is already in the list of managed property. More...
 
bool validateProperties () const override
 Validates all the properties in the collection. More...
 
size_t propertyCount () const override
 Count the number of properties under management. More...
 
std::string getPropertyValue (const std::string &name) const override
 Get the value of a property as a string. More...
 
const std::vector< Kernel::Property * > & getProperties () const override
 Get the list of managed properties. More...
 
std::vector< std::string > getDeclaredPropertyNames () const noexcept override
 Return the list of declared property names. More...
 
TypedValue getProperty (const std::string &name) const override
 Get the value of a property. More...
 
std::string asString (bool withDefaultValues=false) const override
 Return the property manager serialized as a string. More...
 
::Json::Value asJson (bool withDefaultValues=false) const override
 Return the property manager serialized as a json object. More...
 
bool isDefault (const std::string &name) const
 
void removeProperty (const std::string &name, const bool delproperty=true) override
 Removes the property from management. More...
 
std::unique_ptr< Kernel::PropertytakeProperty (const size_t index) override
 Removes the property from management and returns a pointer to it. More...
 
void clear () override
 Clears all properties under management. More...
 
void afterPropertySet (const std::string &) override
 Override this method to perform a custom action right after a property was set. More...
 
void filterByTime (const Types::Core::DateAndTime &, const Types::Core::DateAndTime &) override
 
void splitByTime (std::vector< Kernel::SplittingInterval > &, std::vector< Kernel::PropertyManager * >) const override
 
void filterByProperty (const Kernel::TimeSeriesProperty< bool > &, const std::vector< std::string > &) override
 
Kernel::PropertygetPointerToProperty (const std::string &name) const override
 Get a property by name. More...
 
Kernel::PropertygetPointerToPropertyOrdinal (const int &index) const override
 Get a property by an index. More...
 
virtual void declareProperty (std::unique_ptr< Property > p, const std::string &doc="")=0
 Function to declare properties (i.e. store them) More...
 
template<typename T >
void declareProperty (const std::string &name, T value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc="", const unsigned int direction=Direction::Input)
 Add a property of the template type to the list of managed properties. More...
 
template<typename T >
void declareProperty (const std::string &name, T value, const std::string &doc, const unsigned int direction=Direction::Input)
 Add a property to the list of managed properties with no validator. More...
 
template<typename T >
void declareProperty (const std::string &name, T value, const unsigned int direction)
 Add a property of the template type to the list of managed properties. More...
 
void declareProperty (const std::string &name, const char *value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc=std::string(), const unsigned int direction=Direction::Input)
 Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string). More...
 
void declareProperty (const std::string &name, const char *value, const std::string &doc, IValidator_sptr validator=std::make_shared< NullValidator >(), const unsigned int direction=Direction::Input)
 Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string). More...
 
void declareProperty (const std::string &name, const char *value, const unsigned int direction)
 Add a property of string type to the list of managed properties. More...
 
const std::string category () const override
 function to return a category of the algorithm. More...
 
const std::vector< std::string > categories () const override
 Function to return all of the categories that contain this algorithm. More...
 
const std::string categorySeparator () const override
 Function to return the separator token for the category string. More...
 
const std::vector< std::string > seeAlso () const override
 Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm.A default implementation is provided. More...
 
const std::string alias () const override
 function to return any aliases to the algorithm; A default implementation is provided More...
 
const std::string aliasDeprecated () const override
 Expiration date (in ISO8601 format) for the algorithm aliases; default implementation for no expiration date. More...
 
const std::string helpURL () const override
 function to return URL for algorithm documentation; A default implementation is provided. More...
 
template<typename T , typename = typename std::enable_if<std::is_convertible<T *, MatrixWorkspace *>::value>::type>
std::tuple< std::shared_ptr< T >, Indexing::SpectrumIndexSet > getWorkspaceAndIndices (const std::string &name) const
 
template<typename T1 , typename T2 , typename = typename std::enable_if<std::is_convertible<T1 *, MatrixWorkspace *>::value>::type, typename = typename std::enable_if<std::is_convertible<T2 *, std::string *>::value || std::is_convertible<T2 *, std::vector<int64_t> *>::value>::type>
void setWorkspaceInputProperties (const std::string &name, const std::shared_ptr< T1 > &wksp, IndexType type, const T2 &list)
 
template<typename T1 , typename T2 , typename = typename std::enable_if<std::is_convertible<T1 *, MatrixWorkspace *>::value>::type, typename = typename std::enable_if<std::is_convertible<T2 *, std::string *>::value || std::is_convertible<T2 *, std::vector<int64_t> *>::value>::type>
void setWorkspaceInputProperties (const std::string &name, const std::string &wsName, IndexType type, const T2 &list)
 
const std::string workspaceMethodName () const override
 
const std::vector< std::string > workspaceMethodOn () const override
 
const std::string workspaceMethodInputProperty () const override
 
AlgorithmID getAlgorithmID () const override
 Algorithm ID. More...
 
virtual void addObserver (const Poco::AbstractObserver &observer) const =0
 Add an observer for a notification. More...
 
virtual const std::string alias () const =0
 function to return any aliases of the algorithm. More...
 
virtual const std::string aliasDeprecated () const =0
 Expiration date (in ISO8601 format) for the algorithm aliases. Empty if no expiration date. More...
 
virtual void cancel ()=0
 Raises the cancel flag. More...
 
virtual const std::vector< std::string > categories () const =0
 Function to return all of the categories that contain this algorithm. More...
 
virtual const std::string category () const =0
 function to return a category of the algorithm. More...
 
virtual const std::string categorySeparator () const =0
 Function to return the separator token for the category string. More...
 
virtual void enableHistoryRecordingForChild (const bool on)=0
 If true history will be recorded for a child. More...
 
virtual bool execute ()=0
 System execution. More...
 
virtual void executeAsChildAlg ()=0
 Execute as a Child Algorithm, with try/catch. More...
 
virtual Poco::ActiveResult< bool > executeAsync ()=0
 Asynchronous execution of the algorithm. More...
 
virtual ExecutionState executionState () const =0
 Gets the current execution state. More...
 
virtual AlgorithmID getAlgorithmID () const =0
 Algorithm ID. More...
 
virtual bool getAlgStartupLogging () const =0
 get the state of Logging of start and end messages More...
 
virtual bool getAlwaysStoreInADS () const =0
 To query whether the output is stored in the analysis data service. More...
 
virtual int getLoggingOffset () const =0
 returns the logging priority offset More...
 
virtual const std::string helpURL () const =0
 function to return an optional URL for documentation. More...
 
virtual void initialize ()=0
 Initialization method invoked by the framework. More...
 
virtual bool isChild () const =0
 To query whether algorithm is a child. Default to false. More...
 
virtual bool isExecuted () const =0
 Check whether the algorithm has been executed sucessfully. More...
 
virtual bool isInitialized () const =0
 Check whether the algorithm is initialized properly. More...
 
virtual bool isLogging () const =0
 returns the status of logging, True = enabled More...
 
virtual bool isReadyForGarbageCollection () const =0
 True if the algorithm is ready for garbage collection. More...
 
virtual bool isRunning () const =0
 True if the algorithm is running. More...
 
virtual const std::string name () const =0
 function to return a name of the algorithm, must be overridden in all algorithms More...
 
virtual void removeObserver (const Poco::AbstractObserver &observer) const =0
 Remove an observer. More...
 
virtual ResultState resultState () const =0
 Gets the currnet result State. More...
 
virtual const std::vector< std::string > seeAlso () const =0
 Function to return all of the seeAlso algorithms related to this algorithm. More...
 
virtual void setAlgStartupLogging (const bool enabled)=0
 disable Logging of start and end messages More...
 
virtual void setAlwaysStoreInADS (const bool doStore)=0
 Set whether we always store the output in the analysis data service. More...
 
virtual void setChild (const bool isChild)=0
 To set whether algorithm is a child. More...
 
virtual void setChildEndProgress (const double endProgress) const =0
 setting the child end progress More...
 
virtual void setChildStartProgress (const double startProgress) const =0
 setting the child start progress More...
 
virtual void setLogging (const bool value)=0
 Logging can be disabled by passing a value of false. More...
 
virtual void setLoggingOffset (const int value)=0
 gets the logging priority offset More...
 
virtual void setRethrows (const bool rethrow)=0
 To query whether an algorithm should rethrow exceptions when executing. More...
 
virtual const std::string summary () const =0
 function returns a summary message that will be displayed in the default GUI, and in the help. More...
 
virtual ::Json::Value toJson () const =0
 Serialize an algorithm as Json. More...
 
virtual std::string toString () const =0
 Serialize an algorithm. More...
 
virtual std::map< std::string, std::string > validateInputs ()=0
 Method checking errors on ALL the inputs, before execution. More...
 
virtual int version () const =0
 function to return a version of the algorithm, must be overridden in all algorithms More...
 
Algorithms As Methods
- Public Member Functions inherited from Mantid::Kernel::IPropertyManager
virtual ::Json::Value asJson (bool withDefaultValues=false) const =0
 Return the property manager serialized as a json object. More...
 
virtual std::string asString (bool withDefaultValues=false) const =0
 Return the property manager serialized as a string. More...
 
virtual void declareOrReplaceProperty (std::unique_ptr< Property > p, const std::string &doc="")=0
 Function to declare properties (i.e. store them) More...
 
void declareProperty (const std::string &name, const char *value, const std::string &doc, IValidator_sptr validator=std::make_shared< NullValidator >(), const unsigned int direction=Direction::Input)
 Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string). More...
 
void declareProperty (const std::string &name, const char *value, const unsigned int direction)
 Add a property of string type to the list of managed properties. More...
 
void declareProperty (const std::string &name, const char *value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc=std::string(), const unsigned int direction=Direction::Input)
 Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string). More...
 
template<typename T >
void declareProperty (const std::string &name, T value, const std::string &doc, const unsigned int direction=Direction::Input)
 Add a property to the list of managed properties with no validator. More...
 
template<typename T >
void declareProperty (const std::string &name, T value, const unsigned int direction)
 Add a property of the template type to the list of managed properties. More...
 
template<typename T >
void declareProperty (const std::string &name, T value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc="", const unsigned int direction=Direction::Input)
 Add a property of the template type to the list of managed properties. More...
 
virtual void declareProperty (std::unique_ptr< Property > p, const std::string &doc="")=0
 Function to declare properties (i.e. store them) More...
 
virtual bool existsProperty (const std::string &name) const =0
 Checks whether the named property is already in the list of managed property. More...
 
virtual void filterByProperty (const TimeSeriesProperty< bool > &, const std::vector< std::string > &)=0
 
virtual void filterByTime (const Types::Core::DateAndTime &, const Types::Core::DateAndTime &)=0
 
virtual std::vector< std::string > getDeclaredPropertyNames () const noexcept=0
 Get the list of managed property names. More...
 
virtual PropertygetPointerToProperty (const std::string &name) const =0
 Get a pointer to property by name. More...
 
virtual const std::vector< Property * > & getProperties () const =0
 Get the list of managed properties. More...
 
std::vector< Property * > getPropertiesInGroup (const std::string &group) const
 Get the list of managed properties in a given group. More...
 
virtual TypedValue getProperty (const std::string &name) const =0
 Get the value of a property. More...
 
virtual std::string getPropertyValue (const std::string &name) const =0
 Get the value of a property as a string. More...
 
virtual size_t propertyCount () const =0
 Returns the number of properties under management. More...
 
virtual void removeProperty (const std::string &name, const bool delproperty=true)=0
 Removes the property from management. More...
 
virtual void resetProperties ()=0
 
virtual void setProperties (const ::Json::Value &jsonValue, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)=0
 Sets all the properties from a json object. More...
 
virtual void setProperties (const std::string &propertiesJson, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)=0
 Sets all properties from a string. More...
 
virtual void setPropertiesWithString (const std::string &propertiesString, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >())=0
 Sets all the declared properties from a string. More...
 
IPropertyManagersetProperty (const std::string &name, const char *value)
 Specialised version of setProperty template method to handle const char *. More...
 
IPropertyManagersetProperty (const std::string &name, const std::string &value)
 Specialised version of setProperty template method to handle std::string. More...
 
template<typename T >
IPropertyManagersetProperty (const std::string &name, const T &value)
 Templated method to set the value of a PropertyWithValue. More...
 
template<typename T >
IPropertyManagersetProperty (const std::string &name, std::unique_ptr< T > value)
 Templated method to set the value of a PropertyWithValue from a std::unique_ptr. More...
 
void setPropertyGroup (const std::string &name, const std::string &group)
 Set the group for a given property. More...
 
virtual void setPropertyOrdinal (const int &index, const std::string &value)=0
 Set the value of a property by an index. More...
 
void setPropertySettings (const std::string &name, std::unique_ptr< IPropertySettings > settings)
 
virtual void setPropertyValue (const std::string &name, const std::string &value)=0
 Sets property value from a string. More...
 
virtual void setPropertyValueFromJson (const std::string &name, const Json::Value &value)=0
 Sets property value from a Json::Value. More...
 
virtual void splitByTime (std::vector< SplittingInterval > &, std::vector< PropertyManager * >) const =0
 
virtual std::unique_ptr< PropertytakeProperty (const size_t index)=0
 Removes the property from management and returns a pointer to it. More...
 
void updatePropertyValues (const IPropertyManager &other)
 Update values of the existing properties. More...
 
virtual bool validateProperties () const =0
 Validates all the properties in the collection. More...
 
virtual ~IPropertyManager ()=default
 

Protected Member Functions

std::vector< double > calculateMedian (const API::MatrixWorkspace &input, bool excludeZeroes, const std::vector< std::vector< size_t > > &indexmap)
 Calculate the median of the given workspace. More...
 
API::MatrixWorkspace_sptr convertToRate (API::MatrixWorkspace_sptr workspace)
 Convert to a distribution. More...
 
DataObjects::MaskWorkspace_sptr generateEmptyMask (const API::MatrixWorkspace_const_sptr &inputWS)
 Create a masking workspace to return. More...
 
API::MatrixWorkspace_sptr integrateSpectra (const API::MatrixWorkspace_sptr &inputWS, const int indexMin, const int indexMax, const double lower, const double upper, const bool outputWorkspace2D=false)
 Get the total counts for each spectra. More...
 
std::vector< std::vector< size_t > > makeInstrumentMap (const API::MatrixWorkspace &countsWS)
 method to create the map with all spectra More...
 
std::vector< std::vector< size_t > > makeMap (const API::MatrixWorkspace_sptr &countsWS)
 method to check which spectra should be grouped when calculating the median More...
 
- Protected Member Functions inherited from Mantid::API::Algorithm
void exec (Parallel::ExecutionMode executionMode)
 Runs the algorithm with the specified execution mode. More...
 
virtual void execDistributed ()
 Runs the algorithm in distributed execution mode. More...
 
virtual void execMasterOnly ()
 Runs the algorithm in master-only execution mode. More...
 
virtual Parallel::ExecutionMode getParallelExecutionMode (const std::map< std::string, Parallel::StorageMode > &storageModes) const
 Get correct execution mode based on input storage modes for an MPI run. More...
 
virtual const std::string workspaceMethodOnTypes () const
 Returns a semi-colon separated list of workspace types to attach this algorithm. More...
 
void cacheWorkspaceProperties ()
 Go through the properties and cache the input/output workspace properties for later use. More...
 
void cacheInputWorkspaceHistories ()
 Cache the histories of any input workspaces so they can be copied over after algorithm completion. More...
 
void setExecutionState (const ExecutionState state)
 Sets the current execution state. More...
 
void setResultState (const ResultState state)
 Sets the result execution state. More...
 
void store ()
 Stores any output workspaces into the AnalysisDataService. More...
 
void progress (double p, const std::string &msg="", double estimatedTime=0.0, int progressPrecision=0)
 Sends ProgressNotification. More...
 
void interruption_point ()
 This is called during long-running operations, and check if the algorithm has requested that it be cancelled. More...
 
Poco::NotificationCenter & notificationCenter () const
 Return a reference to the algorithm's notification dispatcher. More...
 
void handleChildProgressNotification (const Poco::AutoPtr< ProgressNotification > &pNf)
 Observation slot for child algorithm progress notification messages, these are scaled and then signalled for this algorithm. More...
 
const Poco::AbstractObserver & progressObserver () const
 Return a reference to the algorithm's object that is reporting progress. More...
 
bool isWorkspaceProperty (const Kernel::Property *const prop) const
 checks the property is a workspace property More...
 
bool trackingHistory ()
 get whether we are tracking the history for this algorithm, More...
 
virtual void fillHistory ()
 Copy workspace history for input workspaces to output workspaces and record the history for ths algorithm. More...
 
virtual void setOtherProperties (IAlgorithm *alg, const std::string &propertyName, const std::string &propertyValue, int periodNum)
 Virtual method to set the non workspace properties for this algorithm. More...
 
template<typename T , const int AllowedIndexTypes = static_cast<int>(IndexType::WorkspaceIndex), typename... WSPropArgs, typename = typename std::enable_if<std::is_convertible<T *, MatrixWorkspace *>::value>::type>
void declareWorkspaceInputProperties (const std::string &propertyName, const std::string &doc, WSPropArgs &&...wsPropArgs)
 
- Protected Member Functions inherited from Mantid::Kernel::IPropertyManager
virtual void afterPropertySet (const std::string &)
 Override this method to perform a custom action right after a property was set. More...
 
virtual void clear ()=0
 Clears all properties under management. More...
 
virtual PropertygetPointerToPropertyOrdinal (const int &index) const =0
 Get a property by an index. More...
 
template<typename T >
getValue (const std::string &name) const
 Templated method to get the value of a property. More...
 
template<>
MANTID_KERNEL_DLL PropertyManager_sptr getValue (const std::string &name) const
 
template<>
MANTID_KERNEL_DLL PropertyManager_const_sptr getValue (const std::string &name) const
 

Private Member Functions

void applyMask (const API::MatrixWorkspace_sptr &inputWS, const API::MatrixWorkspace_sptr &maskWS)
 Apply a given mask. More...
 
API::MatrixWorkspace_sptr doDetVanTest (const API::MatrixWorkspace_sptr &inputWS, int &nFails)
 Perform checks on detector vanadium. More...
 
void exec () override
 Virtual method - must be overridden by concrete algorithm. More...
 
void init () override
 Virtual method - must be overridden by concrete algorithm. More...
 

Progress reporting

enum  RunTime {
  RTGetSolidAngle = 15000 , RTGetTotalCounts = 5000 , RTGetRate = 100 , RTMarkDetects = 200 ,
  RTWriteFile = 200 , RTTotal = RTGetSolidAngle + RTGetTotalCounts + RTGetRate + RTMarkDetects + RTWriteFile
}
 For the progress bar, estimates of how many additions, or equivalent, member functions will do for each spectrum. More...
 
double m_fracDone
 An estimate of the percentage of the algorithm runtimes that has been completed. More...
 
int m_TotalTime
 An estimate total number of additions or equilivent required to compute a spectrum. More...
 
int m_parents
 number of parents up, 0 go to instrument More...
 
double m_progStepWidth
 The number of tests to be run. More...
 
int m_minIndex
 Starting workspace index to run tests on. More...
 
int m_maxIndex
 Ending workspace index to run tests on. More...
 
double m_rangeLower
 Starting x-axis value for integrations. More...
 
double m_rangeUpper
 Ending x-axis value for integrations. More...
 
double advanceProgress (double toAdd)
 Update the fraction complete estimate assuming that the algorithm has completed a task with estimated RunTime toAdd. More...
 
void failProgress (RunTime aborted)
 Update the fraction complete estimate assuming that the algorithm aborted a task with estimated RunTime toAdd. More...
 

Additional Inherited Members

- Public Types inherited from Mantid::API::Algorithm
using WorkspaceVector = std::vector< std::shared_ptr< Workspace > >
 
- Static Public Member Functions inherited from Mantid::API::Algorithm
static IAlgorithm_sptr fromString (const std::string &input)
 De-serialize an object from a string. More...
 
static IAlgorithm_sptr fromJson (const Json::Value &input)
 De-serialize an object from a Json. More...
 
static IAlgorithm_sptr fromHistory (const AlgorithmHistory &history)
 Construct an object from a history entry. More...
 
- Public Attributes inherited from Mantid::API::Algorithm
bool calledByAlias = false
 Flag to indicate if the algorithm is called by its alias. More...
 
- Static Protected Member Functions inherited from Mantid::API::Algorithm
template<typename NumT >
static bool isEmpty (const NumT toCheck)
 checks that the value was not set by users, uses the value in empty double/int. More...
 
- Protected Attributes inherited from Mantid::API::Algorithm
std::atomic< bool > m_cancel
 Set to true to stop execution. More...
 
std::atomic< bool > m_parallelException
 Set if an exception is thrown, and not caught, within a parallel region. More...
 
std::vector< IWorkspaceProperty * > m_inputWorkspaceProps
 All the WorkspaceProperties that are Input or InOut. Set in execute() More...
 
std::shared_ptr< AlgorithmHistorym_history
 Pointer to the history for the algorithm being executed. More...
 
Kernel::Logger m_log
 Logger for this algorithm. More...
 
Kernel::Loggerg_log
 
std::shared_ptr< AlgorithmHistorym_parentHistory
 Pointer to the parent history object (if set) More...
 
std::vector< WorkspaceVectorm_unrolledInputWorkspaces
 One vector of workspaces for each input workspace property. More...
 
size_t m_groupSize
 Size of the group(s) being processed. More...
 
bool m_usingBaseProcessGroups = false
 distinguish between base processGroups() and overriden/algorithm specific versions More...
 
- Static Protected Attributes inherited from Mantid::API::Algorithm
static size_t g_execCount = 0
 Counter to keep track of algorithm execution order. More...
 

Detailed Description

A base class for a detector diagnostic algorithm.

It has not exec implemenation but provides functions that are common among these algorithms such as calculating the median and writing to a file.

Author
Martyn Gigg, Tessella plc
Date
2010-12-09

Definition at line 30 of file DetectorDiagnostic.h.

Member Enumeration Documentation

◆ RunTime

For the progress bar, estimates of how many additions, or equivalent, member functions will do for each spectrum.

Enumerator
RTGetSolidAngle 

An estimate of how much work SolidAngle will do for each spectrum.

RTGetTotalCounts 

Estimate of the work required from Integrate for each spectrum.

RTGetRate 

Work required by the ConvertToDistribution algorithm.

RTMarkDetects 

Time taken to find failing detectors.

RTWriteFile 

Time taken to find failing detectors.

RTTotal 

The total of all run times.

Definition at line 87 of file DetectorDiagnostic.h.

Constructor & Destructor Documentation

◆ DetectorDiagnostic()

Mantid::Algorithms::DetectorDiagnostic::DetectorDiagnostic ( )

Default constructor.

Definition at line 414 of file DetectorDiagnostic.cpp.

◆ ~DetectorDiagnostic()

virtual Mantid::Algorithms::DetectorDiagnostic::~DetectorDiagnostic ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ advanceProgress()

double Mantid::Algorithms::DetectorDiagnostic::advanceProgress ( double  toAdd)
protected

Update the fraction complete estimate assuming that the algorithm has completed a task with estimated RunTime toAdd.

Update the percentage complete estimate assuming that the algorithm has completed a task with the given estimated run time.

Parameters
toAdd:: the estimated additional run time passed since the last update, where m_TotalTime holds the total algorithm run time
Returns
estimated fraction of algorithm runtime that has passed so far

Definition at line 641 of file DetectorDiagnostic.cpp.

References Mantid::API::Algorithm::interruption_point(), m_fracDone, and m_TotalTime.

Referenced by convertToRate(), Mantid::Algorithms::DetectorEfficiencyVariation::doDetectorTests(), Mantid::Algorithms::MedianDetectorTest::doDetectorTests(), failProgress(), Mantid::Algorithms::MedianDetectorTest::getSolidAngles(), and integrateSpectra().

◆ applyMask()

void Mantid::Algorithms::DetectorDiagnostic::applyMask ( const API::MatrixWorkspace_sptr inputWS,
const API::MatrixWorkspace_sptr maskWS 
)
private

Apply a given mask.

Function to apply a given mask to a workspace.

Parameters
inputWS: the workspace to mask
maskWS: the workspace containing the masking information

Definition at line 334 of file DetectorDiagnostic.cpp.

References Mantid::API::Algorithm::createChildAlgorithm(), m_maxIndex, and m_minIndex.

Referenced by doDetVanTest(), and exec().

◆ calculateMedian()

std::vector< double > Mantid::Algorithms::DetectorDiagnostic::calculateMedian ( const API::MatrixWorkspace input,
bool  excludeZeroes,
const std::vector< std::vector< size_t > > &  indexmap 
)
protected

Calculate the median of the given workspace.

Finds the median of values in single bin histograms rejecting spectra from masked detectors and the results of divide by zero (infinite and NaN).

This assumes that the input workspace contains integrated counts

The median is an average that is less affected by small numbers of very large values.

Parameters
input:: A histogram workspace with one entry in each bin
excludeZeroes:: If true then zeroes will not be included in the median calculation
indexmap:: indexmap
Returns
The median value of the histograms in the workspace that was passed to it
Exceptions
out_of_rangeif a value is negative

Definition at line 553 of file DetectorDiagnostic.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, Mantid::API::ExperimentInfo::getInstrument(), Mantid::Kernel::getStatistics(), Mantid::Kernel::Logger::information(), Mantid::Kernel::Statistics::median, Mantid::Kernel::StatOptions::Median, PARALLEL_CHECK_INTERRUPT_REGION, PARALLEL_CRITICAL, PARALLEL_END_INTERRUPT_REGION, PARALLEL_FOR_IF, PARALLEL_START_INTERRUPT_REGION, Mantid::API::MatrixWorkspace::readY(), Mantid::API::ExperimentInfo::spectrumInfo(), and Mantid::Kernel::threadSafe().

Referenced by Mantid::Algorithms::DetectorEfficiencyVariation::exec(), and Mantid::Algorithms::MedianDetectorTest::exec().

◆ category()

const std::string Mantid::Algorithms::DetectorDiagnostic::category ( ) const
overridevirtual

◆ convertToRate()

API::MatrixWorkspace_sptr Mantid::Algorithms::DetectorDiagnostic::convertToRate ( API::MatrixWorkspace_sptr  workspace)
protected

Convert to a distribution.

Parameters
workspace:: The input workspace to convert to a count rate
Returns
distribution workspace with equiv. data

Definition at line 618 of file DetectorDiagnostic.cpp.

References advanceProgress(), Mantid::API::Algorithm::createChildAlgorithm(), Mantid::API::Algorithm::g_log, Mantid::Kernel::Logger::information(), m_fracDone, RTGetRate, and workspace.

◆ doDetVanTest()

API::MatrixWorkspace_sptr Mantid::Algorithms::DetectorDiagnostic::doDetVanTest ( const API::MatrixWorkspace_sptr inputWS,
int &  nFails 
)
private

Perform checks on detector vanadium.

Function that encapulates the standard detector vanadium tests.

Parameters
inputWS: the detector vanadium workspace to test
nFails: placeholder for the number of failures
Returns
: the resulting mask from the checks

Definition at line 349 of file DetectorDiagnostic.cpp.

References applyMask(), Mantid::API::Algorithm::createChildAlgorithm(), Mantid::API::Algorithm::getProperty(), m_fracDone, m_maxIndex, m_minIndex, m_progStepWidth, m_rangeLower, and m_rangeUpper.

Referenced by exec().

◆ exec()

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

◆ failProgress()

void Mantid::Algorithms::DetectorDiagnostic::failProgress ( RunTime  aborted)
protected

Update the fraction complete estimate assuming that the algorithm aborted a task with estimated RunTime toAdd.

Update the percentage complete estimate assuming that the algorithm aborted a task with the given estimated run time.

Parameters
aborted:: the amount of algorithm run time that was saved by aborting a part of the algorithm, where m_TotalTime holds the total algorithm run time

Definition at line 658 of file DetectorDiagnostic.cpp.

References advanceProgress(), and m_TotalTime.

Referenced by Mantid::Algorithms::MedianDetectorTest::getSolidAngles().

◆ generateEmptyMask()

DataObjects::MaskWorkspace_sptr Mantid::Algorithms::DetectorDiagnostic::generateEmptyMask ( const API::MatrixWorkspace_const_sptr inputWS)
protected

Create a masking workspace to return.

Parameters
inputWSThe workspace to initialize from. The instrument is copied from this.

Definition at line 475 of file DetectorDiagnostic.cpp.

Referenced by Mantid::Algorithms::DetectorEfficiencyVariation::doDetectorTests(), Mantid::Algorithms::CreatePSDBleedMask::exec(), Mantid::Algorithms::FindDetectorsOutsideLimits::exec(), and Mantid::Algorithms::MedianDetectorTest::exec().

◆ init()

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

◆ integrateSpectra()

MatrixWorkspace_sptr Mantid::Algorithms::DetectorDiagnostic::integrateSpectra ( const API::MatrixWorkspace_sptr inputWS,
const int  indexMin,
const int  indexMax,
const double  lower,
const double  upper,
const bool  outputWorkspace2D = false 
)
protected

Get the total counts for each spectra.

Integrate each spectra to get the number of counts.

Parameters
inputWS:: The workspace to integrate
indexMin:: The lower bound of the spectra to integrate
indexMax:: The upper bound of the spectra to integrate
lower:: The lower bound
upper:: The upper bound
outputWorkspace2D:: set to true to output a workspace 2D even if the input is an EventWorkspace
Returns
A workspace containing the integrated counts

Definition at line 433 of file DetectorDiagnostic.cpp.

References advanceProgress(), Mantid::API::Algorithm::createChildAlgorithm(), Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, lower, m_fracDone, RTGetTotalCounts, and upper.

Referenced by Mantid::Algorithms::DetectorEfficiencyVariation::exec(), Mantid::Algorithms::FindDetectorsOutsideLimits::exec(), and Mantid::Algorithms::MedianDetectorTest::exec().

◆ makeInstrumentMap()

std::vector< std::vector< size_t > > Mantid::Algorithms::DetectorDiagnostic::makeInstrumentMap ( const API::MatrixWorkspace countsWS)
protected

method to create the map with all spectra

Definition at line 484 of file DetectorDiagnostic.cpp.

References Mantid::API::MatrixWorkspace::getNumberHistograms().

Referenced by Mantid::Algorithms::DetectorEfficiencyVariation::exec(), and makeMap().

◆ makeMap()

std::vector< std::vector< size_t > > Mantid::Algorithms::DetectorDiagnostic::makeMap ( const API::MatrixWorkspace_sptr countsWS)
protected

method to check which spectra should be grouped when calculating the median

This function will check how to group spectra when calculating median.

Definition at line 492 of file DetectorDiagnostic.cpp.

References Mantid::API::SpectrumInfo::detector(), Mantid::API::Algorithm::g_log, Mantid::Geometry::IComponent::getAncestors(), m_parents, makeInstrumentMap(), and Mantid::Kernel::Logger::warning().

Referenced by Mantid::Algorithms::MedianDetectorTest::exec().

◆ name()

const std::string Mantid::Algorithms::DetectorDiagnostic::name ( ) const
overridevirtual

Algorithm's name for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Reimplemented in Mantid::Algorithms::DetectorEfficiencyVariation, Mantid::Algorithms::FindDetectorsOutsideLimits, and Mantid::Algorithms::MedianDetectorTest.

Definition at line 41 of file DetectorDiagnostic.cpp.

◆ seeAlso()

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

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

Implements Mantid::API::IAlgorithm.

Reimplemented in Mantid::Algorithms::DetectorEfficiencyVariation, Mantid::Algorithms::FindDetectorsOutsideLimits, and Mantid::Algorithms::MedianDetectorTest.

Definition at line 49 of file DetectorDiagnostic.h.

◆ summary()

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

Summary of algorithms purpose.

Implements Mantid::API::Algorithm.

Reimplemented in Mantid::Algorithms::DetectorEfficiencyVariation, and Mantid::Algorithms::FindDetectorsOutsideLimits.

Definition at line 41 of file DetectorDiagnostic.h.

◆ version()

int Mantid::Algorithms::DetectorDiagnostic::version ( ) const
overridevirtual

Algorithm's version for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Reimplemented in Mantid::Algorithms::DetectorEfficiencyVariation, Mantid::Algorithms::FindDetectorsOutsideLimits, and Mantid::Algorithms::MedianDetectorTest.

Definition at line 43 of file DetectorDiagnostic.cpp.

Member Data Documentation

◆ m_fracDone

double Mantid::Algorithms::DetectorDiagnostic::m_fracDone
protected

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

Definition at line 112 of file DetectorDiagnostic.h.

Referenced by advanceProgress(), convertToRate(), Mantid::Algorithms::DetectorEfficiencyVariation::doDetectorTests(), doDetVanTest(), exec(), Mantid::Algorithms::MedianDetectorTest::getSolidAngles(), and integrateSpectra().

◆ m_maxIndex

int Mantid::Algorithms::DetectorDiagnostic::m_maxIndex
protected

Ending workspace index to run tests on.

Definition at line 124 of file DetectorDiagnostic.h.

Referenced by applyMask(), doDetVanTest(), and exec().

◆ m_minIndex

int Mantid::Algorithms::DetectorDiagnostic::m_minIndex
protected

Starting workspace index to run tests on.

Definition at line 122 of file DetectorDiagnostic.h.

Referenced by applyMask(), doDetVanTest(), and exec().

◆ m_parents

int Mantid::Algorithms::DetectorDiagnostic::m_parents
protected

number of parents up, 0 go to instrument

Definition at line 118 of file DetectorDiagnostic.h.

Referenced by makeMap(), and Mantid::Algorithms::MedianDetectorTest::retrieveProperties().

◆ m_progStepWidth

double Mantid::Algorithms::DetectorDiagnostic::m_progStepWidth
protected

The number of tests to be run.

Definition at line 120 of file DetectorDiagnostic.h.

Referenced by doDetVanTest(), and exec().

◆ m_rangeLower

double Mantid::Algorithms::DetectorDiagnostic::m_rangeLower
protected

Starting x-axis value for integrations.

Definition at line 126 of file DetectorDiagnostic.h.

Referenced by doDetVanTest(), and exec().

◆ m_rangeUpper

double Mantid::Algorithms::DetectorDiagnostic::m_rangeUpper
protected

Ending x-axis value for integrations.

Definition at line 128 of file DetectorDiagnostic.h.

Referenced by doDetVanTest(), and exec().

◆ m_TotalTime

int Mantid::Algorithms::DetectorDiagnostic::m_TotalTime
protected

An estimate total number of additions or equilivent required to compute a spectrum.

Definition at line 115 of file DetectorDiagnostic.h.

Referenced by advanceProgress(), and failProgress().


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