Table of Contents

ConfigureUclaMiniscopeV4

sink Operator

Configures a UCLA Miniscope V4 on the specified port.

The UCLA Miniscope V4 is a miniaturized fluorescent microscope for performing single-photon calcium imaging in freely moving animals. It has the following features:

  • A Python-480 0.48 Megapixel CMOS image sensor.
  • A BNO055 9-axis IMU for real-time, 3D orientation tracking.
  • An electrowetting lens for remote focal plane adjustment.
  • An excitation LED with adjustable brightness control and optional exposure-driven interleaving to reduce photobleaching.

ConfigureUclaMiniscopeV4 Workflow

Inputs & Outputs

Configure all devices in the device group.

This will schedule configuration actions to be applied by a StartAcquisition instance prior to data acquisition.

A sequence of ContextTask instances that hold configuration actions.

right-arrow
representation of a sink operator
right-arrow

The original sequence modified by adding additional configuration actions required to configure all the devices in the device group.

Properties

UclaMiniscopeV4

These are properties of the ConfigureUclaMiniscopeV4 Device Group configuration operator:

Property Type Description
Port PortName

Gets or sets the port.

The port is the physical connection to the ONIX breakout board and must be specified prior to operation.

PortA = 1
PortB = 2
Name string

Gets or sets a unique device group name.

A human-readable identifier that is used as a prefix for the DeviceName of each device in the the group.

Bno055

Bno055 is a ConfigurePolledBno055 device operator contained by the ConfigureUclaMiniscopeV4 operator with the following properties:

Property Type Description
AxisMap Bno055AxisMap

Gets or sets the axis map that will be applied during configuration.

This value can be changed to compensate for the Bno055's mounting orientation. Specifically, this value can be set to rotate the Bno055's coordinate system compared to the default orientation presented on page 24 of the Bno055 datasheet.

XYZ = 36
XZY = 24
YXZ = 33
YZX = 9
ZXY = 18
ZYX = 6
AxisSign Bno055AxisSign

Gets or sets the axis sign that will be applied during configuration.

This value can be changed to compensate for the Bno055's mounting orientation. Specifically, this value can be set to mirror specific axes in the Bno055's coordinate system compared to the default orientation presented on page 24 of the Bno055 datasheet.

Default = 0
MirrorZ = 1
MirrorY = 2
MirrorX = 4
Enable bool

Gets or sets a value specifying whether the Bno055 device is enabled.

If set to true, PolledBno055Data will produce data. If set to false, PolledBno055Data will not produce data.

Camera

Camera is a ConfigureUclaMiniscopeV4Camera device operator contained by the ConfigureUclaMiniscopeV4 operator with the following properties:

Property Type Description
Enable bool

Gets or sets a value indicating whether the camera will produce image data.

If set to true, UclaMiniscopeV4CameraData will produce image data. If set to false, UclaMiniscopeV4CameraData will not produce image data.

Focus double

Gets or sets the focal plane as a percentage up or down around its nominal depth.

The imaging focal plane is controlled by using a Max14574 high-voltage liquid lens driver. This chip produces pulse-width modulated, 5 kHz alternative electric field that deforms a liquid lens in order to change the Miniscope's focal plane. The strength of this field determines the degree of deformation and therefore the focal depth. The default setting of 0% corresponds to approximately mid-range with an excitation voltage of ~47 VRMS. -100% and 100% correspond to the minimum and maximum excitation voltage of ~24.4 and ~69.7 VRMS, respectively.

FrameRate UclaMiniscopeV4FramesPerSecond

Gets or sets the camera video rate in frames per second.

Fps10 = 0
Fps15 = 1
Fps20 = 2
Fps25 = 3
Fps30 = 4
[Browsable(false)] Fps10Hz = 5
[Browsable(false)] Fps15Hz = 6
[Browsable(false)] Fps20Hz = 7
[Browsable(false)] Fps25Hz = 8
[Browsable(false)] Fps30Hz = 9
InterleaveLed bool

Gets or sets a value indicating whether the excitation LED should turn on only when the camera shutter is open.

If set to true, the excitation LED will turn on briefly before, and turn off briefly after, the camera begins photon collection on its photodiode array. If set to false, the excitation LED will remain on at all times.

LedBrightness double

Gets or sets the excitation LED brightness level (0-100%).

SensorGain UclaMiniscopeV4SensorGain

Gets or sets the camera sensor's analog gain.

Low = 225
Medium = 228
High = 36

PortVoltage

PortVoltage is a AutoPortVoltage device operator contained by the ConfigureUclaMiniscopeV4 operator with the following properties:

Property Type Description
Applied double?

Gets or sets the last applied port voltage

Requested double?

Gets or sets a value the requested port voltage. If null, the voltage will be set automatically.