This task does the disk IO from loading the NXS file, and so will be on a disk IO mutex. More...

#include <LoadBankFromDiskTask.h>

Inheritance diagram for Mantid::DataHandling::LoadBankFromDiskTask:

Public Member Functions
	LoadBankFromDiskTask (DefaultEventLoader &loader, std::string entry_name, std::string entry_type, const std::size_t numEvents, const bool oldNeXusFileNames, API::Progress *prog, std::shared_ptr< std::mutex > ioMutex, Kernel::ThreadScheduler &scheduler, std::vector< int > framePeriodNumbers)
	Constructor.

void	run () override
	Main method that performs the work for the task.

Public Member Functions inherited from Mantid::Kernel::Task
virtual double	cost ()
	What is the computational cost of this task?

std::shared_ptr< std::mutex >	getMutex ()
	Get the mutex object for this Task.

void	setMutex (const std::shared_ptr< std::mutex > &mutex)
	Set the mutex object for this Task.

void	setMutexObject (void *object)
	Use an arbitrary pointer to lock (mutex) the execution of this task.

	Task ()
	Default constructor.

	Task (double cost)
	Constructor with cost.

virtual	~Task ()=default
	Destructor.

Private Member Functions
std::unique_ptr< std::vector< uint32_t > >	loadEventId (Nexus::File &file)
	Load the event_id field, which has been opened.

std::unique_ptr< std::vector< uint64_t > >	loadEventIndex (Nexus::File &file)
	Load the event_index field (a list of size of # of pulses giving the index in the event list for that pulse)

std::unique_ptr< std::vector< float > >	loadEventWeights (Nexus::File &file)
	Load weight of weigthed events if they exist.

void	loadPulseTimes (Nexus::File &file)
	Load the pulse times, if needed.

std::unique_ptr< std::vector< float > >	loadTof (Nexus::File &file)
	Open and load the times-of-flight data.

void	prepareEventId (Nexus::File &file, uint64_t &start_event, uint64_t &stop_event, const uint64_t &start_event_index)
	Open the event_id field and validate the contents.

uint64_t	recalculateDataSize (const int64_t size)
	Interpret the value describing the number of events.

Private Attributes
std::string	entry_name
	NXS address to bank.

std::string	entry_type
	NXS type.

std::string	m_detIdFieldName

const std::vector< int >	m_framePeriodNumbers
	Frame period numbers.

bool	m_have_weight
	Flag for simulated data.

DefaultEventLoader &	m_loader
	Algorithm being run.

bool	m_loadError
	Did we get an error in loading.

Nexus::DimVector	m_loadSize
	How much to load in the file.

Nexus::DimVector	m_loadStart
	Index to load start at in the file.

uint32_t	m_max_id
	Maximum pixel ID in this data.

uint32_t	m_min_id
	Minimum pixel ID in this data.

std::string	m_timeOfFlightFieldName

API::Progress *	prog
	Progress reporting.

Kernel::ThreadScheduler &	scheduler
	ThreadScheduler running this task.

std::shared_ptr< BankPulseTimes >	thisBankPulseTimes
	Object with the pulse times for this bank.

Additional Inherited Members
Protected Attributes inherited from Mantid::Kernel::Task
double	m_cost
	Cached computational cost for the thread.

std::shared_ptr< std::mutex >	m_mutex
	Mutex associated with this task (can be NULL)

Detailed Description

This task does the disk IO from loading the NXS file, and so will be on a disk IO mutex.

Definition at line 29 of file LoadBankFromDiskTask.h.

Constructor & Destructor Documentation

◆ LoadBankFromDiskTask()

Mantid::DataHandling::LoadBankFromDiskTask::LoadBankFromDiskTask	(	DefaultEventLoader &	loader,
		std::string	entry_name,
		std::string	entry_type,
		const std::size_t	numEvents,
		const bool	oldNeXusFileNames,
		API::Progress *	prog,
		std::shared_ptr< std::mutex >	ioMutex,
		Kernel::ThreadScheduler &	scheduler,
		std::vector< int >	framePeriodNumbers
	)

Constructor.

Parameters

loader	:: Handle to the main loader
entry_name	:: The address of the bank to load
entry_type	:: The classtype of the entry to load
numEvents	:: The number of events in the bank.
oldNeXusFileNames	:: Identify if file is of old variety.
prog	:: an optional Progress object
ioMutex	:: a mutex shared for all Disk I-O tasks
scheduler	:: the ThreadScheduler that runs this task.
framePeriodNumbers	:: Period numbers corresponding to each frame

Definition at line 43 of file LoadBankFromDiskTask.cpp.

References Mantid::Kernel::Task::m_cost, m_detIdFieldName, m_max_id, m_min_id, m_timeOfFlightFieldName, Mantid::DataHandling::numEvents(), and Mantid::Kernel::Task::setMutex().

Member Function Documentation

◆ loadEventId()

std::unique_ptr< std::vector< uint32_t > > Mantid::DataHandling::LoadBankFromDiskTask::loadEventId ( Nexus::File & file )

private

Load the event_id field, which has been opened.

Parameters

file	An Nexus::File object opened at the correct group

Returns: A new array containing the event Ids for this bank

Definition at line 168 of file LoadBankFromDiskTask.cpp.

References Mantid::DataHandling::DefaultEventLoader::alg, Mantid::Nexus::Info::dims, entry_name, Mantid::DataHandling::DefaultEventLoader::eventid_max, Mantid::API::Algorithm::getLogger(), m_detIdFieldName, m_loader, m_loadError, m_loadSize, m_loadStart, m_max_id, m_min_id, Mantid::DataHandling::DefaultEventLoader::pixelID_to_wi_offset, recalculateDataSize(), and Mantid::Kernel::Logger::warning().

Referenced by run().

◆ loadEventIndex()

std::unique_ptr< std::vector< uint64_t > > Mantid::DataHandling::LoadBankFromDiskTask::loadEventIndex ( Nexus::File & file )

private

Load the event_index field (a list of size of # of pulses giving the index in the event list for that pulse)

Parameters

file	:: File handle for the NeXus file

Definition at line 107 of file LoadBankFromDiskTask.cpp.

References Mantid::DataHandling::DefaultEventLoader::alg, Mantid::Kernel::Logger::debug(), entry_name, Mantid::API::Algorithm::getLogger(), m_loader, and m_loadError.

Referenced by run().

◆ loadEventWeights()

std::unique_ptr< std::vector< float > > Mantid::DataHandling::LoadBankFromDiskTask::loadEventWeights ( Nexus::File & file )

private

Load weight of weigthed events if they exist.

Parameters

file	An Nexus::File object opened at the correct group

Returns: A new array containing the weights or a nullptr if the weights are not present

Definition at line 267 of file LoadBankFromDiskTask.cpp.

References Mantid::DataHandling::DefaultEventLoader::alg, entry_name, NXnumtype::FLOAT32, Mantid::API::Algorithm::getLogger(), m_have_weight, m_loader, m_loadError, m_loadSize, m_loadStart, recalculateDataSize(), and Mantid::Kernel::Logger::warning().

Referenced by run().

◆ loadPulseTimes()

void Mantid::DataHandling::LoadBankFromDiskTask::loadPulseTimes ( Nexus::File & file )

private

Load the pulse times, if needed.

This sets thisBankPulseTimes to the right pointer.

Definition at line 64 of file LoadBankFromDiskTask.cpp.

References Mantid::DataHandling::DefaultEventLoader::alg, Mantid::API::Algorithm::getLogger(), Mantid::DataHandling::LoadEventNexus::m_allBanksPulseTimes, Mantid::DataHandling::DefaultEventLoader::m_bankPulseTimes, m_framePeriodNumbers, m_loader, thisBankPulseTimes, and Mantid::Kernel::Logger::warning().

Referenced by run().

◆ loadTof()

std::unique_ptr< std::vector< float > > Mantid::DataHandling::LoadBankFromDiskTask::loadTof ( Nexus::File & file )

private

Open and load the times-of-flight data.

Parameters

file	An Nexus::File object opened at the correct group

Returns: A new array containing the time of flights for this bank

Definition at line 222 of file LoadBankFromDiskTask.cpp.

References Mantid::DataHandling::DefaultEventLoader::alg, Mantid::Nexus::Info::dims, entry_name, Mantid::API::Algorithm::getLogger(), m_loader, m_loadError, m_loadSize, m_loadStart, m_timeOfFlightFieldName, recalculateDataSize(), Mantid::Kernel::Units::timeConversionVector(), and Mantid::Kernel::Logger::warning().

Referenced by run().

◆ prepareEventId()

void Mantid::DataHandling::LoadBankFromDiskTask::prepareEventId	(	Nexus::File &	file,
		uint64_t &	start_event,
		uint64_t &	stop_event,
		const uint64_t &	start_event_index
	)

private

Open the event_id field and validate the contents.

Parameters

file	:: File handle for the NeXus file
start_event	:: set to the index of the first event
stop_event	:: set to the index of the last event + 1
start_event_index	:: (a list of size of # of pulses giving the index in the event list for that pulse)

Definition at line 135 of file LoadBankFromDiskTask.cpp.

References Mantid::DataHandling::DefaultEventLoader::alg, Mantid::DataHandling::DefaultEventLoader::chunk, Mantid::Kernel::Logger::debug(), Mantid::Nexus::Info::dims, Mantid::EMPTY_INT(), entry_name, Mantid::DataHandling::DefaultEventLoader::eventsPerChunk, Mantid::DataHandling::DefaultEventLoader::firstChunkForBank, Mantid::API::Algorithm::getLogger(), m_detIdFieldName, m_loader, and recalculateDataSize().

Referenced by run().

◆ recalculateDataSize()

uint64_t Mantid::DataHandling::LoadBankFromDiskTask::recalculateDataSize ( const int64_t size )

private

Interpret the value describing the number of events.

If the number is positive return it unchanged. If the value is negative (can happen at ISIS) add 2^32 to it.

Parameters

size	:: The size of events value.

Definition at line 545 of file LoadBankFromDiskTask.cpp.

Referenced by loadEventId(), loadEventWeights(), loadTof(), and prepareEventId().

◆ run()

void Mantid::DataHandling::LoadBankFromDiskTask::run ( )

overridevirtual

Main method that performs the work for the task.

Implements Mantid::Kernel::Task.

Definition at line 305 of file LoadBankFromDiskTask.cpp.

Member Data Documentation

◆ entry_name

std::string Mantid::DataHandling::LoadBankFromDiskTask::entry_name

private

NXS address to bank.

Definition at line 52 of file LoadBankFromDiskTask.h.

Referenced by loadEventId(), loadEventIndex(), loadEventWeights(), loadTof(), prepareEventId(), and run().

◆ entry_type

std::string Mantid::DataHandling::LoadBankFromDiskTask::entry_type

private

NXS type.

Definition at line 54 of file LoadBankFromDiskTask.h.

Referenced by run().

◆ m_detIdFieldName

std::string Mantid::DataHandling::LoadBankFromDiskTask::m_detIdFieldName

private

Definition at line 64 of file LoadBankFromDiskTask.h.

Referenced by LoadBankFromDiskTask(), loadEventId(), and prepareEventId().

◆ m_framePeriodNumbers

const std::vector<int> Mantid::DataHandling::LoadBankFromDiskTask::m_framePeriodNumbers

private

Frame period numbers.

Definition at line 77 of file LoadBankFromDiskTask.h.

Referenced by loadPulseTimes().

◆ m_have_weight

bool Mantid::DataHandling::LoadBankFromDiskTask::m_have_weight

private

Flag for simulated data.

Definition at line 75 of file LoadBankFromDiskTask.h.

Referenced by loadEventWeights(), and run().

◆ m_loader

DefaultEventLoader& Mantid::DataHandling::LoadBankFromDiskTask::m_loader

private

Algorithm being run.

Definition at line 50 of file LoadBankFromDiskTask.h.

Referenced by loadEventId(), loadEventIndex(), loadEventWeights(), loadPulseTimes(), loadTof(), prepareEventId(), and run().

◆ m_loadError

bool Mantid::DataHandling::LoadBankFromDiskTask::m_loadError

private

Did we get an error in loading.

Definition at line 62 of file LoadBankFromDiskTask.h.

Referenced by loadEventId(), loadEventIndex(), loadEventWeights(), loadTof(), and run().

◆ m_loadSize

Nexus::DimVector Mantid::DataHandling::LoadBankFromDiskTask::m_loadSize

private

How much to load in the file.

Definition at line 69 of file LoadBankFromDiskTask.h.

Referenced by loadEventId(), loadEventWeights(), loadTof(), and run().

◆ m_loadStart

Nexus::DimVector Mantid::DataHandling::LoadBankFromDiskTask::m_loadStart

private

Index to load start at in the file.

Definition at line 67 of file LoadBankFromDiskTask.h.

Referenced by loadEventId(), loadEventWeights(), loadTof(), and run().

◆ m_max_id

uint32_t Mantid::DataHandling::LoadBankFromDiskTask::m_max_id

private

Maximum pixel ID in this data.

Definition at line 73 of file LoadBankFromDiskTask.h.

Referenced by LoadBankFromDiskTask(), loadEventId(), and run().

◆ m_min_id

uint32_t Mantid::DataHandling::LoadBankFromDiskTask::m_min_id

private

Minimum pixel ID in this data.

Definition at line 71 of file LoadBankFromDiskTask.h.

Referenced by LoadBankFromDiskTask(), loadEventId(), and run().

◆ m_timeOfFlightFieldName

std::string Mantid::DataHandling::LoadBankFromDiskTask::m_timeOfFlightFieldName

private

Definition at line 65 of file LoadBankFromDiskTask.h.

Referenced by LoadBankFromDiskTask(), and loadTof().

◆ prog

API::Progress* Mantid::DataHandling::LoadBankFromDiskTask::prog

private

Progress reporting.

Definition at line 56 of file LoadBankFromDiskTask.h.

Referenced by run().

◆ scheduler

Kernel::ThreadScheduler& Mantid::DataHandling::LoadBankFromDiskTask::scheduler

private

ThreadScheduler running this task.

Definition at line 58 of file LoadBankFromDiskTask.h.

Referenced by run().

◆ thisBankPulseTimes

std::shared_ptr<BankPulseTimes> Mantid::DataHandling::LoadBankFromDiskTask::thisBankPulseTimes

private

Object with the pulse times for this bank.

Definition at line 60 of file LoadBankFromDiskTask.h.

Referenced by loadPulseTimes(), and run().

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

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LoadBankFromDiskTask()

Member Function Documentation

◆ loadEventId()

◆ loadEventIndex()

◆ loadEventWeights()

◆ loadPulseTimes()

◆ loadTof()

◆ prepareEventId()

◆ recalculateDataSize()

◆ run()

Member Data Documentation

◆ entry_name

◆ entry_type

◆ m_detIdFieldName

◆ m_framePeriodNumbers

◆ m_have_weight

◆ m_loader

◆ m_loadError

◆ m_loadSize

◆ m_loadStart

◆ m_max_id

◆ m_min_id

◆ m_timeOfFlightFieldName

◆ prog

◆ scheduler

◆ thisBankPulseTimes