Mantid::MDAlgorithms::LoadSQWHelper::dataPositions Struct Reference

#include <LoadSQW.h>

Public Member Functions
	dataPositions ()
	Default Constructor. More...
std::streamoff	parse_component_header (std::ifstream &dataStream, std::streamoff start_location)
	Block 2: Header: Parse header of single SPE file. More...
void	parse_data_locations (std::ifstream &dataStream, std::streamoff data_start, std::vector< size_t > &nBins, uint64_t &nDataPoints)
	Block 4: Data: parse positions of the data fields. More...
std::streamoff	parse_sqw_detpar (std::ifstream &dataStream, std::streamoff start_location)
	Block 3: Detpar: parse positions of the contributed detectors. More...
void	parse_sqw_main_header (std::ifstream &dataStream)
	Block 1: Main_header: Parse SQW main data header. More...

Public Attributes
std::vector< std::streamoff >	component_headers_starts
std::streamoff	data_start
std::streamoff	detectors_start
std::streamoff	err_start
std::streamoff	geom_start
std::streamoff	if_sqw_start
size_t	mdImageSize
std::streamoff	min_max_start
std::streamoff	n_cell_pix_start
std::streamoff	n_dims_start
std::streamoff	npax_start
std::streamoff	pix_start
std::streamoff	s_start
std::streamoff	sqw_header_start

Detailed Description

Definition at line 37 of file LoadSQW.h.

Constructor & Destructor Documentation

dataPositions()

Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::dataPositions ( )

inline

Default Constructor.

Definition at line 58 of file LoadSQW.h.

Member Function Documentation

parse_component_header()

std::streamoff Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::parse_component_header	(	std::ifstream &	dataStream,
		std::streamoff	start_location
	)

Block 2: Header: Parse header of single SPE file.

Parameters

dataStream	– the open file handler responsible for IO operations
start_location	– initial file position of the header within the binary file

Returns

: the file location of the first byte behind this header

Definition at line 715 of file LoadSQW.cpp.

Referenced by Mantid::MDAlgorithms::LoadSQW::parseMetadata().

parse_data_locations()

void Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::parse_data_locations	(	std::ifstream &	dataStream,
		std::streamoff	data_start,
		std::vector< size_t > &	nBins,
		uint64_t &	nDataPoints
	)

Block 4: Data: parse positions of the data fields.

Parameters

dataStream	– the open file handler responsible for IO operations
data_start	– Initial position of the data block4 within the data file
nBins	– the vector of bin sizes for MD image
nDataPoints	– number of pixels (MD events) contributing to the image

Definition at line 800 of file LoadSQW.cpp.

References data_start, err_start, geom_start, mdImageSize, min_max_start, n_cell_pix_start, npax_start, pix_start, and s_start.

Referenced by Mantid::MDAlgorithms::LoadSQW::parseMetadata().

parse_sqw_detpar()

std::streamoff Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::parse_sqw_detpar	(	std::ifstream &	dataStream,
		std::streamoff	start_location
	)

Block 3: Detpar: parse positions of the contributed detectors.

These detectors have to be the same for all contributing spe files

These detectors have to be the same for all contributing spe files

Parameters

dataStream	– the open file handler responsible for IO operations
start_location	– initial file position of the detectors data within the binary file

Returns

: the file location of the first byte behind this header

Definition at line 768 of file LoadSQW.cpp.

Referenced by Mantid::MDAlgorithms::LoadSQW::parseMetadata().

parse_sqw_main_header()

void Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::parse_sqw_main_header

(

std::ifstream &

dataStream

)

Block 1: Main_header: Parse SQW main data header.

Parameters

dataStream

– the open file handler responsible for IO operations

allocate space for the component headers positions;

Definition at line 670 of file LoadSQW.cpp.

References component_headers_starts.

Referenced by Mantid::MDAlgorithms::LoadSQW::parseMetadata().

Member Data Documentation

component_headers_starts

std::vector<std::streamoff> Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::component_headers_starts

Definition at line 41 of file LoadSQW.h.

Referenced by parse_sqw_main_header(), and Mantid::MDAlgorithms::LoadSQW::parseMetadata().

data_start

std::streamoff Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::data_start

Definition at line 43 of file LoadSQW.h.

Referenced by parse_data_locations(), and Mantid::MDAlgorithms::LoadSQW::parseMetadata().

detectors_start

std::streamoff Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::detectors_start

Definition at line 42 of file LoadSQW.h.

Referenced by Mantid::MDAlgorithms::LoadSQW::parseMetadata().

err_start

std::streamoff Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::err_start

Definition at line 47 of file LoadSQW.h.

Referenced by parse_data_locations().

geom_start

std::streamoff Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::geom_start

Definition at line 44 of file LoadSQW.h.

Referenced by Mantid::MDAlgorithms::LoadSQW::addLattice(), parse_data_locations(), and Mantid::MDAlgorithms::LoadSQW::readDNDDimensions().

if_sqw_start

std::streamoff Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::if_sqw_start

Definition at line 38 of file LoadSQW.h.

Referenced by Mantid::MDAlgorithms::LoadSQW::parseMetadata().

mdImageSize

size_t Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::mdImageSize

Definition at line 53 of file LoadSQW.h.

Referenced by parse_data_locations(), and Mantid::MDAlgorithms::LoadSQW::readBoxSizes().

min_max_start

std::streamoff Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::min_max_start

Definition at line 49 of file LoadSQW.h.

Referenced by parse_data_locations(), and Mantid::MDAlgorithms::LoadSQW::readSQWDimensions().

n_cell_pix_start

std::streamoff Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::n_cell_pix_start

Definition at line 48 of file LoadSQW.h.

Referenced by parse_data_locations(), and Mantid::MDAlgorithms::LoadSQW::readBoxSizes().

n_dims_start

std::streamoff Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::n_dims_start

Definition at line 39 of file LoadSQW.h.

npax_start

std::streamoff Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::npax_start

Definition at line 45 of file LoadSQW.h.

Referenced by parse_data_locations().

pix_start

std::streamoff Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::pix_start

Definition at line 52 of file LoadSQW.h.

Referenced by parse_data_locations(), and Mantid::MDAlgorithms::LoadSQW::readEvents().

s_start

std::streamoff Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::s_start

Definition at line 46 of file LoadSQW.h.

Referenced by parse_data_locations().

sqw_header_start

std::streamoff Mantid::MDAlgorithms::LoadSQWHelper::dataPositions::sqw_header_start

Definition at line 40 of file LoadSQW.h.

---

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

• Framework/MDAlgorithms/inc/MantidMDAlgorithms/LoadSQW.h
• Framework/MDAlgorithms/src/LoadSQW.cpp