Mantid
|
Helper class for LoadRaw algorithms. More...
#include <LoadRawHelper.h>
Public Member Functions | |
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::string | category () const override |
function to return a category of the algorithm. More... | |
const std::vector< std::string > | categories () const override |
Function to return all of the categories that contain this algorithm. More... | |
const std::string | categorySeparator () const override |
Function to return the separator token for the category string. More... | |
const std::vector< std::string > | seeAlso () const override |
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm.A default implementation is provided. More... | |
const std::string | alias () const override |
function to return any aliases to the algorithm; A default implementation is provided More... | |
const std::string | aliasDeprecated () const override |
Expiration date (in ISO8601 format) for the algorithm aliases; default implementation for no expiration date. More... | |
const std::string | helpURL () const override |
function to return URL for algorithm documentation; A default implementation is provided. More... | |
template<typename T , typename = typename std::enable_if<std::is_convertible<T *, MatrixWorkspace *>::value>::type> | |
std::tuple< std::shared_ptr< T >, Indexing::SpectrumIndexSet > | getWorkspaceAndIndices (const std::string &name) const |
template<typename T1 , typename T2 , typename = typename std::enable_if<std::is_convertible<T1 *, MatrixWorkspace *>::value>::type, typename = typename std::enable_if<std::is_convertible<T2 *, std::string *>::value || std::is_convertible<T2 *, std::vector<int64_t> *>::value>::type> | |
void | setWorkspaceInputProperties (const std::string &name, const std::shared_ptr< T1 > &wksp, IndexType type, const T2 &list) |
template<typename T1 , typename T2 , typename = typename std::enable_if<std::is_convertible<T1 *, MatrixWorkspace *>::value>::type, typename = typename std::enable_if<std::is_convertible<T2 *, std::string *>::value || std::is_convertible<T2 *, std::vector<int64_t> *>::value>::type> | |
void | setWorkspaceInputProperties (const std::string &name, const std::string &wsName, IndexType type, const T2 &list) |
const std::string | workspaceMethodName () const override |
const std::vector< std::string > | workspaceMethodOn () const override |
const std::string | workspaceMethodInputProperty () const override |
AlgorithmID | getAlgorithmID () const override |
Algorithm ID. More... | |
virtual void | addObserver (const Poco::AbstractObserver &observer) const =0 |
Add an observer for a notification. More... | |
virtual const std::string | alias () const =0 |
function to return any aliases of the algorithm. More... | |
virtual const std::string | aliasDeprecated () const =0 |
Expiration date (in ISO8601 format) for the algorithm aliases. Empty if no expiration date. More... | |
virtual void | cancel ()=0 |
Raises the cancel flag. More... | |
virtual const std::vector< std::string > | categories () const =0 |
Function to return all of the categories that contain this algorithm. More... | |
virtual const std::string | category () const =0 |
function to return a category of the algorithm. More... | |
virtual const std::string | categorySeparator () const =0 |
Function to return the separator token for the category string. More... | |
virtual void | enableHistoryRecordingForChild (const bool on)=0 |
If true history will be recorded for a child. More... | |
virtual bool | execute ()=0 |
System execution. More... | |
virtual void | executeAsChildAlg ()=0 |
Execute as a Child Algorithm, with try/catch. More... | |
virtual Poco::ActiveResult< bool > | executeAsync ()=0 |
Asynchronous execution of the algorithm. More... | |
virtual ExecutionState | executionState () const =0 |
Gets the current execution state. More... | |
virtual AlgorithmID | getAlgorithmID () const =0 |
Algorithm ID. More... | |
virtual bool | getAlgStartupLogging () const =0 |
get the state of Logging of start and end messages More... | |
virtual bool | getAlwaysStoreInADS () const =0 |
To query whether the output is stored in the analysis data service. More... | |
virtual int | getLoggingOffset () const =0 |
returns the logging priority offset More... | |
virtual const std::string | helpURL () const =0 |
function to return an optional URL for documentation. More... | |
virtual void | initialize ()=0 |
Initialization method invoked by the framework. More... | |
virtual bool | isChild () const =0 |
To query whether algorithm is a child. Default to false. More... | |
virtual bool | isExecuted () const =0 |
Check whether the algorithm has been executed sucessfully. More... | |
virtual bool | isInitialized () const =0 |
Check whether the algorithm is initialized properly. More... | |
virtual bool | isLogging () const =0 |
returns the status of logging, True = enabled More... | |
virtual bool | isReadyForGarbageCollection () const =0 |
True if the algorithm is ready for garbage collection. More... | |
virtual bool | isRunning () const =0 |
True if the algorithm is running. More... | |
virtual const std::string | name () const =0 |
function to return a name of the algorithm, must be overridden in all algorithms More... | |
virtual void | removeObserver (const Poco::AbstractObserver &observer) const =0 |
Remove an observer. More... | |
virtual ResultState | resultState () const =0 |
Gets the currnet result State. More... | |
virtual const std::vector< std::string > | seeAlso () const =0 |
Function to return all of the seeAlso algorithms related to this algorithm. More... | |
virtual void | setAlgStartupLogging (const bool enabled)=0 |
disable Logging of start and end messages More... | |
virtual void | setAlwaysStoreInADS (const bool doStore)=0 |
Set whether we always store the output in the analysis data service. More... | |
virtual void | setChild (const bool isChild)=0 |
To set whether algorithm is a child. More... | |
virtual void | setChildEndProgress (const double endProgress) const =0 |
setting the child end progress More... | |
virtual void | setChildStartProgress (const double startProgress) const =0 |
setting the child start progress More... | |
virtual void | setLogging (const bool value)=0 |
Logging can be disabled by passing a value of false. More... | |
virtual void | setLoggingOffset (const int value)=0 |
gets the logging priority offset More... | |
virtual void | setRethrows (const bool rethrow)=0 |
To query whether an algorithm should rethrow exceptions when executing. More... | |
virtual const std::string | summary () const =0 |
function returns a summary message that will be displayed in the default GUI, and in the help. More... | |
virtual ::Json::Value | toJson () const =0 |
Serialize an algorithm as Json. More... | |
virtual std::string | toString () const =0 |
Serialize an algorithm. More... | |
virtual std::map< std::string, std::string > | validateInputs ()=0 |
Method checking errors on ALL the inputs, before execution. More... | |
virtual int | version () const =0 |
function to return a version of the algorithm, must be overridden in all algorithms More... | |
Algorithms As Methods | |
Public Member Functions inherited from Mantid::Kernel::IPropertyManager | |
virtual ::Json::Value | asJson (bool withDefaultValues=false) const =0 |
Return the property manager serialized as a json object. More... | |
virtual std::string | asString (bool withDefaultValues=false) const =0 |
Return the property manager serialized as a string. More... | |
virtual void | declareOrReplaceProperty (std::unique_ptr< Property > p, const std::string &doc="")=0 |
Function to declare properties (i.e. store them) More... | |
void | declareProperty (const std::string &name, const char *value, const std::string &doc, IValidator_sptr validator=std::make_shared< NullValidator >(), const unsigned int direction=Direction::Input) |
Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string). More... | |
void | declareProperty (const std::string &name, const char *value, const unsigned int direction) |
Add a property of string type to the list of managed properties. More... | |
void | declareProperty (const std::string &name, const char *value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc=std::string(), const unsigned int direction=Direction::Input) |
Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string). More... | |
template<typename T > | |
void | declareProperty (const std::string &name, T value, const std::string &doc, const unsigned int direction=Direction::Input) |
Add a property to the list of managed properties with no validator. More... | |
template<typename T > | |
void | declareProperty (const std::string &name, T value, const unsigned int direction) |
Add a property of the template type to the list of managed properties. More... | |
template<typename T > | |
void | declareProperty (const std::string &name, T value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc="", const unsigned int direction=Direction::Input) |
Add a property of the template type to the list of managed properties. More... | |
virtual void | declareProperty (std::unique_ptr< Property > p, const std::string &doc="")=0 |
Function to declare properties (i.e. store them) More... | |
virtual bool | existsProperty (const std::string &name) const =0 |
Checks whether the named property is already in the list of managed property. More... | |
virtual void | filterByProperty (const TimeSeriesProperty< bool > &, const std::vector< std::string > &)=0 |
virtual void | filterByTime (const Types::Core::DateAndTime &, const Types::Core::DateAndTime &)=0 |
virtual std::vector< std::string > | getDeclaredPropertyNames () const noexcept=0 |
Get the list of managed property names. More... | |
virtual Property * | getPointerToProperty (const std::string &name) const =0 |
Get a pointer to property by name. More... | |
virtual const std::vector< Property * > & | getProperties () const =0 |
Get the list of managed properties. More... | |
std::vector< Property * > | getPropertiesInGroup (const std::string &group) const |
Get the list of managed properties in a given group. More... | |
virtual TypedValue | getProperty (const std::string &name) const =0 |
Get the value of a property. More... | |
virtual std::string | getPropertyValue (const std::string &name) const =0 |
Get the value of a property as a string. More... | |
virtual size_t | propertyCount () const =0 |
Returns the number of properties under management. More... | |
virtual void | removeProperty (const std::string &name, const bool delproperty=true)=0 |
Removes the property from management. More... | |
virtual void | resetProperties ()=0 |
virtual void | setProperties (const ::Json::Value &jsonValue, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)=0 |
Sets all the properties from a json object. More... | |
virtual void | setProperties (const std::string &propertiesJson, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)=0 |
Sets all properties from a string. More... | |
virtual void | setPropertiesWithString (const std::string &propertiesString, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >())=0 |
Sets all the declared properties from a string. More... | |
IPropertyManager * | setProperty (const std::string &name, const char *value) |
Specialised version of setProperty template method to handle const char *. More... | |
IPropertyManager * | setProperty (const std::string &name, const std::string &value) |
Specialised version of setProperty template method to handle std::string. More... | |
template<typename T > | |
IPropertyManager * | setProperty (const std::string &name, const T &value) |
Templated method to set the value of a PropertyWithValue. More... | |
template<typename T > | |
IPropertyManager * | setProperty (const std::string &name, std::unique_ptr< T > value) |
Templated method to set the value of a PropertyWithValue from a std::unique_ptr. More... | |
void | setPropertyGroup (const std::string &name, const std::string &group) |
Set the group for a given property. More... | |
virtual void | setPropertyOrdinal (const int &index, const std::string &value)=0 |
Set the value of a property by an index. More... | |
void | setPropertySettings (const std::string &name, std::unique_ptr< IPropertySettings > settings) |
virtual void | setPropertyValue (const std::string &name, const std::string &value)=0 |
Sets property value from a string. More... | |
virtual void | setPropertyValueFromJson (const std::string &name, const Json::Value &value)=0 |
Sets property value from a Json::Value. More... | |
virtual void | splitByTime (std::vector< SplittingInterval > &, std::vector< PropertyManager * >) const =0 |
virtual std::unique_ptr< Property > | takeProperty (const size_t index)=0 |
Removes the property from management and returns a pointer to it. More... | |
void | updatePropertyValues (const IPropertyManager &other) |
Update values of the existing properties. More... | |
virtual bool | validateProperties () const =0 |
Validates all the properties in the collection. More... | |
virtual | ~IPropertyManager ()=default |
Static Public Member Functions | |
static 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... | |
Protected Member Functions | |
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 |
Protected Attributes | |
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... | |
Private Member Functions | |
void | exec () override |
Overwrites Algorithm method. More... | |
std::string | extractLogName (const std::string &path) |
Extract the log name from the path to the specific log file. More... | |
Static Private Member Functions | |
static std::string | convertMonthLabelToIntStr (std::string month) |
convert month label to int string More... | |
Private Attributes | |
bool | m_bmspeclist |
boolean for list spectra options More... | |
std::vector< std::string > | m_cache_options |
Allowed values for the cache property. More... | |
std::unique_ptr< ISISRAW2 > | m_isis_raw |
ISISRAW class instance which does raw file reading. More... | |
std::unique_ptr< ISISRunLogs > | m_logCreator |
A ptr to the log creator. More... | |
std::vector< specnum_t > | m_monitordetectorList |
a vector holding the indexes of monitors More... | |
specnum_t | m_numberOfSpectra |
number of spectra More... | |
double | m_prog |
The current value of the progress counter. More... | |
std::map< specnum_t, specnum_t > | m_specTimeRegimes |
A map for storing the time regime for each spectrum. More... | |
specnum_t | m_total_specs |
the total nuumber of spectra More... | |
Additional Inherited Members | |
Public Types inherited from Mantid::API::Algorithm | |
using | WorkspaceVector = std::vector< std::shared_ptr< Workspace > > |
Public Attributes inherited from Mantid::API::Algorithm | |
bool | calledByAlias = false |
Flag to indicate if the algorithm is called by its alias. More... | |
Static Protected Member Functions inherited from Mantid::API::Algorithm | |
template<typename NumT > | |
static bool | isEmpty (const NumT toCheck) |
checks that the value was not set by users, uses the value in empty double/int. More... | |
Static Protected Attributes inherited from Mantid::API::Algorithm | |
static size_t | g_execCount = 0 |
Counter to keep track of algorithm execution order. More... | |
Helper class for LoadRaw algorithms.
Definition at line 40 of file LoadRawHelper.h.
Mantid::DataHandling::LoadRawHelper::LoadRawHelper | ( | ) |
|
default |
Destructor.
|
protected |
calculate workspace size
Calculates the total number of spectra in the workspace, given the input properties.
Definition at line 951 of file LoadRawHelper.cpp.
References m_interval, m_list, m_numberOfSpectra, m_spec_list, m_spec_max, m_spec_min, and m_total_specs.
Referenced by Mantid::DataHandling::LoadRaw3::exec(), and Mantid::DataHandling::LoadRawBin0::exec().
|
protected |
calculate workspace sizes if separate or exclude monitors are selected
calculate workspace sizes.
monitorSpecList | :: the vector of the monitor spectra |
normalwsSpecs | :: the spectra for the detector workspace |
monitorwsSpecs | :: the spectra for the monitor workspace |
Definition at line 991 of file LoadRawHelper.cpp.
References Mantid::Kernel::Logger::debug(), Mantid::API::g_log, m_bmspeclist, m_interval, m_spec_list, m_spec_max, m_spec_min, and m_total_specs.
Referenced by Mantid::DataHandling::LoadRaw3::exec().
|
protected |
Validates the optional 'spectra to read' properties, if they have been set.
Definition at line 909 of file LoadRawHelper.cpp.
References Mantid::EMPTY_INT(), Mantid::Kernel::Logger::error(), Mantid::API::g_log, m_bmspeclist, m_interval, m_list, m_numberOfSpectra, m_spec_list, m_spec_max, and m_spec_min.
Referenced by Mantid::DataHandling::LoadRaw3::exec(), and Mantid::DataHandling::LoadRawBin0::exec().
|
overridevirtual |
Returns a confidence value that this algorithm can load a file.
Return the confidence with which this algorithm can load the file.
descriptor | A descriptor for the file |
Implements Mantid::API::IFileLoader< Kernel::FileDescriptor >.
Definition at line 1102 of file LoadRawHelper.cpp.
References confidence(), and Mantid::Kernel::FileDescriptor::data().
Referenced by confidence(), and Mantid::DataHandling::UpdateInstrumentFromFile::exec().
|
staticprivate |
convert month label to int string
To help transforming date stored in ISIS raw file into iso 8601.
month |
Definition at line 867 of file LoadRawHelper.cpp.
Referenced by extractEndTime(), and extractStartTime().
|
static |
creates shared pointer to group workspace
This method creates pointer to group workspace.
Definition at line 481 of file LoadRawHelper.cpp.
Referenced by createMonitorWorkspace(), Mantid::DataHandling::LoadRaw3::exec(), Mantid::DataHandling::LoadRawBin0::exec(), and Mantid::DataHandling::LoadRawSpectrum0::exec().
|
static |
creates monitor workspace
monws_sptr | :: shared pointer to monitor workspace |
normalws_sptr | :: shared pointer to output workspace |
mongrp_sptr | :: shared pointer to monitor group workspace |
mwsSpecs | :: number of spectra in the monitor workspace |
nwsSpecs | :: number of spectra in the output workspace |
numberOfPeriods | :: total number of periods from raw file |
lengthIn | :: size of workspace vectors |
title | :: title of the workspace |
pAlg | :: pointer to the algorithm, this method works with. |
Definition at line 293 of file LoadRawHelper.cpp.
References createGroupWorkspace(), createWorkspace(), Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::declareProperty(), Mantid::API::Algorithm::getLogger(), Mantid::API::Algorithm::getPropertyValue(), Mantid::Kernel::Direction::Output, and setWorkspaceProperty().
Referenced by Mantid::DataHandling::LoadRaw3::exec().
|
protected |
Create the period specific logs.
Creates period log data in the workspace.
period | :: period number |
local_workspace | :: workspace to add period log data to. |
Definition at line 763 of file LoadRawHelper.cpp.
References m_logCreator.
Referenced by Mantid::DataHandling::LoadRaw3::exec(), Mantid::DataHandling::LoadRawBin0::exec(), and Mantid::DataHandling::LoadRawSpectrum0::exec().
|
static |
creates shared pointer to workspace from parent workspace
This method creates shared pointer to a workspace.
ws_sptr | :: shared pointer to the parent workspace |
nVectors | :: number of histograms in the workspace |
xLengthIn | :: size of workspace X vector |
yLengthIn | :: size of workspace Y vector |
Definition at line 249 of file LoadRawHelper.cpp.
References Mantid::DataObjects::create(), Mantid::Kernel::SingletonHolder< T >::Instance(), and workspace.
Referenced by createMonitorWorkspace(), Mantid::DataHandling::LoadRaw3::exec(), Mantid::DataHandling::LoadRawBin0::exec(), and Mantid::DataHandling::LoadRawSpectrum0::exec().
|
static |
overloaded method to create shared pointer to workspace
This method creates pointer to workspace.
nVectors | :: The number of vectors/histograms in the workspace |
xlengthIn | :: The number of X data points/bin boundaries in each vector |
ylengthIn | :: The number of Y data points/bin boundaries in each vector |
title | :: title of the workspace |
Definition at line 268 of file LoadRawHelper.cpp.
References Mantid::DataObjects::create(), Mantid::Kernel::SingletonHolder< T >::Instance(), and workspace.
|
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.
Reimplemented in Mantid::DataHandling::LoadRawSpectrum0.
Definition at line 343 of file LoadRawHelper.cpp.
|
static |
Extract the end time from a raw file.
Extracts the end time from the Raw file.
isisRaw | pointer to the raw file |
Definition at line 843 of file LoadRawHelper.cpp.
References convertMonthLabelToIntStr(), isisRaw(), RPB_STRUCT::r_enddate, RPB_STRUCT::r_endtime, and ISISRAW::rpb.
Referenced by loadRunParameters().
|
private |
Extract the log name from the path to the specific log file.
Extract the log name from the path to the log file.
path | :: Path to the log file |
Definition at line 751 of file LoadRawHelper.cpp.
Referenced by runLoadLog().
|
static |
Extract the start time from a raw file.
Extracts the start time from the Raw file.
isisRaw | pointer to the raw file |
Definition at line 856 of file LoadRawHelper.cpp.
References convertMonthLabelToIntStr(), HDR_STRUCT::hd_date, HDR_STRUCT::hd_time, ISISRAW::hdr, and isisRaw().
Referenced by loadRunParameters().
|
protected |
gets the monitor spectrum list from the workspace
This method returns the monitor spectrum list.
mapping | The spectrum number to detector mapping |
Definition at line 455 of file LoadRawHelper.cpp.
References Mantid::Kernel::Logger::error(), Mantid::API::g_log, Mantid::API::SpectrumDetectorMapping::getMapping(), and m_monitordetectorList.
Referenced by Mantid::DataHandling::LoadRaw3::exec().
|
protected |
number of time regimes
Definition at line 185 of file LoadRawHelper.cpp.
References ISISRAW::daep, isisRaw(), and DAEP_STRUCT::n_tr_shift.
Referenced by loadSpectra().
|
protected |
get proton charge from raw file
Definition at line 209 of file LoadRawHelper.cpp.
References isisRaw(), RPB_STRUCT::r_gd_prtn_chrg, and ISISRAW::rpb.
Referenced by setProtonCharge().
|
protected |
Constructs the time channel (X) vector(s)
regimes | :: The number of time regimes (if 1 regime, will actually contain 0) |
lengthIn | :: The number of time channels |
Definition at line 490 of file LoadRawHelper.cpp.
References Mantid::Kernel::Logger::debug(), Mantid::API::g_log, ISISRAW::getTimeChannels(), isisRaw(), and m_specTimeRegimes.
Referenced by Mantid::DataHandling::LoadRaw3::exec(), and Mantid::DataHandling::LoadRawSpectrum0::exec().
|
overrideprotectedvirtual |
Overwrites Algorithm method.
Initialisation method.
Implements Mantid::API::Algorithm.
Reimplemented in Mantid::DataHandling::LoadRawSpectrum0.
Definition at line 110 of file LoadRawHelper.cpp.
References Mantid::API::Algorithm::declareProperty(), Mantid::API::FileProperty::Load, m_cache_options, and Mantid::Kernel::Direction::Output.
Referenced by Mantid::DataHandling::LoadRaw3::init(), Mantid::DataHandling::LoadRawBin0::init(), and Mantid::DataHandling::LoadRawSpectrum0::init().
|
protected |
calls isisRaw ioraw
calls isisRaw ioRaw.
file | :: the file pointer |
from_file | :: unknown |
Definition at line 184 of file LoadRawHelper.cpp.
References ISISRAW2::ioRAW(), and isisRaw().
Referenced by readTitle().
|
static |
returns true if the Exclude Monitor option(property) selected
This method checks the value of LoadMonitors property and returns true or false.
Definition at line 1181 of file LoadRawHelper.cpp.
Referenced by ProcessLoadMonitorOptions().
|
static |
returns true if the Include Monitor Option selected
This method checks the value of LoadMonitors property and returns true or false.
Definition at line 1187 of file LoadRawHelper.cpp.
Referenced by ProcessLoadMonitorOptions().
|
protected |
return an reference to the ISISRAW2 reader
Lazy-instantiation of the ISISRAW reader.
Definition at line 191 of file LoadRawHelper.cpp.
References m_isis_raw.
Referenced by Mantid::DataHandling::LoadRaw3::exec(), extractEndTime(), extractStartTime(), getNumberofTimeRegimes(), getProtonCharge(), getTimeChannels(), ioRaw(), loadRunParameters(), loadSpectra(), readData(), readTitle(), readworkspaceParameters(), runLoadInstrument(), setRunNumber(), setWorkspaceData(), and skipData().
|
static |
returns true if the Separate Monitor Option selected
This method checks the value of LoadMonitors property and returns true or false.
Definition at line 1193 of file LoadRawHelper.cpp.
Referenced by ProcessLoadMonitorOptions().
void Mantid::DataHandling::LoadRawHelper::loadRunParameters | ( | const API::MatrixWorkspace_sptr & | localWorkspace, |
ISISRAW * const | rawFile = nullptr |
||
) | const |
Read in run parameters Public so that LoadRaw2 can use it.
Pulls the run parameters from the ISIS Raw RPB structure and stores them as log entries on the workspace run object.
localWorkspace | :: The workspace to attach the information to |
rawFile | :: The handle to an ISIS Raw file |
Definition at line 774 of file LoadRawHelper.cpp.
References Mantid::API::LogManager::addProperty(), extractEndTime(), extractStartTime(), HDR_STRUCT::hd_dur, HDR_STRUCT::hd_user, ISISRAW::hdr, HDR_STRUCT::inst_abrv, isisRaw(), RPB_STRUCT::r_dmp, RPB_STRUCT::r_dmp_freq, RPB_STRUCT::r_dmp_units, RPB_STRUCT::r_dur, RPB_STRUCT::r_dur_freq, RPB_STRUCT::r_dur_secs, RPB_STRUCT::r_dur_wanted, RPB_STRUCT::r_durunits, RPB_STRUCT::r_freq, RPB_STRUCT::r_gd_prtn_chrg, RPB_STRUCT::r_goodfrm, RPB_STRUCT::r_mon_sum1, RPB_STRUCT::r_mon_sum2, RPB_STRUCT::r_mon_sum3, RPB_STRUCT::r_prop, RPB_STRUCT::r_rawfrm, RPB_STRUCT::r_tot_prtn_chrg, ISISRAW::rpb, Mantid::DataHandling::RawFileInfo::runHeader(), Mantid::DataHandling::RawFileInfo::runTitle(), ISISRAW::t_nper, ISISRAW::t_nsp1, and ISISRAW::t_ntc1.
Referenced by Mantid::DataHandling::LoadRaw3::exec().
|
protected |
load the spectra
Definition at line 1054 of file LoadRawHelper.cpp.
References getNumberofTimeRegimes(), Mantid::API::Algorithm::interruption_point(), isisRaw(), m_list, m_numberOfSpectra, m_prog, m_spec_list, m_spec_max, m_spec_min, Mantid::API::Algorithm::progress(), readData(), setWorkspaceData(), and skipData().
|
inlineoverridevirtual |
Algorithm's name for identification overriding a virtual method.
Implements Mantid::API::Algorithm.
Reimplemented in Mantid::DataHandling::LoadRawSpectrum0.
Definition at line 48 of file LoadRawHelper.h.
FILE * Mantid::DataHandling::LoadRawHelper::openRawFile | ( | const std::string & | fileName | ) |
Opens Raw File.
opens the raw file and returns the file pointer
fileName | :: name of the raw file |
Definition at line 147 of file LoadRawHelper.cpp.
References Mantid::Kernel::FileDescriptor::isAscii().
Referenced by Mantid::DataHandling::DetermineChunking::exec(), Mantid::DataHandling::LoadRaw3::exec(), Mantid::DataHandling::LoadRawBin0::exec(), and Mantid::DataHandling::LoadRawSpectrum0::exec().
|
static |
The method to interpret LoadMonitors property options and convert then into boolean values.
bincludeMonitors | :: if monitors requested to be included with workspace |
bseparateMonitors | :: if monitors requested to be loaded separately from the workspace |
bexcludeMonitors | :: if monitors should not be loaded at all. |
pAlgo | :: pointer to the algorithm, which has LoadMonitors property. |
Definition at line 1204 of file LoadRawHelper.cpp.
References Mantid::API::Algorithm::getProperty(), isExcludeMonitors(), isIncludeMonitors(), and isSeparateMonitors().
Referenced by Mantid::DataHandling::LoadISISNexus2::exec(), and Mantid::DataHandling::LoadRaw3::exec().
|
protected |
reads data
reads the histogram from raw file
file | :: pointer to the raw file |
hist | :: postion in the file to read |
Definition at line 206 of file LoadRawHelper.cpp.
References isisRaw(), and ISISRAW2::readData().
Referenced by Mantid::DataHandling::LoadRaw3::excludeMonitors(), Mantid::DataHandling::LoadRawBin0::exec(), Mantid::DataHandling::LoadRawSpectrum0::exec(), Mantid::DataHandling::LoadRaw3::includeMonitors(), loadSpectra(), readData(), and Mantid::DataHandling::LoadRaw3::separateMonitors().
|
protected |
Definition at line 207 of file LoadRawHelper.cpp.
References readData().
|
protected |
Reads title from the isisraw class.
Reads the run title and creates a string from it.
file | :: pointer to the raw file |
title | :: An output parameter that will contain the workspace title |
Definition at line 170 of file LoadRawHelper.cpp.
References Mantid::API::g_log, Mantid::Kernel::Logger::information(), ioRaw(), and isisRaw().
Referenced by Mantid::DataHandling::LoadRaw3::exec(), Mantid::DataHandling::LoadRawBin0::exec(), and Mantid::DataHandling::LoadRawSpectrum0::exec().
|
protected |
reads workspace parameters like number of histograms,size of vectors etc
reads workspace dimensions,number of periods etc from raw data
numberOfSpectra | :: number of spectra |
numberOfPeriods | :: number of periods |
lengthIn | :: size of workspace vectors |
noTimeRegimes | :: number of time regime. |
Definition at line 229 of file LoadRawHelper.cpp.
References ISISRAW::daep, isisRaw(), m_numberOfSpectra, DAEP_STRUCT::n_tr_shift, ISISRAW::t_nper, ISISRAW::t_nsp1, and ISISRAW::t_ntc1.
Referenced by Mantid::DataHandling::LoadRaw3::exec(), Mantid::DataHandling::LoadRawBin0::exec(), and Mantid::DataHandling::LoadRawSpectrum0::exec().
|
protected |
resets the isisraw shared pointer
Definition at line 199 of file LoadRawHelper.cpp.
References m_isis_raw.
Referenced by Mantid::DataHandling::LoadRaw3::exec(), and Mantid::DataHandling::LoadRawSpectrum0::exec().
|
protected |
loadinstrument Child Algorithm
Run the Child Algorithm LoadInstrument (or LoadInstrumentFromRaw)
fileName | :: the raw file filename |
localWorkspace | :: The workspace to load the instrument for |
progStart | :: progress at start |
progEnd | :: progress at end |
Definition at line 538 of file LoadRawHelper.cpp.
References Mantid::API::Algorithm::createChildAlgorithm(), Mantid::Kernel::Logger::debug(), Mantid::API::g_log, ISISRAW::i_inst, Mantid::Kernel::Logger::information(), isisRaw(), m_monitordetectorList, m_prog, Mantid::API::Algorithm::progress(), Mantid::API::Algorithm::progressObserver(), runLoadInstrumentFromRaw(), Mantid::API::Algorithm::setChildEndProgress(), Mantid::API::Algorithm::setChildStartProgress(), and value.
Referenced by Mantid::DataHandling::LoadRaw3::exec().
|
protected |
loadinstrumentfromraw algorithm
Run LoadInstrumentFromRaw as a Child Algorithm (only if loading from instrument definition file fails)
fileName | :: the raw file filename |
localWorkspace | :: The workspace to load the instrument for |
Definition at line 618 of file LoadRawHelper.cpp.
References Mantid::API::Algorithm::createChildAlgorithm(), Mantid::Kernel::Logger::debug(), Mantid::Kernel::Logger::error(), Mantid::API::g_log, and m_monitordetectorList.
Referenced by runLoadInstrument().
|
protected |
load log algorithm
Run the LoadLog Child Algorithm.
fileName | :: the raw file filename |
localWorkspace | :: The workspace to load the logs for |
progStart | :: starting progress fraction |
progEnd | :: ending progress fraction |
Definition at line 670 of file LoadRawHelper.cpp.
References Mantid::API::Algorithm::createChildAlgorithm(), Mantid::Kernel::Logger::debug(), extractLogName(), Mantid::API::g_log, Mantid::Kernel::Logger::information(), Mantid::Kernel::FileDescriptor::isEmpty(), m_logCreator, m_prog, Mantid::API::Algorithm::progress(), Mantid::API::Algorithm::progressObserver(), searchForLogFiles(), Mantid::API::Algorithm::setChildEndProgress(), Mantid::API::Algorithm::setChildStartProgress(), and Mantid::Kernel::Logger::warning().
Referenced by Mantid::DataHandling::LoadRaw3::exec(), Mantid::DataHandling::LoadRawBin0::exec(), and Mantid::DataHandling::LoadRawSpectrum0::exec().
|
protected |
loadinstrumentfromraw Child Algorithm
Run the LoadMappingTable Child Algorithm to fill the SpectraToDetectorMap.
fileName | :: the raw file filename |
localWorkspace | :: The workspace to load the mapping table for |
Definition at line 644 of file LoadRawHelper.cpp.
References Mantid::API::Algorithm::createChildAlgorithm(), Mantid::Kernel::Logger::debug(), Mantid::Kernel::Logger::error(), Mantid::API::g_log, m_prog, and Mantid::API::Algorithm::progress().
|
static |
Search for the log files in the workspace, and output their names as a list.
Searches for log files related to RAW file loaded using LoadLog algorithm.
pathToRawFile | The path and name of the raw file. |
read list of log files from alternate data stream
Definition at line 1122 of file LoadRawHelper.cpp.
References Mantid::Kernel::Glob::glob().
Referenced by runLoadLog().
|
protected |
sets optional properties like spec_min,spec_max etc
sets optional properties for the loadraw algorithm
spec_min | :: The minimum spectra number |
spec_max | :: The maximum spectra number |
spec_list | :: The list of Spectra to be included |
Definition at line 902 of file LoadRawHelper.cpp.
References m_spec_list, m_spec_max, and m_spec_min.
|
protected |
set proton charge
Set the proton charge on the run object.
run | :: The run object |
Definition at line 215 of file LoadRawHelper.cpp.
References getProtonCharge(), and Mantid::API::Run::setProtonCharge().
Referenced by Mantid::DataHandling::LoadRaw3::exec(), Mantid::DataHandling::LoadRawBin0::exec(), and Mantid::DataHandling::LoadRawSpectrum0::exec().
|
protected |
Stores the run number in the sample's logs.
Stores the run number in the run logs.
run | :: the workspace's run object |
Definition at line 219 of file LoadRawHelper.cpp.
References Mantid::API::LogManager::addLogData(), isisRaw(), and std::to_string().
Referenced by Mantid::DataHandling::LoadRaw3::exec().
|
protected |
This method sets the raw file data to workspace vectors.
newWorkspace | :: shared pointer to the workspace |
timeChannelsVec | :: vector holding the X data |
wsIndex | variable used for indexing the output workspace |
nspecNum | spectrum number |
noTimeRegimes | :: regime no. |
lengthIn | :: length of the workspace |
binStart | :: start of bin |
Definition at line 417 of file LoadRawHelper.cpp.
References isisRaw(), m_specTimeRegimes, and Mantid::Geometry::Y.
Referenced by Mantid::DataHandling::LoadRaw3::excludeMonitors(), Mantid::DataHandling::LoadRawBin0::exec(), Mantid::DataHandling::LoadRawSpectrum0::exec(), Mantid::DataHandling::LoadRaw3::includeMonitors(), loadSpectra(), and Mantid::DataHandling::LoadRaw3::separateMonitors().
|
static |
overloaded method to set the workspace property
sets the workspace properties
ws_sptr | :: shared pointer to workspace |
grpws_sptr | :: shared pointer to group workspace |
period | period number |
bmonitors | :: boolean flag to name the workspaces |
pAlg | :: pointer to algorithm this method works with. |
Definition at line 352 of file LoadRawHelper.cpp.
References Mantid::API::Algorithm::declareProperty(), Mantid::API::Algorithm::getProperty(), Mantid::Kernel::Direction::Output, and Mantid::Kernel::IPropertyManager::setProperty().
|
static |
sets the workspace property
This method sets the workspace property.
propertyName | :: property name for the workspace |
title | :: title of the workspace |
grpws_sptr | :: shared pointer to group workspace |
ws_sptr | :: shared pointer to workspace |
numberOfPeriods | :: number periods in the raw file |
bMonitor | to identify the workspace is an output workspace or monitor workspace |
pAlg | :: pointer to algorithm this method works with. |
Definition at line 388 of file LoadRawHelper.cpp.
References Mantid::API::Algorithm::getProperty(), Mantid::Kernel::SingletonHolder< T >::Instance(), and Mantid::Kernel::IPropertyManager::setProperty().
Referenced by createMonitorWorkspace(), Mantid::DataHandling::LoadRaw3::exec(), Mantid::DataHandling::LoadRawBin0::exec(), and Mantid::DataHandling::LoadRawSpectrum0::exec().
|
protected |
skips histrogram data from raw file.
skips the histogram from raw file
file | :: pointer to the raw file |
hist | :: postion in the file to skip |
Definition at line 179 of file LoadRawHelper.cpp.
References isisRaw(), and ISISRAW2::skipData().
Referenced by Mantid::DataHandling::LoadRaw3::excludeMonitors(), Mantid::DataHandling::LoadRaw3::exec(), Mantid::DataHandling::LoadRawBin0::exec(), Mantid::DataHandling::LoadRawSpectrum0::exec(), Mantid::DataHandling::LoadRaw3::includeMonitors(), loadSpectra(), Mantid::DataHandling::LoadRaw3::separateMonitors(), skipData(), and Mantid::DataHandling::LoadRaw3::skipPeriod().
|
protected |
Definition at line 180 of file LoadRawHelper.cpp.
References skipData().
|
inlineoverridevirtual |
Summary of algorithms purpose.
Implements Mantid::API::Algorithm.
Reimplemented in Mantid::DataHandling::LoadRawSpectrum0.
Definition at line 52 of file LoadRawHelper.h.
|
inlineoverridevirtual |
Algorithm's version for identification overriding a virtual method.
Implements Mantid::API::Algorithm.
Reimplemented in Mantid::DataHandling::LoadRawSpectrum0.
Definition at line 50 of file LoadRawHelper.h.
|
private |
boolean for list spectra options
Definition at line 212 of file LoadRawHelper.h.
Referenced by calculateWorkspacesizes(), and checkOptionalProperties().
|
private |
Allowed values for the cache property.
Definition at line 199 of file LoadRawHelper.h.
Referenced by init().
|
protected |
Have the spectrum_min/max properties been set?
Definition at line 180 of file LoadRawHelper.h.
Referenced by calculateWorkspaceSize(), calculateWorkspacesizes(), and checkOptionalProperties().
|
mutableprivate |
ISISRAW class instance which does raw file reading.
Definition at line 197 of file LoadRawHelper.h.
|
protected |
Has the spectrum_list property been set?
Definition at line 178 of file LoadRawHelper.h.
Referenced by calculateWorkspaceSize(), checkOptionalProperties(), Mantid::DataHandling::LoadRaw3::excludeMonitors(), Mantid::DataHandling::LoadRawBin0::exec(), Mantid::DataHandling::LoadRaw3::includeMonitors(), loadSpectra(), and Mantid::DataHandling::LoadRaw3::separateMonitors().
|
private |
A ptr to the log creator.
Definition at line 218 of file LoadRawHelper.h.
Referenced by createPeriodLogs(), and runLoadLog().
|
private |
a vector holding the indexes of monitors
Definition at line 209 of file LoadRawHelper.h.
Referenced by getmonitorSpectrumList(), runLoadInstrument(), and runLoadInstrumentFromRaw().
|
protected |
The number of periods in the raw file.
Definition at line 188 of file LoadRawHelper.h.
Referenced by Mantid::DataHandling::LoadRaw3::excludeMonitors(), Mantid::DataHandling::LoadRaw3::exec(), Mantid::DataHandling::LoadRawBin0::exec(), Mantid::DataHandling::LoadRawSpectrum0::exec(), Mantid::DataHandling::LoadRaw3::includeMonitors(), Mantid::DataHandling::LoadRaw3::separateMonitors(), and Mantid::DataHandling::LoadRaw3::setOptionalProperties().
|
private |
number of spectra
Definition at line 206 of file LoadRawHelper.h.
Referenced by calculateWorkspaceSize(), checkOptionalProperties(), loadSpectra(), and readworkspaceParameters().
|
private |
The current value of the progress counter.
Definition at line 203 of file LoadRawHelper.h.
Referenced by loadSpectra(), runLoadInstrument(), runLoadLog(), and runLoadMappingTable().
|
protected |
The value of the spectrum_list property.
Definition at line 182 of file LoadRawHelper.h.
Referenced by calculateWorkspaceSize(), calculateWorkspacesizes(), checkOptionalProperties(), Mantid::DataHandling::LoadRaw3::excludeMonitors(), Mantid::DataHandling::LoadRawBin0::exec(), Mantid::DataHandling::LoadRaw3::includeMonitors(), loadSpectra(), Mantid::DataHandling::LoadRaw3::separateMonitors(), Mantid::DataHandling::LoadRaw3::setOptionalProperties(), Mantid::DataHandling::LoadRawBin0::setOptionalProperties(), and setOptionalProperties().
|
protected |
The value of the spectrum_max property.
Definition at line 186 of file LoadRawHelper.h.
Referenced by calculateWorkspaceSize(), calculateWorkspacesizes(), checkOptionalProperties(), Mantid::DataHandling::LoadRaw3::excludeMonitors(), Mantid::DataHandling::LoadRawBin0::exec(), Mantid::DataHandling::LoadRaw3::includeMonitors(), loadSpectra(), Mantid::DataHandling::LoadRaw3::separateMonitors(), Mantid::DataHandling::LoadRaw3::setOptionalProperties(), Mantid::DataHandling::LoadRawBin0::setOptionalProperties(), and setOptionalProperties().
|
protected |
The value of the spectrum_min property.
Definition at line 184 of file LoadRawHelper.h.
Referenced by calculateWorkspaceSize(), calculateWorkspacesizes(), checkOptionalProperties(), Mantid::DataHandling::LoadRaw3::excludeMonitors(), Mantid::DataHandling::LoadRawBin0::exec(), Mantid::DataHandling::LoadRaw3::includeMonitors(), loadSpectra(), Mantid::DataHandling::LoadRaw3::separateMonitors(), Mantid::DataHandling::LoadRaw3::setOptionalProperties(), Mantid::DataHandling::LoadRawBin0::setOptionalProperties(), and setOptionalProperties().
A map for storing the time regime for each spectrum.
Definition at line 201 of file LoadRawHelper.h.
Referenced by getTimeChannels(), and setWorkspaceData().
|
private |
the total nuumber of spectra
Definition at line 215 of file LoadRawHelper.h.
Referenced by calculateWorkspaceSize(), and calculateWorkspacesizes().