io.binary Module

skbeam.io.binary.read_binary(filename, nx, ny, nz, dtype_str, headersize)

docstring, woo!

Parameters

filenameString

The name of the file to open

nxinteger

The number of data elements in the x-direction

nyinteger

The number of data elements in the y-direction

nzinteger

The number of data elements in the z-direction

dtype_strstr

A valid argument for np.dtype(some_str). See read_binary.dsize attribute

headersizeinteger

The size of the file header in bytes

Returns

datandarray

data.shape = (x, y, z) if z > 1 data.shape = (x, y) if z == 1 data.shape = (x,) if y == 1 && z == 1

headerString

header = file.read(headersize)