LoadFITS: Load one or more of FITS files into a Workspace2D. More...

#include <LoadFITS.h>

Inheritance diagram for Mantid::DataHandling::LoadFITS:

Public Member Functions
const std::string	category () const override
	Algorithm's category for identification overriding a virtual method. More...

int	confidence (Kernel::FileDescriptor &descriptor) const override
	Returns a confidence value that this algorithm can load a file. More...

	LoadFITS ()
	Constructor. More...

bool	loadMutipleAsOne () override
	Returns a value indicating whether or not loader wants to load multiple files into a single workspace. 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...

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	addAxesInfoAndLogs (const DataObjects::Workspace2D_sptr &ws, bool loadAsRectImg, const FITSInfo &fileInfo, int binSize, double cmpp)
	Add information to the workspace being loaded: labels, units, logs related to the image size, etc. More...

void	doFilterNoise (double thresh, API::MantidImage &imageY, API::MantidImage &imageE)
	filter noise pixel by pixel More...

void	doLoadFiles (const std::vector< std::string > &paths, const std::string &outWSName, bool loadAsRectImg, int binSize, double noiseThresh)
	Loads files into workspace(s) More...

void	doRebin (size_t rebin, const API::MantidImage &imageY, const API::MantidImage &imageE, API::MantidImage &rebinnedY, API::MantidImage &rebinnedE)
	rebin the matrix/image More...

void	exec () override
	Execution code. More...

size_t	fetchNumber (const std::string &name)
	Returns the trailing number from a string minus leading 0's (so 25 from workspace_000025) More...

void	headerSanityCheck (const FITSInfo &hdr, const FITSInfo &hdrFirst)
	Once loaded, check against standard and limitations of this algorithm. More...

void	init () override
	Initialisation code. More...

bool	isInstrOtherThanIMAT (const FITSInfo &hdr)
	identifies fits coming from 'other' cameras by specific headers More...

void	loadHeader (const std::string &filePath, FITSInfo &header)
	Load the FITS header(s) from one fits file into a struct. More...

DataObjects::Workspace2D_sptr	makeWorkspace (const FITSInfo &fileInfo, size_t &newFileNumber, std::vector< char > &buffer, API::MantidImage &imageY, API::MantidImage &imageE, const DataObjects::Workspace2D_sptr &parent, bool loadAsRectImg=false, int binSize=1, double noiseThresh=false)
	Initialises a workspace with IDF and fills it with data. More...

void	mapHeaderKeys ()
	Maps the header keys to specified values. More...

std::string	padZeros (const size_t number, const size_t totalDigitCount)
	Adds 0's to the front of a number to create a string of size totalDigitCount including number. More...

void	parseHeader (FITSInfo &headerInfo)
	Parses the header values for the FITS file. More...

void	readDataToImgs (const FITSInfo &fileInfo, API::MantidImage &imageY, API::MantidImage &imageE, std::vector< char > &buffer)
	Reads the data (FITS matrix) from a single FITS file into image objects (Y and E). More...

void	readDataToWorkspace (const FITSInfo &fileInfo, double cmpp, const DataObjects::Workspace2D_sptr &ws, std::vector< char > &buffer)
	Reads the data (FITS matrix) from a single FITS file into a workspace (directly into the spectra, using one spectrum per image row). More...

void	readInBuffer (const FITSInfo &fileInfo, std::vector< char > &buffer, size_t len)
	Reads the data (FITS matrix) from a single FITS file into a buffer. More...

void	setupDefaultKeywordNames ()
	Sets several keyword names with default (and standard) values. More...

Private Attributes
std::vector< std::string >	m_headerAxisNameKeys

std::string	m_headerBitDepthKey

std::string	m_headerImageKeyKey

std::string	m_headerNAxisNameKey

std::string	m_headerOffsetKey

std::string	m_headerRotationKey

std::string	m_headerScaleKey

std::string	m_imageType

std::string	m_mapFile

size_t	m_pixelCount

std::string	m_sampleRotation

Static Private Attributes
static const std::string	g_AXIS_NAMES_NAME = "AxisNames"

static const int	g_BASE_HEADER_SIZE = 2880
	size of a FITS header block (room for 36 entries, of 80 characters each), in bytes. More...

static const std::string	g_BIT_DEPTH_NAME = "BitDepthName"

static const std::string	g_COMMENT_KEYNAME = "COMMENT"

static const std::string	g_defaultImgType = "SAMPLE"

static const size_t	g_DIGIT_SIZE_APPEND = 6

static const std::string	g_END_KEYNAME = "END"

static const std::string	g_HEADER_MAP_NAME = "HeaderMapFile"

static const std::string	g_IMAGE_KEY_NAME = "ImageKeyName"

static const size_t	g_maxBitDepth = 64

static const size_t	g_maxBytesPP = g_maxBitDepth / 8

static const std::string	g_ROTATION_NAME = "RotationName"

static const std::string	g_XTENSION_KEYNAME = "XTENSION"

Additional Inherited Members
Public Types inherited from Mantid::API::Algorithm
using	WorkspaceVector = std::vector< std::shared_ptr< Workspace > >

Static Public Member Functions inherited from Mantid::API::Algorithm
static IAlgorithm_sptr	fromString (const std::string &input)
	De-serialize an object from a string. More...

static IAlgorithm_sptr	fromJson (const Json::Value &input)
	De-serialize an object from a Json. More...

static IAlgorithm_sptr	fromHistory (const AlgorithmHistory &history)
	Construct an object from a history entry. More...

Public Attributes inherited from Mantid::API::Algorithm
bool	calledByAlias = false
	Flag to indicate if the algorithm is called by its alias. More...

Protected Member Functions inherited from Mantid::API::ParallelAlgorithm
Parallel::ExecutionMode	getParallelExecutionMode (const std::map< std::string, Parallel::StorageMode > &storageModes) const override
	Get correct execution mode based on input storage modes for an MPI run. More...

	~ParallelAlgorithm ()=default

Protected Member Functions inherited from Mantid::API::Algorithm
void	exec (Parallel::ExecutionMode executionMode)
	Runs the algorithm with the specified execution mode. More...

virtual void	execDistributed ()
	Runs the algorithm in `distributed` execution mode. More...

virtual void	execMasterOnly ()
	Runs the algorithm in `master-only` execution mode. More...

virtual const std::string	workspaceMethodOnTypes () const
	Returns a semi-colon separated list of workspace types to attach this algorithm. More...

void	cacheWorkspaceProperties ()
	Go through the properties and cache the input/output workspace properties for later use. More...

void	cacheInputWorkspaceHistories ()
	Cache the histories of any input workspaces so they can be copied over after algorithm completion. More...

void	setExecutionState (const ExecutionState state)
	Sets the current execution state. More...

void	setResultState (const ResultState state)
	Sets the result execution state. More...

void	store ()
	Stores any output workspaces into the AnalysisDataService. More...

void	progress (double p, const std::string &msg="", double estimatedTime=0.0, int progressPrecision=0)
	Sends ProgressNotification. More...

void	interruption_point ()
	This is called during long-running operations, and check if the algorithm has requested that it be cancelled. More...

Poco::NotificationCenter &	notificationCenter () const
	Return a reference to the algorithm's notification dispatcher. More...

void	handleChildProgressNotification (const Poco::AutoPtr< ProgressNotification > &pNf)
	Observation slot for child algorithm progress notification messages, these are scaled and then signalled for this algorithm. More...

const Poco::AbstractObserver &	progressObserver () const
	Return a reference to the algorithm's object that is reporting progress. More...

bool	isWorkspaceProperty (const Kernel::Property *const prop) const
	checks the property is a workspace property More...

bool	trackingHistory ()
	get whether we are tracking the history for this algorithm, More...

virtual void	fillHistory ()
	Copy workspace history for input workspaces to output workspaces and record the history for ths algorithm. More...

virtual void	setOtherProperties (IAlgorithm *alg, const std::string &propertyName, const std::string &propertyValue, int periodNum)
	Virtual method to set the non workspace properties for this algorithm. More...

template<typename T , const int AllowedIndexTypes = static_cast<int>(IndexType::WorkspaceIndex), typename... WSPropArgs, typename = typename std::enable_if<std::is_convertible<T , MatrixWorkspace >::value>::type>
void	declareWorkspaceInputProperties (const std::string &propertyName, const std::string &doc, WSPropArgs &&...wsPropArgs)

Protected Member Functions inherited from Mantid::Kernel::IPropertyManager
virtual void	afterPropertySet (const std::string &)
	Override this method to perform a custom action right after a property was set. More...

virtual void	clear ()=0
	Clears all properties under management. More...

virtual Property *	getPointerToPropertyOrdinal (const int &index) const =0
	Get a property by an index. More...

template<typename T >
T	getValue (const std::string &name) const
	Templated method to get the value of a property. More...

template<>
MANTID_KERNEL_DLL PropertyManager_sptr	getValue (const std::string &name) const

template<>
MANTID_KERNEL_DLL PropertyManager_const_sptr	getValue (const std::string &name) const

Static Protected Member Functions inherited from Mantid::API::Algorithm
template<typename NumT >
static bool	isEmpty (const NumT toCheck)
	checks that the value was not set by users, uses the value in empty double/int. More...

Protected Attributes inherited from Mantid::API::Algorithm
std::atomic< bool >	m_cancel
	Set to true to stop execution. More...

std::atomic< bool >	m_parallelException
	Set if an exception is thrown, and not caught, within a parallel region. More...

std::vector< IWorkspaceProperty * >	m_inputWorkspaceProps
	All the WorkspaceProperties that are Input or InOut. Set in execute() More...

std::shared_ptr< AlgorithmHistory >	m_history
	Pointer to the history for the algorithm being executed. More...

Kernel::Logger	m_log
	Logger for this algorithm. More...

Kernel::Logger &	g_log

std::shared_ptr< AlgorithmHistory >	m_parentHistory
	Pointer to the parent history object (if set) More...

std::vector< WorkspaceVector >	m_unrolledInputWorkspaces
	One vector of workspaces for each input workspace property. More...

size_t	m_groupSize
	Size of the group(s) being processed. More...

bool	m_usingBaseProcessGroups = false
	distinguish between base processGroups() and overriden/algorithm specific versions More...

Static Protected Attributes inherited from Mantid::API::Algorithm
static size_t	g_execCount = 0
	Counter to keep track of algorithm execution order. More...

Detailed Description

LoadFITS: Load one or more of FITS files into a Workspace2D.

The FITS format, normally used for images, is described for example here: http://www.fileformat.info/format/fits/egff.htm

At the moment this algorithm only supports 2 data axis and the following data types: unsigned 8, 16, 32 bits per pixel.

Definition at line 36 of file LoadFITS.h.

Constructor & Destructor Documentation

◆ LoadFITS()

Mantid::DataHandling::LoadFITS::LoadFITS ( )

Constructor.

Just initialize everything to prevent issues.

Definition at line 81 of file LoadFITS.cpp.

References setupDefaultKeywordNames().

Member Function Documentation

◆ addAxesInfoAndLogs()

void Mantid::DataHandling::LoadFITS::addAxesInfoAndLogs	(	const DataObjects::Workspace2D_sptr &	ws,
		bool	loadAsRectImg,
		const FITSInfo &	fileInfo,
		int	binSize,
		double	cmpp
	)

private

Add information to the workspace being loaded: labels, units, logs related to the image size, etc.

Parameters

ws	workspace to manipulate
loadAsRectImg	if true, the workspace has one spectrum per row and one bin per column
fileInfo	information for the current file
binSize	size to rebin (1 == no re-bin == default)
cmpp	centimeters per pixel (already taking into account possible rebinning)

Definition at line 677 of file LoadFITS.cpp.

References Mantid::DataHandling::FITSInfo::axisPixelLengths, Mantid::DataObjects::create(), Mantid::DataHandling::FITSInfo::headerKeys, height, Mantid::DataHandling::FITSInfo::imageKey, Mantid::Kernel::SingletonHolder< T >::Instance(), and m_sampleRotation.

Referenced by makeWorkspace().

◆ category()

const std::string Mantid::DataHandling::LoadFITS::category ( ) const

inlineoverridevirtual

Algorithm's category for identification overriding a virtual method.

Reimplemented from Mantid::API::Algorithm.

Definition at line 51 of file LoadFITS.h.

◆ confidence()

int Mantid::DataHandling::LoadFITS::confidence ( Kernel::FileDescriptor & descriptor ) const

overridevirtual

Returns a confidence value that this algorithm can load a file.

Return the confidence with with this algorithm can load the file.

Parameters

descriptor A descriptor for the file

Returns: An integer specifying the confidence level. 0 indicates it will not be used

Implements Mantid::API::IFileLoader< Kernel::FileDescriptor >.

Definition at line 93 of file LoadFITS.cpp.

References Mantid::Kernel::FileDescriptor::extension().

◆ doFilterNoise()

void Mantid::DataHandling::LoadFITS::doFilterNoise	(	double	thresh,
		API::MantidImage &	imageY,
		API::MantidImage &	imageE
	)

private

filter noise pixel by pixel

Apply a simple noise filter by averaging threshold-filtered neighbor pixels (with 4-neighbohood / 4-connectivity).

The filtering is done in place for both imageY and imageE.

Parameters

thresh	Threshold to apply on pixels
imageY	raw data (Y values)
imageE	raw data (E/error values)

Definition at line 897 of file LoadFITS.cpp.

Referenced by makeWorkspace().

◆ doLoadFiles()

void Mantid::DataHandling::LoadFITS::doLoadFiles	(	const std::vector< std::string > &	paths,
		const std::string &	outWSName,
		bool	loadAsRectImg,
		int	binSize,
		double	noiseThresh
	)

private

Loads files into workspace(s)

Create FITS file information for each file selected.

Loads headers and data from the files and creates and fills the output workspace(s).

Parameters

paths	File names as given in the algorithm input property
outWSName	name of the output (group) workspace to create
loadAsRectImg	Load files with 1 spectrum per row and 1 bin per column, so a color fill plot displays the image
binSize	size to rebin (1 == no re-bin == default)
noiseThresh	threshold for noise filtering

Exceptions

std::runtime_error when load fails (for example a memory allocation issue, wrong rebin requested, etc.)

Definition at line 370 of file LoadFITS.cpp.

References Mantid::API::Algorithm::createChildAlgorithm(), fetchNumber(), Mantid::API::g_log, Mantid::API::WorkspaceGroup::getNames(), headerSanityCheck(), Mantid::Kernel::Logger::information(), Mantid::Kernel::SingletonHolder< T >::Instance(), isInstrOtherThanIMAT(), loadHeader(), m_pixelCount, makeWorkspace(), Mantid::API::Algorithm::progress(), Mantid::Kernel::IPropertyManager::setProperty(), and std::to_string().

Referenced by exec().

◆ doRebin()

void Mantid::DataHandling::LoadFITS::doRebin	(	size_t	rebin,
		const API::MantidImage &	imageY,
		const API::MantidImage &	imageE,
		API::MantidImage &	rebinnedY,
		API::MantidImage &	rebinnedE
	)

private

rebin the matrix/image

Group pixels in blocks of rebin X rebin.

Parameters

rebin	bin size (n to make blocks of n*n pixels)
imageY	raw data (Y values)
imageE	raw data (E/error values)
rebinnedY	raw data after rebin (Y values)
rebinnedE	raw data after rebin (E/error values)

Definition at line 951 of file LoadFITS.cpp.

Referenced by makeWorkspace().

◆ exec()

void Mantid::DataHandling::LoadFITS::exec ( )

overrideprivatevirtual

Execution code.

Execute the algorithm.

Implements Mantid::API::Algorithm.

Definition at line 151 of file LoadFITS.cpp.

References doLoadFiles(), Mantid::API::Algorithm::getProperty(), Mantid::API::Algorithm::getPropertyValue(), and mapHeaderKeys().

◆ fetchNumber()

size_t Mantid::DataHandling::LoadFITS::fetchNumber ( const std::string & name )

private

Returns the trailing number from a string minus leading 0's (so 25 from workspace_000025)

Returns the trailing number from a string minus leading 0's (so 25 from workspace_00025).

Parameters

name	string with a numerical suffix

Returns: A numerical representation of the string minus leading characters and leading 0's

Definition at line 1085 of file LoadFITS.cpp.

References name().

Referenced by doLoadFiles().

◆ headerSanityCheck()

void Mantid::DataHandling::LoadFITS::headerSanityCheck	(	const FITSInfo &	hdr,
		const FITSInfo &	hdrFirst
	)

private

Once loaded, check against standard and limitations of this algorithm.

Checks that a FITS header (once loaded) is valid/supported: standard (no extension to FITS), and has two axis with the expected dimensions.

Parameters

hdr	FITS header struct loaded from a file - to check
hdrFirst	FITS header struct loaded from a (first) reference file - to compare against

Exceptions

std::exception if there's any issue or unsupported entry in the header

Definition at line 311 of file LoadFITS.cpp.

References Mantid::DataHandling::FITSInfo::axisPixelLengths, Mantid::Kernel::Logger::error(), Mantid::DataHandling::FITSInfo::extension, Mantid::DataHandling::FITSInfo::filePath, Mantid::API::g_log, and Mantid::DataHandling::FITSInfo::numberOfAxis.

Referenced by doLoadFiles().

◆ init()

void Mantid::DataHandling::LoadFITS::init ( )

overrideprivatevirtual

Initialisation code.

Initialise the algorithm.

Declare properties which can be set before execution (input) or read from after the execution (output).

Implements Mantid::API::Algorithm.

Definition at line 103 of file LoadFITS.cpp.

References Mantid::API::Algorithm::declareProperty(), g_HEADER_MAP_NAME, Mantid::Kernel::Direction::Input, Mantid::API::FileProperty::OptionalDirectory, and Mantid::Kernel::Direction::Output.

◆ isInstrOtherThanIMAT()

bool Mantid::DataHandling::LoadFITS::isInstrOtherThanIMAT ( const FITSInfo & hdr )

private

identifies fits coming from 'other' cameras by specific headers

Looks for headers used by specific instruments/cameras, or finds if the instrument does not appear to be IMAT, which is the only one for which we have a camera-instrument definition and because of that is the only one loaded for the moment.

Parameters

hdr	FITS header information

Returns: whether this file seems to come from 'another' camera such as Starlight Xpress, etc.

Definition at line 985 of file LoadFITS.cpp.

References Mantid::API::g_log, Mantid::DataHandling::FITSInfo::headerKeys, and Mantid::Kernel::Logger::information().

Referenced by doLoadFiles().

◆ loadHeader()

void Mantid::DataHandling::LoadFITS::loadHeader	(	const std::string &	filePath,
		FITSInfo &	header
	)

private

Load the FITS header(s) from one fits file into a struct.

Definition at line 167 of file LoadFITS.cpp.

References Mantid::Kernel::Logger::debug(), g_defaultImgType, Mantid::API::g_log, g_XTENSION_KEYNAME, m_headerAxisNameKeys, m_headerBitDepthKey, m_headerImageKeyKey, m_headerNAxisNameKey, m_headerOffsetKey, m_headerScaleKey, parseHeader(), std::to_string(), and Mantid::Kernel::Logger::warning().

Referenced by doLoadFiles().

◆ loadMutipleAsOne()

bool Mantid::DataHandling::LoadFITS::loadMutipleAsOne ( )

inlineoverridevirtual

Returns a value indicating whether or not loader wants to load multiple files into a single workspace.

Reimplemented from Mantid::API::IFileLoader< Kernel::FileDescriptor >.

Definition at line 58 of file LoadFITS.h.

◆ makeWorkspace()

Workspace2D_sptr Mantid::DataHandling::LoadFITS::makeWorkspace	(	const FITSInfo &	fileInfo,
		size_t &	newFileNumber,
		std::vector< char > &	buffer,
		API::MantidImage &	imageY,
		API::MantidImage &	imageE,
		const DataObjects::Workspace2D_sptr &	parent,
		bool	loadAsRectImg = `false`,
		int	binSize = `1`,
		double	noiseThresh = `false`
	)

private

Initialises a workspace with IDF and fills it with data.

Creates and initialises a workspace with instrument definition and fills it with data.

Parameters

fileInfo	information for the current file
newFileNumber	sequence number for the new file when added into ws group
buffer	pre-allocated buffer to contain data values
imageY	Object to set the Y data values in
imageE	Object to set the E data values in
parent	A workspace which can be used to copy initialisation information from (size/instrument def etc)
loadAsRectImg	if true, the new workspace will have one spectrum per row and one bin per column, instead of the (default) as many spectra as pixels.
binSize	size to rebin (1 == no re-bin == default)
noiseThresh	threshold for noise filtering

Returns: A newly created Workspace2D, as a shared pointer

Definition at line 599 of file LoadFITS.cpp.

References addAxesInfoAndLogs(), Mantid::DataHandling::FITSInfo::axisPixelLengths, Mantid::DataObjects::create(), doFilterNoise(), doRebin(), Mantid::DataHandling::FITSInfo::filePath, g_DIGIT_SIZE_APPEND, Mantid::API::Algorithm::getProperty(), Mantid::Kernel::SingletonHolder< T >::Instance(), m_pixelCount, padZeros(), readDataToImgs(), and readDataToWorkspace().

Referenced by doLoadFiles().

◆ mapHeaderKeys()

void Mantid::DataHandling::LoadFITS::mapHeaderKeys ( )

private

Maps the header keys to specified values.

Definition at line 1033 of file LoadFITS.cpp.

References Mantid::Kernel::Logger::error(), g_AXIS_NAMES_NAME, g_BIT_DEPTH_NAME, g_HEADER_MAP_NAME, g_IMAGE_KEY_NAME, Mantid::API::g_log, g_ROTATION_NAME, Mantid::API::Algorithm::getPropertyValue(), m_headerAxisNameKeys, m_headerBitDepthKey, m_headerImageKeyKey, m_headerRotationKey, and name().

Referenced by exec().

◆ name()

const std::string Mantid::DataHandling::LoadFITS::name ( ) const

inlineoverridevirtual

Algorithm's name for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Definition at line 41 of file LoadFITS.h.

Referenced by fetchNumber(), and mapHeaderKeys().

◆ padZeros()

std::string Mantid::DataHandling::LoadFITS::padZeros	(	const size_t	number,
		const size_t	totalDigitCount
	)

private

Adds 0's to the front of a number to create a string of size totalDigitCount including number.

Parameters

number	input number to add padding to
totalDigitCount	width of the resulting string with 0s followed by number

Returns: A string with the 0-padded number

Definition at line 1107 of file LoadFITS.cpp.

Referenced by makeWorkspace().

◆ parseHeader()

void Mantid::DataHandling::LoadFITS::parseHeader ( FITSInfo & headerInfo )

private

Parses the header values for the FITS file.

Read a single files header and populate an object with the information.

Parameters

headerInfo A FITSInfo file object to parse header information into. This object must have its field filePath set to the input file

A typical simple FITS header looks like this:

SIMPLE  =                    T / file does conform to FITS standard
BITPIX  =                   16 / number of bits per data pixel
NAXIS   =                    2 / number of data axes
NAXIS1  =                  512 / length of data axis 1
NAXIS2  =                  512 / length of data axis 2
EXTEND  =                    T / FITS dataset may contain extensions
COMMENT   FITS (Flexible Image Transport System) format is defined in 'Astronomy
COMMENT   and Astrophysics', volume 376, page 359; bibcode: 2001A&A...376..359H
TOF     =   0.0595897599999995 / Ttime of flight from the external trigger
TIMEBIN =           4.096E-005 / Time width of this image
N_COUNTS=               182976 / Total counts in this image
N_TRIGS =                 4426 / Number of triggers acquired
END

Exceptions

various std::runtime_error etc. on read failure

Definition at line 499 of file LoadFITS.cpp.

References Mantid::DataHandling::FITSInfo::filePath, g_BASE_HEADER_SIZE, g_COMMENT_KEYNAME, g_END_KEYNAME, Mantid::DataHandling::FITSInfo::headerItems, Mantid::DataHandling::FITSInfo::headerKeys, Mantid::DataHandling::FITSInfo::headerSizeMultiplier, std::to_string(), and value.

Referenced by loadHeader().

◆ readDataToImgs()

void Mantid::DataHandling::LoadFITS::readDataToImgs	(	const FITSInfo &	fileInfo,
		API::MantidImage &	imageY,
		API::MantidImage &	imageE,
		std::vector< char > &	buffer
	)

private

Reads the data (FITS matrix) from a single FITS file into image objects (Y and E).

E is filled with the sqrt() of Y.

Parameters

fileInfo	information on the FITS file to load, including its path
imageY	Object to set the Y data values in
imageE	Object to set the E data values in
buffer	pre-allocated buffer to contain data values

Exceptions

std::runtime_error if there are file input issues

Definition at line 812 of file LoadFITS.cpp.

References Mantid::DataHandling::FITSInfo::axisPixelLengths, Mantid::DataHandling::FITSInfo::bitsPerPixel, Mantid::DataHandling::FITSInfo::isFloat, m_pixelCount, Mantid::DataHandling::FITSInfo::offset, readInBuffer(), Mantid::DataHandling::FITSInfo::scale, and tmp.

Referenced by makeWorkspace().

◆ readDataToWorkspace()

void Mantid::DataHandling::LoadFITS::readDataToWorkspace	(	const FITSInfo &	fileInfo,
		double	cmpp,
		const DataObjects::Workspace2D_sptr &	ws,
		std::vector< char > &	buffer
	)

private

Reads the data (FITS matrix) from a single FITS file into a workspace (directly into the spectra, using one spectrum per image row).

Parameters

fileInfo	information on the FITS file to load, including its path
cmpp	centimeters per pixel, to scale/normalize values
ws	workspace with the required dimensions
buffer	pre-allocated buffer to read from file

Exceptions

std::runtime_error if there are file input issues

Definition at line 753 of file LoadFITS.cpp.

References Mantid::DataHandling::FITSInfo::axisPixelLengths, Mantid::DataHandling::FITSInfo::bitsPerPixel, g_maxBytesPP, Mantid::DataHandling::FITSInfo::isFloat, m_pixelCount, ncols, nrows, Mantid::DataHandling::FITSInfo::offset, PARALLEL_FOR_NO_WSP_CHECK, readInBuffer(), and Mantid::DataHandling::FITSInfo::scale.

Referenced by makeWorkspace().

◆ readInBuffer()

void Mantid::DataHandling::LoadFITS::readInBuffer	(	const FITSInfo &	fileInfo,
		std::vector< char > &	buffer,
		size_t	len
	)

private

Reads the data (FITS matrix) from a single FITS file into a buffer.

This simply reads the raw block of data, without doing any re-scaling or adjustment.

Parameters

fileInfo	information on the FITS file to load, including its path
buffer	pre-allocated buffer where to read data
len	amount of chars/bytes/octets to read

Exceptions

std::runtime_error if there are file input issues

Definition at line 874 of file LoadFITS.cpp.

References Mantid::DataHandling::FITSInfo::filePath, g_BASE_HEADER_SIZE, Mantid::DataHandling::FITSInfo::headerSizeMultiplier, and std::to_string().

Referenced by readDataToImgs(), and readDataToWorkspace().

◆ seeAlso()

const std::vector< std::string > Mantid::DataHandling::LoadFITS::seeAlso ( ) const

inlineoverridevirtual

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

Reimplemented from Mantid::API::Algorithm.

Definition at line 48 of file LoadFITS.h.

◆ setupDefaultKeywordNames()

void Mantid::DataHandling::LoadFITS::setupDefaultKeywordNames ( )

private

Sets several keyword names with default (and standard) values.

You don't want to change these unless you want to break compatibility with the FITS standard.

Definition at line 1010 of file LoadFITS.cpp.

References m_headerAxisNameKeys, m_headerBitDepthKey, m_headerImageKeyKey, m_headerNAxisNameKey, m_headerOffsetKey, m_headerRotationKey, m_headerScaleKey, m_imageType, m_mapFile, and m_sampleRotation.

Referenced by LoadFITS().

◆ summary()

const std::string Mantid::DataHandling::LoadFITS::summary ( ) const

inlineoverridevirtual

Summary of algorithms purpose.

Implements Mantid::API::Algorithm.

Definition at line 44 of file LoadFITS.h.

◆ version()

int Mantid::DataHandling::LoadFITS::version ( ) const

inlineoverridevirtual

Algorithm's version for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Definition at line 47 of file LoadFITS.h.

Member Data Documentation

◆ g_AXIS_NAMES_NAME

const std::string Mantid::DataHandling::LoadFITS::g_AXIS_NAMES_NAME = "AxisNames"

staticprivate

Definition at line 155 of file LoadFITS.h.

Referenced by mapHeaderKeys().

◆ g_BASE_HEADER_SIZE

const int Mantid::DataHandling::LoadFITS::g_BASE_HEADER_SIZE = 2880

staticprivate

size of a FITS header block (room for 36 entries, of 80 characters each), in bytes.

A FITS header always comes in multiples of this block.

Definition at line 145 of file LoadFITS.h.

Referenced by parseHeader(), and readInBuffer().

◆ g_BIT_DEPTH_NAME

const std::string Mantid::DataHandling::LoadFITS::g_BIT_DEPTH_NAME = "BitDepthName"

staticprivate

Definition at line 154 of file LoadFITS.h.

Referenced by mapHeaderKeys().

◆ g_COMMENT_KEYNAME

const std::string Mantid::DataHandling::LoadFITS::g_COMMENT_KEYNAME = "COMMENT"

staticprivate

Definition at line 152 of file LoadFITS.h.

Referenced by parseHeader().

◆ g_defaultImgType

const std::string Mantid::DataHandling::LoadFITS::g_defaultImgType = "SAMPLE"

staticprivate

Definition at line 131 of file LoadFITS.h.

Referenced by loadHeader().

◆ g_DIGIT_SIZE_APPEND

const size_t Mantid::DataHandling::LoadFITS::g_DIGIT_SIZE_APPEND = 6

staticprivate

Definition at line 141 of file LoadFITS.h.

Referenced by makeWorkspace().

◆ g_END_KEYNAME

const std::string Mantid::DataHandling::LoadFITS::g_END_KEYNAME = "END"

staticprivate

Definition at line 151 of file LoadFITS.h.

Referenced by parseHeader().

◆ g_HEADER_MAP_NAME

const std::string Mantid::DataHandling::LoadFITS::g_HEADER_MAP_NAME = "HeaderMapFile"

staticprivate

Definition at line 158 of file LoadFITS.h.

Referenced by init(), and mapHeaderKeys().

◆ g_IMAGE_KEY_NAME

const std::string Mantid::DataHandling::LoadFITS::g_IMAGE_KEY_NAME = "ImageKeyName"

staticprivate

Definition at line 157 of file LoadFITS.h.

Referenced by mapHeaderKeys().

◆ g_maxBitDepth

const size_t Mantid::DataHandling::LoadFITS::g_maxBitDepth = 64

staticprivate

Definition at line 162 of file LoadFITS.h.

◆ g_maxBytesPP

const size_t Mantid::DataHandling::LoadFITS::g_maxBytesPP = g_maxBitDepth / 8

staticprivate

Definition at line 164 of file LoadFITS.h.

Referenced by readDataToWorkspace().

◆ g_ROTATION_NAME

const std::string Mantid::DataHandling::LoadFITS::g_ROTATION_NAME = "RotationName"

staticprivate

Definition at line 156 of file LoadFITS.h.

Referenced by mapHeaderKeys().

◆ g_XTENSION_KEYNAME

const std::string Mantid::DataHandling::LoadFITS::g_XTENSION_KEYNAME = "XTENSION"

staticprivate

Definition at line 153 of file LoadFITS.h.

Referenced by loadHeader().

◆ m_headerAxisNameKeys

std::vector<std::string> Mantid::DataHandling::LoadFITS::m_headerAxisNameKeys

private

Definition at line 128 of file LoadFITS.h.

Referenced by loadHeader(), mapHeaderKeys(), and setupDefaultKeywordNames().

◆ m_headerBitDepthKey

std::string Mantid::DataHandling::LoadFITS::m_headerBitDepthKey

private

Definition at line 124 of file LoadFITS.h.

Referenced by loadHeader(), mapHeaderKeys(), and setupDefaultKeywordNames().

◆ m_headerImageKeyKey

std::string Mantid::DataHandling::LoadFITS::m_headerImageKeyKey

private

Definition at line 126 of file LoadFITS.h.

Referenced by loadHeader(), mapHeaderKeys(), and setupDefaultKeywordNames().

◆ m_headerNAxisNameKey

std::string Mantid::DataHandling::LoadFITS::m_headerNAxisNameKey

private

Definition at line 127 of file LoadFITS.h.

Referenced by loadHeader(), and setupDefaultKeywordNames().

◆ m_headerOffsetKey

std::string Mantid::DataHandling::LoadFITS::m_headerOffsetKey

private

Definition at line 123 of file LoadFITS.h.

Referenced by loadHeader(), and setupDefaultKeywordNames().

◆ m_headerRotationKey

std::string Mantid::DataHandling::LoadFITS::m_headerRotationKey

private

Definition at line 125 of file LoadFITS.h.

Referenced by mapHeaderKeys(), and setupDefaultKeywordNames().

◆ m_headerScaleKey

std::string Mantid::DataHandling::LoadFITS::m_headerScaleKey

private

Definition at line 122 of file LoadFITS.h.

Referenced by loadHeader(), and setupDefaultKeywordNames().

◆ m_imageType

std::string Mantid::DataHandling::LoadFITS::m_imageType

private

Definition at line 135 of file LoadFITS.h.

Referenced by setupDefaultKeywordNames().

◆ m_mapFile

std::string Mantid::DataHandling::LoadFITS::m_mapFile

private

Definition at line 129 of file LoadFITS.h.

Referenced by setupDefaultKeywordNames().

◆ m_pixelCount

size_t Mantid::DataHandling::LoadFITS::m_pixelCount

private

Definition at line 137 of file LoadFITS.h.

Referenced by doLoadFiles(), makeWorkspace(), readDataToImgs(), and readDataToWorkspace().

◆ m_sampleRotation

std::string Mantid::DataHandling::LoadFITS::m_sampleRotation

private

Definition at line 134 of file LoadFITS.h.

Referenced by addAxesInfoAndLogs(), and setupDefaultKeywordNames().

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

Framework/DataHandling/inc/MantidDataHandling/LoadFITS.h
Framework/DataHandling/src/LoadFITS.cpp

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LoadFITS()

Member Function Documentation

◆ addAxesInfoAndLogs()

◆ category()

◆ confidence()

◆ doFilterNoise()

◆ doLoadFiles()

◆ doRebin()

◆ exec()

◆ fetchNumber()

◆ headerSanityCheck()

◆ init()

◆ isInstrOtherThanIMAT()

◆ loadHeader()

◆ loadMutipleAsOne()

◆ makeWorkspace()

◆ mapHeaderKeys()

◆ name()

◆ padZeros()

◆ parseHeader()

◆ readDataToImgs()

◆ readDataToWorkspace()

◆ readInBuffer()

◆ seeAlso()

◆ setupDefaultKeywordNames()

◆ summary()

◆ version()

Member Data Documentation

◆ g_AXIS_NAMES_NAME

◆ g_BASE_HEADER_SIZE

◆ g_BIT_DEPTH_NAME

◆ g_COMMENT_KEYNAME

◆ g_defaultImgType

◆ g_DIGIT_SIZE_APPEND

◆ g_END_KEYNAME

◆ g_HEADER_MAP_NAME

◆ g_IMAGE_KEY_NAME

◆ g_maxBitDepth

◆ g_maxBytesPP

◆ g_ROTATION_NAME

◆ g_XTENSION_KEYNAME

◆ m_headerAxisNameKeys

◆ m_headerBitDepthKey

◆ m_headerImageKeyKey

◆ m_headerNAxisNameKey

◆ m_headerOffsetKey

◆ m_headerRotationKey

◆ m_headerScaleKey

◆ m_imageType

◆ m_mapFile

◆ m_pixelCount

◆ m_sampleRotation