slapROI

Documentation for the attributes and methods in the slapROI class used to extract information related to the designated region of interests.

slap2_utils.subclasses.slapROI.slapROI(h5file, roiRef)

A class used to store information related to region of interests.

slap2_utils.subclasses.slapROI.constructor

The constructor of the ROI.

Type:

str

slap2_utils.subclasses.slapROI.roiType

The type of ROI in question (rectangle vs arbitary ROI).

Type:

str

slap2_utils.subclasses.slapROI.imageMode

A string that represent how the ROI is imaged (raster vs integrated).

Type:

str

slap2_utils.subclasses.slapROI.targetRate

The target sample rate that the user inputted (default is 2 kHz).

Type:

int

slap2_utils.subclasses.slapROI.shapeData

A list that represent the shape of the ROI.

Type:

list

slap2_utils.subclasses.slapROI.z

An integer that represent the z layer of the ROI in question.

Type:

int

Descriptions for methods:

__init__() :

Initialize all of the fields with values, which takes an input of h5file (a file that is created after recording) and a reference to the ROI in question.

rtype:

Self with populated fields.