Mantid
|
This algorithm loads a SPICE2D file for HFIR SANS into a workspace. More...
#include <LoadSpice2D.h>
Public Member Functions | |
const std::string | category () const override |
Algorithm's category for identification overriding a virtual method. More... | |
int | confidence (Kernel::FileDescriptor &descriptor) const override |
Returns a confidence value that this algorithm can load a file. 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 (these are not validated) algorithms related to this algorithm.A default implementation is provided. 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... | |
Public Member Functions inherited from Mantid::API::IFileLoader< Kernel::FileDescriptor > | |
virtual int | confidence (Kernel::FileDescriptor &descriptor) const=0 |
Returns a confidence value that this algorithm can load a file. More... | |
virtual bool | loadMutipleAsOne () |
Returns a value indicating whether or not loader wants to load multiple files into a single workspace. More... | |
Public Member Functions inherited from Mantid::API::Algorithm | |
Algorithm () | |
Constructor. More... | |
Algorithm (const Algorithm &)=delete | |
Algorithm & | operator= (const Algorithm &)=delete |
~Algorithm () override | |
Virtual destructor. More... | |
void | initialize () override |
Initialization method invoked by the framework. More... | |
bool | execute () override final |
The actions to be performed by the algorithm on a dataset. More... | |
void | addTimer (const std::string &name, const Kernel::time_point_ns &begin, const Kernel::time_point_ns &end) |
void | executeAsChildAlg () override |
Execute as a Child Algorithm. More... | |
std::map< std::string, std::string > | validateInputs () override |
Perform validation of ALL the input properties of the algorithm. More... | |
ExecutionState | executionState () const override |
Gets the current execution state. More... | |
ResultState | resultState () const override |
Gets the current result State. More... | |
bool | isInitialized () const override |
Has the Algorithm already been initialized. More... | |
bool | isExecuted () const override |
Has the Algorithm already been executed successfully. More... | |
bool | isRunning () const override |
True if the algorithm is running. More... | |
bool | isReadyForGarbageCollection () const override |
True if the algorithm is ready for garbage collection. More... | |
bool | isChild () const override |
To query whether algorithm is a child. More... | |
void | setChild (const bool isChild) override |
To set whether algorithm is a child. More... | |
void | enableHistoryRecordingForChild (const bool on) override |
Change the state of the history recording flag. More... | |
bool | isRecordingHistoryForChild () |
void | setAlwaysStoreInADS (const bool doStore) override |
Do we ALWAYS store in the AnalysisDataService? This is set to true for python algorithms' child algorithms. More... | |
bool | getAlwaysStoreInADS () const override |
Returns true if we always store in the AnalysisDataService. More... | |
void | setRethrows (const bool rethrow) override |
Set whether the algorithm will rethrow exceptions. More... | |
Poco::ActiveResult< bool > | executeAsync () override |
Asynchronous execution. More... | |
void | addObserver (const Poco::AbstractObserver &observer) const override |
Add an observer for a notification. More... | |
void | removeObserver (const Poco::AbstractObserver &observer) const override |
Remove an observer. More... | |
void | cancel () override |
Raises the cancel flag. More... | |
bool | getCancel () const |
Returns the cancellation state. More... | |
Kernel::Logger & | getLogger () const |
Returns a reference to the logger. More... | |
void | setLogging (const bool value) override |
Logging can be disabled by passing a value of false. More... | |
bool | isLogging () const override |
returns the status of logging, True = enabled More... | |
void | setLoggingOffset (const int value) override |
gets the logging priority offset More... | |
int | getLoggingOffset () const override |
returns the logging priority offset More... | |
void | setAlgStartupLogging (const bool enabled) override |
disable Logging of start and end messages More... | |
bool | getAlgStartupLogging () const override |
get the state of Logging of start and end messages More... | |
void | setChildStartProgress (const double startProgress) const override |
setting the child start progress More... | |
void | setChildEndProgress (const double endProgress) const override |
setting the child end progress More... | |
std::string | toString () const override |
Serialize an object to a string. More... | |
::Json::Value | toJson () const override |
Serialize an object to a json object. More... | |
virtual std::shared_ptr< Algorithm > | createChildAlgorithm (const std::string &name, const double startProgress=-1., const double endProgress=-1., const bool enableLogging=true, const int &version=-1) |
Create a Child Algorithm. More... | |
void | setupAsChildAlgorithm (const Algorithm_sptr &algorithm, const double startProgress=-1., const double endProgress=-1., const bool enableLogging=true) |
Setup algorithm as child algorithm. More... | |
void | trackAlgorithmHistory (std::shared_ptr< AlgorithmHistory > parentHist) |
set whether we wish to track the child algorithm's history and pass it the parent object to fill. More... | |
void | findWorkspaces (WorkspaceVector &workspaces, unsigned int direction, bool checkADS=false) const |
Populate lists of the workspace properties for a given direction (InOut workspaces are included in both input/output) More... | |
virtual bool | checkGroups () |
Check the input workspace properties for groups. More... | |
virtual bool | processGroups () |
Process WorkspaceGroup inputs. More... | |
void | copyNonWorkspaceProperties (IAlgorithm *alg, int periodNum) |
Copy all the non-workspace properties from this to alg. More... | |
const Parallel::Communicator & | communicator () const |
Returns a const reference to the (MPI) communicator of the algorithm. More... | |
void | setCommunicator (const Parallel::Communicator &communicator) |
Sets the (MPI) communicator of the algorithm. More... | |
void | declareProperty (std::unique_ptr< Kernel::Property > p, const std::string &doc="") override |
Add a property to the list of managed properties. More... | |
void | declareOrReplaceProperty (std::unique_ptr< Kernel::Property > p, const std::string &doc="") override |
Add or replace property in the list of managed properties. More... | |
void | resetProperties () override |
Reset property values back to initial values (blank or default values) More... | |
void | setProperties (const std::string &propertiesJson, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false) override |
Set the ordered list of properties by one string of values, separated by semicolons. More... | |
void | setProperties (const ::Json::Value &jsonValue, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false) override |
Sets all the declared properties from a json object. More... | |
void | setPropertiesWithString (const std::string &propertiesString, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >()) override |
Sets all the declared properties from a string. More... | |
void | setPropertyValue (const std::string &name, const std::string &value) override |
Set the value of a property by string N.B. More... | |
void | setPropertyValueFromJson (const std::string &name, const Json::Value &value) override |
Set the value of a property by Json::Value object. More... | |
void | setPropertyOrdinal (const int &index, const std::string &value) override |
Set the value of a property by an index N.B. More... | |
virtual void | copyPropertiesFrom (const Algorithm &alg) |
Make m_properties point to the same PropertyManager as alg.m_properties. More... | |
bool | existsProperty (const std::string &name) const override |
Checks whether the named property is already in the list of managed property. More... | |
bool | validateProperties () const override |
Validates all the properties in the collection. More... | |
size_t | propertyCount () const override |
Count the number of properties under management. More... | |
std::string | getPropertyValue (const std::string &name) const override |
Get the value of a property as a string. More... | |
const std::vector< Kernel::Property * > & | getProperties () const override |
Get the list of managed properties. More... | |
std::vector< std::string > | getDeclaredPropertyNames () const noexcept override |
Return the list of declared property names. More... | |
TypedValue | getProperty (const std::string &name) const override |
Get the value of a property. More... | |
std::string | asString (bool withDefaultValues=false) const override |
Return the property manager serialized as a string. More... | |
::Json::Value | asJson (bool withDefaultValues=false) const override |
Return the property manager serialized as a json object. More... | |
bool | isDefault (const std::string &name) const |
void | removeProperty (const std::string &name, const bool delproperty=true) override |
Removes the property from management. More... | |
std::unique_ptr< Kernel::Property > | takeProperty (const size_t index) override |
Removes the property from management and returns a pointer to it. More... | |
void | clear () override |
Clears all properties under management. More... | |
void | afterPropertySet (const std::string &) override |
Override this method to perform a custom action right after a property was set. More... | |
void | filterByTime (const Types::Core::DateAndTime &, const Types::Core::DateAndTime &) override |
void | splitByTime (std::vector< Kernel::SplittingInterval > &, std::vector< Kernel::PropertyManager * >) const override |
void | filterByProperty (const Kernel::TimeSeriesProperty< bool > &, const std::vector< std::string > &) override |
Kernel::Property * | getPointerToProperty (const std::string &name) const override |
Get a property by name. More... | |
Kernel::Property * | getPointerToPropertyOrdinal (const int &index) const override |
Get a property by an index. More... | |
virtual void | declareProperty (std::unique_ptr< Property > p, const std::string &doc="")=0 |
Function to declare properties (i.e. store them) More... | |
template<typename T > | |
void | declareProperty (const std::string &name, T value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc="", const unsigned int direction=Direction::Input) |
Add a property of the template type to the list of managed properties. More... | |
template<typename T > | |
void | declareProperty (const std::string &name, T value, const std::string &doc, const unsigned int direction=Direction::Input) |
Add a property to the list of managed properties with no validator. More... | |
template<typename T > | |
void | declareProperty (const std::string &name, T value, const unsigned int direction) |
Add a property of the template type to the list of managed properties. More... | |
void | declareProperty (const std::string &name, const char *value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc=std::string(), const unsigned int direction=Direction::Input) |
Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string). More... | |
void | declareProperty (const std::string &name, const char *value, const std::string &doc, IValidator_sptr validator=std::make_shared< NullValidator >(), const unsigned int direction=Direction::Input) |
Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string). More... | |
void | declareProperty (const std::string &name, const char *value, const unsigned int direction) |
Add a property of string type to the list of managed properties. More... | |
const std::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 Property * | getPointerToProperty (const std::string &name) const =0 |
Get a pointer to property by name. More... | |
virtual const std::vector< Property * > & | getProperties () const =0 |
Get the list of managed properties. More... | |
std::vector< Property * > | getPropertiesInGroup (const std::string &group) const |
Get the list of managed properties in a given group. More... | |
virtual TypedValue | getProperty (const std::string &name) const =0 |
Get the value of a property. More... | |
virtual std::string | getPropertyValue (const std::string &name) const =0 |
Get the value of a property as a string. More... | |
virtual size_t | propertyCount () const =0 |
Returns the number of properties under management. More... | |
virtual void | removeProperty (const std::string &name, const bool delproperty=true)=0 |
Removes the property from management. More... | |
virtual void | resetProperties ()=0 |
virtual void | setProperties (const ::Json::Value &jsonValue, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)=0 |
Sets all the properties from a json object. More... | |
virtual void | setProperties (const std::string &propertiesJson, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)=0 |
Sets all properties from a string. More... | |
virtual void | setPropertiesWithString (const std::string &propertiesString, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >())=0 |
Sets all the declared properties from a string. More... | |
IPropertyManager * | setProperty (const std::string &name, const char *value) |
Specialised version of setProperty template method to handle const char *. More... | |
IPropertyManager * | setProperty (const std::string &name, const std::string &value) |
Specialised version of setProperty template method to handle std::string. More... | |
template<typename T > | |
IPropertyManager * | setProperty (const std::string &name, const T &value) |
Templated method to set the value of a PropertyWithValue. More... | |
template<typename T > | |
IPropertyManager * | setProperty (const std::string &name, std::unique_ptr< T > value) |
Templated method to set the value of a PropertyWithValue from a std::unique_ptr. More... | |
void | setPropertyGroup (const std::string &name, const std::string &group) |
Set the group for a given property. More... | |
virtual void | setPropertyOrdinal (const int &index, const std::string &value)=0 |
Set the value of a property by an index. More... | |
void | setPropertySettings (const std::string &name, std::unique_ptr< IPropertySettings > settings) |
virtual void | setPropertyValue (const std::string &name, const std::string &value)=0 |
Sets property value from a string. More... | |
virtual void | setPropertyValueFromJson (const std::string &name, const Json::Value &value)=0 |
Sets property value from a Json::Value. More... | |
virtual void | splitByTime (std::vector< SplittingInterval > &, std::vector< PropertyManager * >) const =0 |
virtual std::unique_ptr< Property > | takeProperty (const size_t index)=0 |
Removes the property from management and returns a pointer to it. More... | |
void | updatePropertyValues (const IPropertyManager &other) |
Update values of the existing properties. More... | |
virtual bool | validateProperties () const =0 |
Validates all the properties in the collection. More... | |
virtual | ~IPropertyManager ()=default |
Static Public Attributes | |
static const int | nMonitors = 2 |
Number of monitors. More... | |
Private Member Functions | |
void | addMetadataAsRunProperties (const std::map< std::string, std::string > &) |
Adds map of the form key:value as Workspace run properties. More... | |
template<class T > | |
void | addRunProperty (const std::string &name, const T &value, const std::string &units="") |
template<class T > | |
T | addRunProperty (std::map< std::string, std::string > &metadata, const std::string &oldName, const std::string &newName, const std::string &units="") |
Inserts a property in the run with a new name! More... | |
void | createWorkspace () |
void | createWorkspace (const std::vector< int > &data, const std::string &title, double monitor1_counts, double monitor2_counts) |
Creates workspace and loads the data along with 2 monitors! More... | |
void | detectorDistance (std::map< std::string, std::string > &metadata) |
Calculates the detector distances and sets them as Run properties Here fog starts: GPSANS: distance = sample_det_dist + offset! BioSANS: distance = sample_det_dist + offset + sample_to_flange! Mathieu is using sample_det_dist to move the detector later So I'll do the same (Ricardo) June 14th 2016: New changes: sample_det_dist is not available flange_det_dist is new = old sample_det_dist + offset offset is not used GPSANS: distance = flange_det_dist! (sample_to_flange is 0 for GPSANS) BioSANS: distance = flange_det_dist + sample_to_flange! For back compatibility I'm setting the offset to 0 and not reading it from the file Last Changes: If SDD tag is available in the metadata set that as sample detector distance Puts a numeric series in the log with the value of sample_detector_distance. More... | |
void | detectorTranslation (std::map< std::string, std::string > &metadata) |
Puts a numeric series in the log with the value of detector translation. More... | |
void | exec () override |
Overwrites Algorithm method. More... | |
std::vector< int > | getData (const std::string &) |
Parses the data dimensions and stores them as member variables Reads the data and returns a vector. More... | |
void | init () override |
Overwrites Algorithm method. More... | |
std::pair< int, int > | parseDetectorDimensions (const std::string &) |
Parse the 2 integers of the form: INT32[192,256]. More... | |
void | rotateDetector (const double &) |
This will rotate the detector named componentName around z-axis. More... | |
void | runLoadInstrument (const std::string &inst_name, const DataObjects::Workspace2D_sptr &localWorkspace) |
Run LoadInstrument Child Algorithm. More... | |
void | setBeamTrapRunProperty (std::map< std::string, std::string > &metadata) |
Sets the beam trap as Run Property There's several beamstrap position. More... | |
void | setInputPropertiesAsMemberProperties () |
Get the input algorithm properties and sets them as class attributes. More... | |
void | setMetadataAsRunProperties (std::map< std::string, std::string > &metadata) |
void | setSansSpiceXmlFormatVersion (std::map< std::string, std::string > &metadata) |
void | setTimes () |
void | setWavelength (std::map< std::string, std::string > &metadata) |
Gets the wavelength and wavelength spread from the metadata and sets them as class attributes. More... | |
void | throwException (Poco::XML::Element *elem, const std::string &name, const std::string &fileName) |
This method throws not found error if a element is not found in the xml file. More... | |
Private Attributes | |
double | m_dwavelength {0.0} |
Mantid::Types::Core::DateAndTime | m_endTime |
double | m_sansSpiceXmlFormatVersion {0.0} |
Mantid::Types::Core::DateAndTime | m_startTime |
double | m_wavelength {0.0} |
double | m_wavelength_input {0.0} |
double | m_wavelength_spread_input {0.0} |
DataObjects::Workspace2D_sptr | m_workspace |
Mantid::DataHandling::XmlHandler | m_xmlHandler |
Additional Inherited Members | |
Public Types inherited from Mantid::API::Algorithm | |
using | WorkspaceVector = std::vector< std::shared_ptr< Workspace > > |
Static Public Member Functions inherited from Mantid::API::Algorithm | |
static IAlgorithm_sptr | fromString (const std::string &input) |
De-serialize an object from a string. More... | |
static IAlgorithm_sptr | fromJson (const Json::Value &input) |
De-serialize an object from a Json. More... | |
static IAlgorithm_sptr | fromHistory (const AlgorithmHistory &history) |
Construct an object from a history entry. More... | |
Public Attributes inherited from Mantid::API::Algorithm | |
bool | calledByAlias = false |
Flag to indicate if the algorithm is called by its alias. More... | |
Protected Member Functions inherited from Mantid::API::ParallelAlgorithm | |
Parallel::ExecutionMode | getParallelExecutionMode (const std::map< std::string, Parallel::StorageMode > &storageModes) const override |
Get correct execution mode based on input storage modes for an MPI run. More... | |
~ParallelAlgorithm ()=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 const std::string | workspaceMethodOnTypes () const |
Returns a semi-colon separated list of workspace types to attach this algorithm. More... | |
void | cacheWorkspaceProperties () |
Go through the properties and cache the input/output workspace properties for later use. More... | |
void | cacheInputWorkspaceHistories () |
Cache the histories of any input workspaces so they can be copied over after algorithm completion. More... | |
void | setExecutionState (const ExecutionState state) |
Sets the current execution state. More... | |
void | setResultState (const ResultState state) |
Sets the result execution state. More... | |
void | store () |
Stores any output workspaces into the AnalysisDataService. More... | |
void | progress (double p, const std::string &msg="", double estimatedTime=0.0, int progressPrecision=0) |
Sends ProgressNotification. More... | |
void | interruption_point () |
This is called during long-running operations, and check if the algorithm has requested that it be cancelled. More... | |
Poco::NotificationCenter & | notificationCenter () const |
Return a reference to the algorithm's notification dispatcher. More... | |
void | handleChildProgressNotification (const Poco::AutoPtr< ProgressNotification > &pNf) |
Observation slot for child algorithm progress notification messages, these are scaled and then signalled for this algorithm. More... | |
const Poco::AbstractObserver & | progressObserver () const |
Return a reference to the algorithm's object that is reporting progress. More... | |
bool | isWorkspaceProperty (const Kernel::Property *const prop) const |
checks the property is a workspace property More... | |
bool | trackingHistory () |
get whether we are tracking the history for this algorithm, More... | |
virtual void | fillHistory () |
Copy workspace history for input workspaces to output workspaces and record the history for ths algorithm. More... | |
virtual void | setOtherProperties (IAlgorithm *alg, const std::string &propertyName, const std::string &propertyValue, int periodNum) |
Virtual method to set the non workspace properties for this algorithm. More... | |
template<typename T , const int AllowedIndexTypes = static_cast<int>(IndexType::WorkspaceIndex), typename... WSPropArgs, typename = typename std::enable_if<std::is_convertible<T *, MatrixWorkspace *>::value>::type> | |
void | declareWorkspaceInputProperties (const std::string &propertyName, const std::string &doc, WSPropArgs &&...wsPropArgs) |
Protected Member Functions inherited from Mantid::Kernel::IPropertyManager | |
virtual void | afterPropertySet (const std::string &) |
Override this method to perform a custom action right after a property was set. More... | |
virtual void | clear ()=0 |
Clears all properties under management. More... | |
virtual Property * | getPointerToPropertyOrdinal (const int &index) const =0 |
Get a property by an index. More... | |
template<typename T > | |
T | getValue (const std::string &name) const |
Templated method to get the value of a property. More... | |
template<> | |
MANTID_KERNEL_DLL PropertyManager_sptr | getValue (const std::string &name) const |
template<> | |
MANTID_KERNEL_DLL PropertyManager_const_sptr | getValue (const std::string &name) const |
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< AlgorithmHistory > | m_history |
Pointer to the history for the algorithm being executed. More... | |
Kernel::Logger | m_log |
Logger for this algorithm. More... | |
Kernel::Logger & | g_log |
std::shared_ptr< AlgorithmHistory > | m_parentHistory |
Pointer to the parent history object (if set) More... | |
std::vector< WorkspaceVector > | m_unrolledInputWorkspaces |
One vector of workspaces for each input workspace property. More... | |
size_t | m_groupSize |
Size of the group(s) being processed. More... | |
bool | m_usingBaseProcessGroups = false |
distinguish between base processGroups() and overriden/algorithm specific versions More... | |
Static Protected Attributes inherited from Mantid::API::Algorithm | |
static size_t | g_execCount = 0 |
Counter to keep track of algorithm execution order. More... | |
This algorithm loads a SPICE2D file for HFIR SANS into a workspace.
Required properties:
This file is part of Mantid.
Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
File change history is stored at: https://github.com/mantidproject/mantid. Code Documentation is available at: http://doxygen.mantidproject.org
Definition at line 58 of file LoadSpice2D.h.
|
private |
Adds map of the form key:value as Workspace run properties.
Definition at line 225 of file LoadSpice2D.cpp.
References m_workspace.
Referenced by exec().
|
private |
Definition at line 382 of file LoadSpice2D.cpp.
References m_workspace, name(), and value.
|
private |
Inserts a property in the run with a new name!
Definition at line 372 of file LoadSpice2D.cpp.
References m_workspace, and value.
|
inlineoverridevirtual |
Algorithm's category for identification overriding a virtual method.
Reimplemented from Mantid::API::Algorithm.
Definition at line 73 of file LoadSpice2D.h.
|
overridevirtual |
Returns a confidence value that this algorithm can load a file.
Return the confidence with with this algorithm can load the file.
descriptor | A descriptor for the file |
Implements Mantid::API::IFileLoader< Kernel::FileDescriptor >.
Definition at line 98 of file LoadSpice2D.cpp.
References confidence(), Mantid::Kernel::FileDescriptor::data(), Mantid::Kernel::FileDescriptor::extension(), and Mantid::Kernel::FileDescriptor::filename().
Referenced by confidence().
|
private |
References Mantid::API::createWorkspace().
Referenced by exec().
|
private |
Creates workspace and loads the data along with 2 monitors!
Definition at line 341 of file LoadSpice2D.cpp.
References count, Mantid::DataObjects::create(), error, fabs, Mantid::Kernel::SingletonHolder< T >::Instance(), m_dwavelength, m_wavelength, m_workspace, nMonitors, and Mantid::DataHandling::store_value().
|
private |
Calculates the detector distances and sets them as Run properties Here fog starts: GPSANS: distance = sample_det_dist + offset! BioSANS: distance = sample_det_dist + offset + sample_to_flange! Mathieu is using sample_det_dist to move the detector later So I'll do the same (Ricardo) June 14th 2016: New changes: sample_det_dist is not available flange_det_dist is new = old sample_det_dist + offset offset is not used GPSANS: distance = flange_det_dist! (sample_to_flange is 0 for GPSANS) BioSANS: distance = flange_det_dist + sample_to_flange! For back compatibility I'm setting the offset to 0 and not reading it from the file Last Changes: If SDD tag is available in the metadata set that as sample detector distance Puts a numeric series in the log with the value of sample_detector_distance.
Definition at line 515 of file LoadSpice2D.cpp.
References Mantid::API::LogManager::addLogData(), Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::declareProperty(), Mantid::API::g_log, m_workspace, and Mantid::Kernel::Direction::Output.
Referenced by exec().
|
private |
Puts a numeric series in the log with the value of detector translation.
Definition at line 572 of file LoadSpice2D.cpp.
References Mantid::API::LogManager::addLogData(), Mantid::Kernel::Logger::debug(), detectorTranslation(), Mantid::API::g_log, and m_workspace.
Referenced by detectorTranslation(), and exec().
|
overrideprivatevirtual |
Overwrites Algorithm method.
Implements Mantid::API::Algorithm.
Definition at line 158 of file LoadSpice2D.cpp.
References addMetadataAsRunProperties(), createWorkspace(), detectorDistance(), detectorTranslation(), Mantid::DataHandling::XmlHandler::get_metadata(), getData(), m_workspace, m_xmlHandler, rotateDetector(), runLoadInstrument(), setInputPropertiesAsMemberProperties(), setMetadataAsRunProperties(), Mantid::Kernel::IPropertyManager::setProperty(), setSansSpiceXmlFormatVersion(), setTimes(), and setWavelength().
|
private |
Parses the data dimensions and stores them as member variables Reads the data and returns a vector.
Definition at line 288 of file LoadSpice2D.cpp.
References Mantid::Kernel::Logger::debug(), Mantid::Kernel::Logger::error(), Mantid::API::g_log, Mantid::DataHandling::XmlHandler::get_attributes_from_tag(), Mantid::DataHandling::XmlHandler::get_subnodes(), Mantid::DataHandling::XmlHandler::get_text_from_tag(), m_xmlHandler, and parseDetectorDimensions().
Referenced by exec().
|
overrideprivatevirtual |
Overwrites Algorithm method.
Overwrites Algorithm Init method.
Implements Mantid::API::Algorithm.
Definition at line 130 of file LoadSpice2D.cpp.
References Mantid::API::Algorithm::declareProperty(), Mantid::EMPTY_DBL(), Mantid::API::FileProperty::Load, and Mantid::Kernel::Direction::Output.
|
inlineoverridevirtual |
Algorithm's name for identification overriding a virtual method.
Implements Mantid::API::Algorithm.
Definition at line 61 of file LoadSpice2D.h.
Referenced by addRunProperty(), and throwException().
|
private |
Parse the 2 integers of the form: INT32[192,256].
dims_str | : INT32[192,256] |
Definition at line 202 of file LoadSpice2D.cpp.
References Mantid::Kernel::Strings::convert(), Mantid::API::g_log, and Mantid::Kernel::Logger::notice().
Referenced by getData().
|
private |
This will rotate the detector named componentName around z-axis.
angle | in degrees |
Definition at line 625 of file LoadSpice2D.cpp.
References Mantid::API::LogManager::addLogData(), Mantid::API::g_log, m_workspace, and Mantid::Kernel::Logger::notice().
Referenced by exec().
|
private |
Run LoadInstrument Child Algorithm.
Run the Child Algorithm LoadInstrument (as for LoadRaw)
inst_name | :: The name written in the Nexus file |
localWorkspace | :: The workspace to insert the instrument into |
Definition at line 590 of file LoadSpice2D.cpp.
References Mantid::API::Algorithm::createChildAlgorithm(), Mantid::API::g_log, and Mantid::Kernel::Logger::information().
Referenced by exec().
|
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 71 of file LoadSpice2D.h.
|
private |
Sets the beam trap as Run Property There's several beamstrap position.
We have to find the maximum of every motor above certain treshold. The maximum motor position will be the trap in use.
Notes: Resting positions: GPSANS: 1.0 BIOSANS: 9.999980
Working positions: GPSANS: 548.999969 BIOSANS: 544.999977
Definition at line 401 of file LoadSpice2D.cpp.
References Mantid::Kernel::Logger::debug(), Mantid::API::g_log, and index.
Referenced by setMetadataAsRunProperties().
|
private |
Get the input algorithm properties and sets them as class attributes.
Definition at line 237 of file LoadSpice2D.cpp.
References Mantid::Kernel::Logger::debug(), Mantid::API::g_log, Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::getPropertyValue(), m_wavelength_input, m_wavelength_spread_input, and m_xmlHandler.
Referenced by exec().
|
private |
Definition at line 450 of file LoadSpice2D.cpp.
References Mantid::Kernel::Logger::debug(), Mantid::API::g_log, m_dwavelength, m_endTime, m_sansSpiceXmlFormatVersion, m_startTime, m_wavelength, m_workspace, and setBeamTrapRunProperty().
Referenced by exec().
|
private |
Definition at line 644 of file LoadSpice2D.cpp.
References Mantid::Kernel::Logger::debug(), Mantid::API::g_log, and m_sansSpiceXmlFormatVersion.
Referenced by exec().
|
private |
Definition at line 442 of file LoadSpice2D.cpp.
References Mantid::DataHandling::XmlHandler::get_attributes_from_tag(), m_endTime, m_startTime, and m_xmlHandler.
Referenced by exec().
|
private |
Gets the wavelength and wavelength spread from the metadata and sets them as class attributes.
Definition at line 258 of file LoadSpice2D.cpp.
References Mantid::Kernel::Logger::debug(), Mantid::API::g_log, Mantid::API::Algorithm::isEmpty(), m_dwavelength, m_startTime, m_wavelength, m_wavelength_input, and m_wavelength_spread_input.
Referenced by exec().
|
inlineoverridevirtual |
Summary of algorithms purpose.
Implements Mantid::API::Algorithm.
Definition at line 63 of file LoadSpice2D.h.
|
private |
This method throws not found error if a element is not found in the xml file.
Definition at line 613 of file LoadSpice2D.cpp.
References name().
|
inlineoverridevirtual |
Algorithm's version for identification overriding a virtual method.
Implements Mantid::API::Algorithm.
Definition at line 70 of file LoadSpice2D.h.
|
private |
Definition at line 119 of file LoadSpice2D.h.
Referenced by createWorkspace(), setMetadataAsRunProperties(), and setWavelength().
|
private |
Definition at line 122 of file LoadSpice2D.h.
Referenced by setMetadataAsRunProperties(), and setTimes().
|
private |
Definition at line 120 of file LoadSpice2D.h.
Referenced by setMetadataAsRunProperties(), and setSansSpiceXmlFormatVersion().
|
private |
Definition at line 121 of file LoadSpice2D.h.
Referenced by setMetadataAsRunProperties(), setTimes(), and setWavelength().
|
private |
Definition at line 118 of file LoadSpice2D.h.
Referenced by createWorkspace(), setMetadataAsRunProperties(), and setWavelength().
|
private |
Definition at line 115 of file LoadSpice2D.h.
Referenced by setInputPropertiesAsMemberProperties(), and setWavelength().
|
private |
Definition at line 116 of file LoadSpice2D.h.
Referenced by setInputPropertiesAsMemberProperties(), and setWavelength().
|
private |
Definition at line 114 of file LoadSpice2D.h.
Referenced by addMetadataAsRunProperties(), addRunProperty(), createWorkspace(), detectorDistance(), detectorTranslation(), exec(), rotateDetector(), and setMetadataAsRunProperties().
|
private |
Definition at line 117 of file LoadSpice2D.h.
Referenced by exec(), getData(), setInputPropertiesAsMemberProperties(), and setTimes().
|
static |