Mantid
|
Loads an file in ISIS RAW format and stores it in a 2D workspace (Workspace2D class). More...
#include <DataHandling/LoadRaw3.h>
Public Member Functions | |
const std::string | category () const override |
Algorithm's category for identification overriding a virtual method. More... | |
LoadRaw3 () | |
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 (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::DataHandling::LoadRawHelper | |
int | confidence (Kernel::FileDescriptor &descriptor) const override |
Returns a confidence value that this algorithm can load a file. More... | |
LoadRawHelper () | |
Default constructor. More... | |
void | loadRunParameters (const API::MatrixWorkspace_sptr &localWorkspace, ISISRAW *const =nullptr) const |
Read in run parameters Public so that LoadRaw2 can use it. More... | |
const std::string | name () const override |
Algorithm's name for identification overriding a virtual method. More... | |
FILE * | openRawFile (const std::string &fileName) |
Opens Raw File. 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... | |
~LoadRawHelper () | |
Destructor. 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 |
Private Member Functions | |
void | excludeMonitors (FILE *file, const int &period, const std::vector< specnum_t > &monitorList, const DataObjects::Workspace2D_sptr &ws_sptr) |
creates output workspace, monitors excluded from this workspace More... | |
void | exec () override |
Overwrites Algorithm method. More... | |
int | getPreviousPeriod (int period) const |
get the previous period number More... | |
void | includeMonitors (FILE *file, const int64_t &period, const DataObjects::Workspace2D_sptr &ws_sptr) |
creates output workspace whcih includes monitors More... | |
void | init () override |
Overwrites Algorithm method. More... | |
bool | isMonitor (const std::vector< specnum_t > &monitorIndexes, specnum_t spectrumNum) |
returns true if the given spectrum is a monitor More... | |
bool | isPeriodIncluded (int period) const |
check if a period should be loaded More... | |
bool | isSelectedPeriods () const |
return true if loading a selection of periods More... | |
void | separateMonitors (FILE *file, const int64_t &period, const std::vector< specnum_t > &monitorList, const DataObjects::Workspace2D_sptr &ws_sptr, const DataObjects::Workspace2D_sptr &mws_sptr) |
creates two output workspaces none normal workspace and separate one for monitors More... | |
void | setOptionalProperties () |
sets optional properties More... | |
void | setProg (double) |
sets progress taking account of progress time taken up by ChildAlgorithms More... | |
void | skipPeriod (FILE *file, const int64_t &period) |
skip all spectra in a period More... | |
void | validateWorkspaceSizes (bool bexcludeMonitors, bool bseparateMonitors, const int64_t normalwsSpecs, const int64_t monitorwsSpecs) |
validate workspace sizes More... | |
Private Attributes | |
std::vector< std::string > | m_cache_options |
Allowed values for the cache property. More... | |
std::string | m_filename |
The name and path of the input file. More... | |
int64_t | m_lengthIn |
Read in the time bin boundaries. More... | |
int64_t | m_noTimeRegimes |
number of time regime More... | |
specnum_t | m_numberOfSpectra |
The number of spectra in the raw file. More... | |
std::vector< int > | m_periodList |
A list of periods to read. Each value is between 1 and m_numberOfPeriods. More... | |
double | m_prog |
The current value of the progress counter. More... | |
double | m_prog_end |
double | m_prog_start |
Start and ends values of progress counter. More... | |
std::map< int64_t, int64_t > | m_specTimeRegimes |
A map for storing the time regime for each spectrum. More... | |
std::vector< std::shared_ptr< HistogramData::HistogramX > > | m_timeChannelsVec |
time channels vector More... | |
int64_t | m_total_specs |
total number of specs 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::DataHandling::LoadRawHelper | |
static API::WorkspaceGroup_sptr | createGroupWorkspace () |
creates shared pointer to group workspace More... | |
static void | createMonitorWorkspace (DataObjects::Workspace2D_sptr &monws_sptr, const DataObjects::Workspace2D_sptr &normalws_sptr, API::WorkspaceGroup_sptr &mongrp_sptr, const int64_t mwsSpecs, const int64_t nwsSpecs, const int64_t numberOfPeriods, const int64_t lengthIn, const std::string &title, API::Algorithm *const pAlg) |
creates monitor workspace More... | |
static DataObjects::Workspace2D_sptr | createWorkspace (const DataObjects::Workspace2D_sptr &ws_sptr, int64_t nVectors=-1, int64_t xLengthIn=-1, int64_t yLengthIn=-1) |
creates shared pointer to workspace from parent workspace More... | |
static DataObjects::Workspace2D_sptr | createWorkspace (int64_t nVectors, int64_t xlengthIn, int64_t ylengthIn, const std::string &title) |
overloaded method to create shared pointer to workspace More... | |
static Types::Core::DateAndTime | extractEndTime (ISISRAW &isisRaw) |
Extract the end time from a raw file. More... | |
static Types::Core::DateAndTime | extractStartTime (ISISRAW &isisRaw) |
Extract the start time from a raw file. More... | |
static bool | isExcludeMonitors (const std::string &monitorOption) |
returns true if the Exclude Monitor option(property) selected More... | |
static bool | isIncludeMonitors (const std::string &monitorOption) |
returns true if the Include Monitor Option selected More... | |
static bool | isSeparateMonitors (const std::string &monitorOption) |
returns true if the Separate Monitor Option selected More... | |
static void | ProcessLoadMonitorOptions (bool &bincludeMonitors, bool &bseparateMonitors, bool &bexcludeMonitors, API::Algorithm *const pAlgo) |
The method to interpret LoadMonitors property options and convert then into boolean values. More... | |
static std::list< std::string > | searchForLogFiles (const Poco::Path &pathToRawFile) |
Search for the log files in the workspace, and output their names as a list. More... | |
static void | setWorkspaceProperty (const DataObjects::Workspace2D_sptr &ws_sptr, const API::WorkspaceGroup_sptr &grpws_sptr, const int64_t period, bool bmonitors, API::Algorithm *const pAlg) |
overloaded method to set the workspace property More... | |
static void | setWorkspaceProperty (const std::string &propertyName, const std::string &title, const API::WorkspaceGroup_sptr &grpws_sptr, const DataObjects::Workspace2D_sptr &ws_sptr, int64_t numberOfPeriods, bool bMonitor, API::Algorithm *const pAlg) |
sets the workspace property More... | |
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::DataHandling::LoadRawHelper | |
specnum_t | calculateWorkspaceSize () |
calculate workspace size More... | |
void | calculateWorkspacesizes (const std::vector< specnum_t > &monitorSpecList, specnum_t &normalwsSpecs, specnum_t &monitorwsSpecs) |
calculate workspace sizes if separate or exclude monitors are selected More... | |
void | checkOptionalProperties () |
Validates the optional 'spectra to read' properties, if they have been set. More... | |
void | createPeriodLogs (int64_t period, const DataObjects::Workspace2D_sptr &local_workspace) |
Create the period specific logs. More... | |
std::vector< specnum_t > | getmonitorSpectrumList (const API::SpectrumDetectorMapping &mapping) |
gets the monitor spectrum list from the workspace More... | |
int | getNumberofTimeRegimes () |
number of time regimes More... | |
float | getProtonCharge () const |
get proton charge from raw file More... | |
std::vector< std::shared_ptr< HistogramData::HistogramX > > | getTimeChannels (const int64_t ®imes, const int64_t &lengthIn) |
Constructs the time channel (X) vector(s) More... | |
void | init () override |
Overwrites Algorithm method. More... | |
void | ioRaw (FILE *file, bool from_file) |
calls isisRaw ioraw More... | |
ISISRAW2 & | isisRaw () const |
return an reference to the ISISRAW2 reader More... | |
void | loadSpectra (FILE *file, const int &period, const int &total_specs, const DataObjects::Workspace2D_sptr &ws_sptr, const std::vector< std::shared_ptr< HistogramData::HistogramX > > &) |
load the spectra More... | |
bool | readData (FILE *file, int hist) |
reads data More... | |
bool | readData (FILE *file, int64_t hist) |
void | readTitle (FILE *file, std::string &title) |
Reads title from the isisraw class. More... | |
void | readworkspaceParameters (specnum_t &numberOfSpectra, int &numberOfPeriods, int64_t &lengthIn, int64_t &noTimeRegimes) |
reads workspace parameters like number of histograms,size of vectors etc More... | |
void | reset () |
resets the isisraw shared pointer More... | |
void | runLoadInstrument (const std::string &fileName, const DataObjects::Workspace2D_sptr &, double, double) |
loadinstrument Child Algorithm More... | |
void | runLoadInstrumentFromRaw (const std::string &fileName, const DataObjects::Workspace2D_sptr &) |
loadinstrumentfromraw algorithm More... | |
void | runLoadLog (const std::string &fileName, const DataObjects::Workspace2D_sptr &, double, double) |
load log algorithm More... | |
void | runLoadMappingTable (const std::string &fileName, const DataObjects::Workspace2D_sptr &) |
loadinstrumentfromraw Child Algorithm More... | |
void | setOptionalProperties (const int &spec_min, const int &spec_max, const std::vector< int > &spec_list) |
sets optional properties like spec_min,spec_max etc More... | |
void | setProtonCharge (API::Run &run) |
set proton charge More... | |
void | setRunNumber (API::Run &run) |
Stores the run number in the sample's logs. More... | |
void | setWorkspaceData (const DataObjects::Workspace2D_sptr &newWorkspace, const std::vector< std::shared_ptr< HistogramData::HistogramX > > &timeChannelsVec, int64_t wsIndex, specnum_t nspecNum, int64_t noTimeRegimes, int64_t lengthIn, int64_t binStart) |
This method sets the raw file data to workspace vectors. More... | |
void | skipData (FILE *file, int hist) |
skips histrogram data from raw file. More... | |
void | skipData (FILE *file, int64_t hist) |
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::DataHandling::LoadRawHelper | |
bool | m_interval |
Have the spectrum_min/max properties been set? More... | |
bool | m_list |
Has the spectrum_list property been set? More... | |
int | m_numberOfPeriods |
The number of periods in the raw file. More... | |
std::vector< specnum_t > | m_spec_list |
The value of the spectrum_list property. More... | |
specnum_t | m_spec_max |
The value of the spectrum_max property. More... | |
specnum_t | m_spec_min |
The value of the spectrum_min property. 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... | |
Loads an file in ISIS RAW format and stores it in a 2D workspace (Workspace2D class).
LoadRaw is an algorithm and LoadRawHelper class and overrides the init() & exec() methods. LoadRaw3 uses less memory by only loading up the datablocks as required.
Definition at line 30 of file LoadRaw3.h.
Mantid::DataHandling::LoadRaw3::LoadRaw3 | ( | ) |
|
inlineoverridevirtual |
Algorithm's category for identification overriding a virtual method.
Reimplemented from Mantid::API::Algorithm.
Definition at line 49 of file LoadRaw3.h.
|
private |
creates output workspace, monitors excluded from this workspace
This method creates outputworkspace excluding monitors.
file | :: -pointer to file |
period | :: period number |
monitorList | :: a list containing the spectrum numbers for monitors |
ws_sptr | :: shared pointer to workspace |
Definition at line 291 of file LoadRaw3.cpp.
References Mantid::API::Algorithm::interruption_point(), isMonitor(), m_lengthIn, Mantid::DataHandling::LoadRawHelper::m_list, m_noTimeRegimes, Mantid::DataHandling::LoadRawHelper::m_numberOfPeriods, m_numberOfSpectra, m_prog, Mantid::DataHandling::LoadRawHelper::m_spec_list, Mantid::DataHandling::LoadRawHelper::m_spec_max, Mantid::DataHandling::LoadRawHelper::m_spec_min, m_timeChannelsVec, m_total_specs, Mantid::API::Algorithm::progress(), Mantid::DataHandling::LoadRawHelper::readData(), setProg(), Mantid::DataHandling::LoadRawHelper::setWorkspaceData(), and Mantid::DataHandling::LoadRawHelper::skipData().
Referenced by exec().
|
overrideprivatevirtual |
Overwrites Algorithm method.
Executes the algorithm.
Reading in the file and creating and populating the output workspace
Exception::FileError | If the RAW file cannot be found/opened |
std::invalid_argument | If the optional properties are set to invalid values |
Implements Mantid::API::Algorithm.
Definition at line 84 of file LoadRaw3.cpp.
References Mantid::API::LogManager::addProperty(), Mantid::DataHandling::LoadRawHelper::calculateWorkspaceSize(), Mantid::DataHandling::LoadRawHelper::calculateWorkspacesizes(), Mantid::DataHandling::LoadRawHelper::checkOptionalProperties(), Mantid::DataHandling::LoadRawHelper::createGroupWorkspace(), Mantid::DataHandling::LoadRawHelper::createMonitorWorkspace(), Mantid::DataHandling::LoadRawHelper::createPeriodLogs(), Mantid::DataHandling::LoadRawHelper::createWorkspace(), Mantid::Kernel::Logger::debug(), excludeMonitors(), Mantid::API::g_log, Mantid::DataHandling::LoadRawHelper::getmonitorSpectrumList(), getPreviousPeriod(), Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::getPropertyValue(), Mantid::DataHandling::LoadRawHelper::getTimeChannels(), includeMonitors(), Mantid::Kernel::Logger::information(), Mantid::DataHandling::LoadRawHelper::isisRaw(), isPeriodIncluded(), isSelectedPeriods(), Mantid::DataHandling::LoadRawHelper::loadRunParameters(), m_filename, m_lengthIn, m_noTimeRegimes, Mantid::DataHandling::LoadRawHelper::m_numberOfPeriods, m_numberOfSpectra, m_periodList, m_prog, m_prog_start, m_timeChannelsVec, m_total_specs, Mantid::DataHandling::LoadRawHelper::openRawFile(), Mantid::DataHandling::LoadRawHelper::ProcessLoadMonitorOptions(), Mantid::API::Algorithm::progress(), Mantid::DataHandling::LoadRawHelper::readTitle(), Mantid::DataHandling::LoadRawHelper::readworkspaceParameters(), Mantid::API::LogManager::removeLogData(), Mantid::DataHandling::LoadRawHelper::reset(), Mantid::DataHandling::LoadRawHelper::runLoadInstrument(), Mantid::DataHandling::LoadRawHelper::runLoadLog(), separateMonitors(), setOptionalProperties(), setProg(), Mantid::DataHandling::LoadRawHelper::setProtonCharge(), Mantid::DataHandling::LoadRawHelper::setRunNumber(), Mantid::DataHandling::LoadRawHelper::setWorkspaceProperty(), Mantid::DataHandling::LoadRawHelper::skipData(), skipPeriod(), and validateWorkspaceSizes().
|
private |
get the previous period number
Get the period number loaded before given.
period | :: A period number being loaded (1-based). |
Definition at line 442 of file LoadRaw3.cpp.
References isSelectedPeriods(), and m_periodList.
Referenced by exec().
|
private |
creates output workspace whcih includes monitors
This method creates outputworkspace including monitors.
file | :: -pointer to file |
period | :: period number |
ws_sptr | :: shared pointer to workspace |
Definition at line 336 of file LoadRaw3.cpp.
References Mantid::API::Algorithm::interruption_point(), m_lengthIn, Mantid::DataHandling::LoadRawHelper::m_list, m_noTimeRegimes, Mantid::DataHandling::LoadRawHelper::m_numberOfPeriods, m_numberOfSpectra, m_prog, Mantid::DataHandling::LoadRawHelper::m_spec_list, Mantid::DataHandling::LoadRawHelper::m_spec_max, Mantid::DataHandling::LoadRawHelper::m_spec_min, m_timeChannelsVec, m_total_specs, Mantid::API::Algorithm::progress(), Mantid::DataHandling::LoadRawHelper::readData(), setProg(), Mantid::DataHandling::LoadRawHelper::setWorkspaceData(), and Mantid::DataHandling::LoadRawHelper::skipData().
Referenced by exec().
|
overrideprivatevirtual |
Overwrites Algorithm method.
Initialization method.
Implements Mantid::API::Algorithm.
Definition at line 39 of file LoadRaw3.cpp.
References Mantid::API::Algorithm::declareProperty(), Mantid::EMPTY_INT(), and Mantid::DataHandling::LoadRawHelper::init().
|
private |
returns true if the given spectrum is a monitor
This method checks given spectrum is a monitor.
monitorIndexes | :: a vector holding the list of monitors |
spectrumNum | :: the requested spectrum number |
Definition at line 506 of file LoadRaw3.cpp.
Referenced by excludeMonitors(), and separateMonitors().
|
private |
check if a period should be loaded
Check if a period should be loaded.
period | :: A period to check (0-based). |
Definition at line 434 of file LoadRaw3.cpp.
References isSelectedPeriods(), and m_periodList.
Referenced by exec().
|
inlineprivate |
return true if loading a selection of periods
Definition at line 79 of file LoadRaw3.h.
Referenced by exec(), getPreviousPeriod(), and isPeriodIncluded().
|
inlineoverridevirtual |
Algorithm's name for identification overriding a virtual method.
Implements Mantid::API::Algorithm.
Definition at line 36 of file LoadRaw3.h.
|
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 45 of file LoadRaw3.h.
|
private |
creates two output workspaces none normal workspace and separate one for monitors
This method separates monitors and creates two outputworkspaces.
file | :: -pointer to file |
period | :: period number |
monitorList | :: -a list containing the spectrum numbers for monitors |
ws_sptr | :: -shared pointer to workspace |
mws_sptr | :: -shared pointer to monitor workspace |
Definition at line 378 of file LoadRaw3.cpp.
References Mantid::API::Algorithm::interruption_point(), isMonitor(), m_lengthIn, Mantid::DataHandling::LoadRawHelper::m_list, m_noTimeRegimes, Mantid::DataHandling::LoadRawHelper::m_numberOfPeriods, m_numberOfSpectra, m_prog, Mantid::DataHandling::LoadRawHelper::m_spec_list, Mantid::DataHandling::LoadRawHelper::m_spec_max, Mantid::DataHandling::LoadRawHelper::m_spec_min, m_timeChannelsVec, m_total_specs, Mantid::API::Algorithm::progress(), Mantid::DataHandling::LoadRawHelper::readData(), setProg(), Mantid::DataHandling::LoadRawHelper::setWorkspaceData(), and Mantid::DataHandling::LoadRawHelper::skipData().
Referenced by exec().
|
private |
sets optional properties
This sets the optional property to the LoadRawHelper class.
Definition at line 455 of file LoadRaw3.cpp.
References Mantid::API::Algorithm::getProperty(), Mantid::DataHandling::LoadRawHelper::m_numberOfPeriods, m_periodList, Mantid::DataHandling::LoadRawHelper::m_spec_list, Mantid::DataHandling::LoadRawHelper::m_spec_max, and Mantid::DataHandling::LoadRawHelper::m_spec_min.
Referenced by exec().
|
private |
sets progress taking account of progress time taken up by ChildAlgorithms
This sets the progress taking account of progress time taken up by ChildAlgorithms.
Definition at line 477 of file LoadRaw3.cpp.
References m_prog, m_prog_end, and m_prog_start.
Referenced by excludeMonitors(), exec(), includeMonitors(), and separateMonitors().
|
private |
skip all spectra in a period
Skip all spectra in a period.
file | :: -pointer to file |
period | :: period number |
Definition at line 424 of file LoadRaw3.cpp.
References m_numberOfSpectra, and Mantid::DataHandling::LoadRawHelper::skipData().
Referenced by exec().
|
inlineoverridevirtual |
Summary of algorithms purpose.
Implements Mantid::API::Algorithm.
Definition at line 38 of file LoadRaw3.h.
|
private |
validate workspace sizes
This method validates workspace sizes if exclude monitors or separate monitors options is selected.
bexcludeMonitors | :: boolean option for exclude monitors |
bseparateMonitors | :: boolean option for separate monitors |
normalwsSpecs | :: number of spectra in the output workspace excluding monitors |
monitorwsSpecs | :: number of monitor spectra |
Definition at line 487 of file LoadRaw3.cpp.
Referenced by exec().
|
inlineoverridevirtual |
Algorithm's version for identification overriding a virtual method.
Implements Mantid::API::Algorithm.
Definition at line 44 of file LoadRaw3.h.
|
private |
Allowed values for the cache property.
Definition at line 97 of file LoadRaw3.h.
|
private |
The name and path of the input file.
Definition at line 92 of file LoadRaw3.h.
Referenced by exec().
|
private |
Read in the time bin boundaries.
Definition at line 109 of file LoadRaw3.h.
Referenced by excludeMonitors(), exec(), includeMonitors(), and separateMonitors().
|
private |
number of time regime
Definition at line 101 of file LoadRaw3.h.
Referenced by excludeMonitors(), exec(), includeMonitors(), and separateMonitors().
|
private |
The number of spectra in the raw file.
Definition at line 95 of file LoadRaw3.h.
Referenced by excludeMonitors(), exec(), includeMonitors(), separateMonitors(), and skipPeriod().
|
private |
A list of periods to read. Each value is between 1 and m_numberOfPeriods.
Definition at line 115 of file LoadRaw3.h.
Referenced by exec(), getPreviousPeriod(), isPeriodIncluded(), and setOptionalProperties().
|
private |
The current value of the progress counter.
Definition at line 103 of file LoadRaw3.h.
Referenced by excludeMonitors(), exec(), includeMonitors(), separateMonitors(), and setProg().
|
private |
Definition at line 106 of file LoadRaw3.h.
Referenced by setProg().
|
private |
Start and ends values of progress counter.
Definition at line 105 of file LoadRaw3.h.
|
private |
A map for storing the time regime for each spectrum.
Definition at line 99 of file LoadRaw3.h.
|
private |
time channels vector
Definition at line 111 of file LoadRaw3.h.
Referenced by excludeMonitors(), exec(), includeMonitors(), and separateMonitors().
|
private |
total number of specs
Definition at line 113 of file LoadRaw3.h.
Referenced by excludeMonitors(), exec(), includeMonitors(), and separateMonitors().