neuralib.scanbox.core.SBXInfo

class neuralib.scanbox.core.SBXInfo[source]

Bases: object

for each recording session, exp.mat from scanbox

__init__(scanbox_version, objective, abort_bit, area_line, ballmotion, bytesPerBuffer, scanmode, config, calibration, channels, messages, opto2pow, otparam, otwave, otwave_um, otwavestyle, postTriggerSamples, power_depth_link, recordsPerBuffer, resfreq, sz, usernotes, volscan, nchan)
Parameters:

  • scanbox_version (str)

  • objective (str)

  • abort_bit (int)

  • area_line (int)

  • ballmotion (np.ndarray)

  • bytesPerBuffer (int)

  • scanmode (int)

  • config (ConfigInfo)

  • calibration (list[CalibrationInfo])

  • channels (int)

  • messages (np.ndarray)

  • opto2pow (np.ndarray)

  • otparam (np.ndarray)

  • otwave (np.ndarray)

  • otwave_um (np.ndarray)

  • otwavestyle (int)

  • postTriggerSamples (int)

  • power_depth_link (int)

  • recordsPerBuffer (int)

  • resfreq (int)

  • sz (np.ndarray)

  • usernotes (np.ndarray)

  • volscan (int)

  • nchan (int | None)

Return type:

None

Methods

__init__(scanbox_version, objective, ...)

asdict()

load(file)

Attributes

fov_distance

(X, Y) in um.

magidx

info.config.magnification, used for CalibrationInfo idx

scanbox_version

objective

abort_bit

area_line

ballmotion

bytesPerBuffer

scanmode

config

calibration

channels

messages

opto2pow

otparam

otwave

otwave_um

otwavestyle

postTriggerSamples

power_depth_link

recordsPerBuffer

resfreq

sz

usernotes

volscan

nchan

scanbox_version: str
objective: str
abort_bit: int
area_line: int
ballmotion: np.ndarray
bytesPerBuffer: int
scanmode: int
config: ConfigInfo
calibration: list[CalibrationInfo]
channels: int
messages: np.ndarray
opto2pow: np.ndarray
otparam: np.ndarray
otwave: np.ndarray
otwave_um: np.ndarray
otwavestyle: int
postTriggerSamples: int
recordsPerBuffer: int
resfreq: int
sz: np.ndarray
usernotes: np.ndarray
volscan: int
nchan: int | None
property magidx: int

info.config.magnification, used for CalibrationInfo idx

asdict()[source]
class CalibrationInfo[source]

Bases: object

attr from calibration

x: float
y: float
gain_resonant_mult: int
uv: list
delta: list
__init__(x, y, gain_resonant_mult, uv=<factory>, delta=<factory>)
Parameters:

  • x (float)

  • y (float)

  • gain_resonant_mult (int)

  • uv (list)

  • delta (list)

Return type:

None

class AgcInfo[source]

Bases: object

attr from info.config.agc

agc_prctile: ndarray
enable: int
threshold: int
__init__(agc_prctile, enable, threshold)
Parameters:

  • agc_prctile (ndarray)

  • enable (int)

  • threshold (int)

Return type:

None

class KnobbyPosInfo[source]

Bases: object

attr from info.config.knobby.pos manipulator coordinates

a: float
x: float
y: float
z: float
__init__(a, x, y, z)
Parameters:

  • a (float)

  • x (float)

  • y (float)

  • z (float)

Return type:

None

class KnobbyInfo[source]

Bases: object

attr from info.config.knobby

pos: KnobbyPosInfo
schedule: ndarray
__init__(pos, schedule)
Parameters:
Return type:

None

class ObjectiveInfo[source]

Bases: object

ObjectiveInfo(name: ‘str’)

name: str
__init__(name)
Parameters:

name (str)

Return type:

None

class ConfigInfo[source]

Bases: object

attr from config

agc: AgcInfo
coord_abs: ndarray
coord_rel: ndarray
frame_times: ndarray
frames: int
host_name: str
knobby: KnobbyInfo
laser_power: float
laser_power_perc: str
lines: int
magnification: int
magnification_list: ndarray
objective: ObjectiveInfo
objective_type: int
pmt0_gain: float
pmt1_gain: float
wavelength: int
__init__(agc, coord_abs, coord_rel, frame_times, frames, host_name, knobby, laser_power, laser_power_perc, lines, magnification, magnification_list, objective, objective_type, pmt0_gain, pmt1_gain, wavelength)
Parameters:

  • agc (AgcInfo)

  • coord_abs (ndarray)

  • coord_rel (ndarray)

  • frame_times (ndarray)

  • frames (int)

  • host_name (str)

  • knobby (KnobbyInfo)

  • laser_power (float)

  • laser_power_perc (str)

  • lines (int)

  • magnification (int)

  • magnification_list (ndarray)

  • objective (ObjectiveInfo)

  • objective_type (int)

  • pmt0_gain (float)

  • pmt1_gain (float)

  • wavelength (int)

Return type:

None

classmethod load(file)[source]
Parameters:

file (str | Path | PathLike[str])

Return type:

SBXInfo

property fov_distance: tuple[float, float]

(X, Y) in um.

Note this value might be hardware dependent. value return is internal usage for the lab

__init__(scanbox_version, objective, abort_bit, area_line, ballmotion, bytesPerBuffer, scanmode, config, calibration, channels, messages, opto2pow, otparam, otwave, otwave_um, otwavestyle, postTriggerSamples, power_depth_link, recordsPerBuffer, resfreq, sz, usernotes, volscan, nchan)
Parameters:

  • scanbox_version (str)

  • objective (str)

  • abort_bit (int)

  • area_line (int)

  • ballmotion (np.ndarray)

  • bytesPerBuffer (int)

  • scanmode (int)

  • config (ConfigInfo)

  • calibration (list[CalibrationInfo])

  • channels (int)

  • messages (np.ndarray)

  • opto2pow (np.ndarray)

  • otparam (np.ndarray)

  • otwave (np.ndarray)

  • otwave_um (np.ndarray)

  • otwavestyle (int)

  • postTriggerSamples (int)

  • power_depth_link (int)

  • recordsPerBuffer (int)

  • resfreq (int)

  • sz (np.ndarray)

  • usernotes (np.ndarray)

  • volscan (int)

  • nchan (int | None)

Return type:

None