\(\renewcommand\AA{\unicode{x212B}}\)

DetermineChunking v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Workflow algorithm to determine chunking strategy for event nexus, runinfo.xml, raw, or histo nexus files.

Properties

Name

Direction

Type

Default

Description

Filename

Input

string

Mandatory

The name of the event nexus, runinfo.xml, raw, or histo nexus file to read, including its full or relative path. The Event NeXus file name is typically of the form INST_####_event.nxs (N.B. case sensitive if running on Linux). Allowed extensions: [‘.nxs’, ‘.nxs.h5’, ‘.raw’, ‘_event.nxs’, ‘_histo.nxs’, ‘_runinfo.xml’]

MaxChunkSize

Input

number

Optional

Get chunking strategy for chunks with this number of Gbytes. File will not be loaded if this option is set.

OutputWorkspace

Output

TableWorkspace

Mandatory

An output workspace.

Description

Workflow algorithm to determine chunking strategy for event nexus, runinfo.xml, raw, or histo nexus files

Usage

Example

ws=DetermineChunking("CNCS_7860_event.nxs",MaxChunkSize=0.0005)
print("A max chunck size of 0.0005 created {} chunks.".format(ws.rowCount()))

#The algorithm can also use the SNS runinfo.xml file
ws2=DetermineChunking("CNCS_7860_runinfo.xml",MaxChunkSize=0.0010)
print("A max chunck size of 0.0010 created {} chunks.".format(ws2.rowCount()))

Output:

A max chunck size of 0.0005 created 11 chunks.
A max chunck size of 0.0010 created 6 chunks.

Categories: AlgorithmIndex | DataHandling\PreNexus | Workflow\DataHandling

Source

C++ header: DetermineChunking.h

C++ source: DetermineChunking.cpp