MetaData

Documentation for the attributes and methods in the MetaData class used to extract traces from the binary file.

slap2_utils.subclasses.metadata.MetaData(metadatafile)

A class used to load a SLAP2 binary metadatafile for data processing. This is also an attribute for the datafile object

slap2_utils.subclasses.metadata.metadatafile

The name of the metadata file.

Type:: str

slap2_utils.subclasses.metadata.AcquisitionContainer

An instance of the AcquisitionContainer class that contain information related to the acquisition.

Type:: AcquisitionContainer

slap2_utils.subclasses.metadata.acqDurationCycles

A list containing 2 int values for cycle duration

Type:: list

slap2_utils.subclasses.metadata.acqDuration_s

The total time (in seconds) for the whole acquisition.

Type:: int

slap2_utils.subclasses.metadata.acquisitionPathIdx

The number that represent the path that the acquisitiion take place (either 1 or 2).

Type:: int

slap2_utils.subclasses.metadata.acquisitionPathName

The string that reiterate which path the acquisition takes place (either ‘path 1’ or ‘path 2’) .

Type:: str

slap2_utils.subclasses.metadata.aomActive

Binary number that reporesent whether aom is action (0 = false, 1 = yes).

Type:: int

slap2_utils.subclasses.metadata.aomVoltage

The number of voltage in aom (in float).

Type:: float

slap2_utils.subclasses.metadata.channelsSave

The number that represent which channel saved the data.

Type:: int

slap2_utils.subclasses.metadata.dmdPixelsPerColumn

The number of pixel along the column of the dmd.

Type:: int

slap2_utils.subclasses.metadata.dmdPixelsPerRow

The number of pixel along the row of the dmd.

Type:: int

slap2_utils.subclasses.metadata.enableStack

Binary number that reporesent whether stack is enabled (0 = false, 1 = yes).

Type:: list

slap2_utils.subclasses.metadata.linePeriod_s

The time it takes to conduct 1 slice (1/linePeriod_s gives the line rate for the microscope).

Type:: float

slap2_utils.subclasses.metadata.remoteFocusPosition_um

A number that represent the remoteFocusPosition for the center of the stack.

Type:: int

slap2_utils.subclasses.metadata.samplesPerLine

The line rate for the microscope (1/samplesPerLine gives the linePeriod_s).

Type:: int

Descriptions for methods:

__init__() :: Fill the fields mentioned above. The method also loads the AcquisitionContainer using the __init__() method for the AcquisitionContainer

rtype:: Self with populated fields.