mcs

load(fname: str, key: str = 'data', data_format: str = 'numpy')

Return numpy array with image data from MCS .h5 file

Parameters:

• fname (str) – h5 file path.

• key (str, optional) – Key name of the stored data. The default is ‘data’.

• data_format (str, optional) – Return the data either as numpy array (‘numpy’) or as h5 file (‘h5’). The default is ‘numpy’.

Returns:

• data (ndarray) – ISM dataset.

• meta (metadata object) – MCS metadata of the dataset.

class metadata(f)

Bases: object

Object containing the metadata read from a mcs data file.

version

Version of the MCS software that generated the h5 file.

Type:

str

comment

User comment

Type:

str

rangex

Field of view along the x-axis (um).

Type:

float

rangey

Field of view along the y-axis (um).

Type:

float

rangez

Field of view along the z-axis (um).

Type:

float

nbin

Number of time bins per pixel.

Type:

int

nbin

Number of time bins per pixel.

Type:

int

dt

Duration of each time bin (us)

Type:

float

nx

Number of pixel along the x-axis.

Type:

int

ny

Number of pixel along the y-axis.

Type:

int

nz

Number of pixel along the z-axis.

Type:

int

nrep

Number of repetitions.

Type:

int

calib_x

calibration value of the x pixel size (um/V).

Type:

float

calib_y

calibration value of the y pixel size (um/V).

Type:

float

calib_z

calibration value of the y pixel size (um/V).

Type:

float

pxdwelltime : float

Returns the pixel dwell time.

frametime : float

Returns the duration of each fram (xy) acquisition.

dx : float

Returns the x pixel size (um).

dy : float

Returns the y pixel size (um).

dz : float

Returns the z pixel size (um).

pxsizes : list

Returns the list of pixel sizes in the z, y, x dimensions (um).

nmicroim : int

<returns total number of microimages read during the measurement.

ndatapoints : int

Returns the total number of words transferred from low level to high level (2 words per microimage).

duration : float

Returns thetotal measurement duration (s).

Print():

Prints all the metadata on screen (name and value).

Print()

property duration

property dx

property dy

property dz

property framerate

property frametime

property ndatapoints

property nmicroim

property pxdwelltime

property pxszizes

metadata_load(fname: str)

It loads the metadata of a mcs h5 file.

Parameters:

fname (str) – h5 file path.

Returns:

meta – MCS metadata of the dataset.

Return type:

metadata object

metadata_print(fname: str)

It prints the metadata of a mcs h5 file.

Parameters:

fname (str) – h5 file path.

Return type:

None.