Technical Application Notes
Click an item to read from the list below.

Technical Application Notes


 

 

Saving Custom Settings on FLIR Machine Vision Cameras

Applicable products

  • Blackfly® S
  • Blackfly®
  • Chameleon®3
  • Flea®3
  • Grasshopper®3
  • Oryx®
10911

Application note description

This application note describes how to save custom image settings onto a FLIR machine vision camera.

Using FLIR machine vision software (whether through a GUI or through working directly with our API), it’s possible to change a variety of settings, such as frame rate, region of interest, pixel format, or gain. The complete list of settings that are stored are found in your camera's Technical Reference manual, available from the downloads page. By default, once a camera has been power-cycled (disconnected from its power source and reconnected), the camera starts up with its factory default settings.

Using the FlyCapture®2 SDK, or the Spinnaker® SDK, it’s possible to save custom settings to the camera so that even after a power-cycle occurs, the camera starts up with the settings that were saved. Each camera is capable of saving up to two custom profiles.

Preparing for use

Before you use your camera, we recommend that you are aware of the following resources available from our downloads page:

  • Getting Started Manual for the camera—provides information on installing components and software needed to run the camera.
  • Technical Reference for the camera—provides information on the camera’s specifications, features and operations, as well as imaging and acquisition controls.
  • Firmware updates—ensure you are using the most up-to-date firmware for the camera to take advantage of improvements and fixes.
  • Tech InsightsSubscribe to our monthly email updates containing information on new knowledge base articles, new firmware and software releases, and Product Change Notices (PCN).

Saving a custom setting

After the cameras have been physically connected, use either the SDK's demo program or write code to save Custom Settings.

Using SpinView

SpinView is the demo program available with the Spinnaker® SDK.

  1. Open SpinView.
  2. Select the camera.
  3. On the Features tab, under the camera model name, make whatever camera settings changes you want to keep (for example, change exposure auto to off).
  4. On the Features tab, under the camera model name, click User Set Control.
  5. Change User Set Selector to User Set 0 (or User Set 1).
  6. Click the Execute button beside User Set Save.
  7. Change User Set Default to User Set 0 (or User Set 1 depending on step 5).

Saving the settings to a user set and changing the default to the same user set ensures the camera starts up with these settings even after a power cycle.

Using FlyCap2

FlyCap2 is the demo program available with the FlyCapture2 SDK.

  1. Open FlyCap2.
  2. Select the camera and click Configure Selected.
  3. Make whatever camera settings you want (for example, in the camera settings tab, uncheck the auto checkbox beside shutter).
  4. Select the Advanced Camera Settings tab.
  5. Change Memory Channel to 1 (or 2).
  6. Click Save.

There is no User Set Default in FlyCap2. Saving to a memory channel ensures the camera starts up with the settings just saved to this memory channel even after a power cycle.

Restoring to factory default settings

Both Spinnaker and FlyCapture2 have a default profile that can’t be overwritten. This keeps the camera’s factory default settings available.

Using SpinView

  1. Open SpinView.
  2. Select the camera.
  3. On the Features tab, under the camera model name, click User Set Control.
  4. Change User Set Selector to Default.
  5. Click the Execute button beside User Set Load.
  6. Change User Set Default to Default.

Loading the default user set means changing the current camera settings back to factory default settings; changing user set default to Default means after a power-cycle, the camera starts up with default settings.

Using FlyCap2

  1. Open FlyCap2.
  2. Select the camera and click Configure Selected.
  3. Select the Advanced Camera Settings tab.
  4. Change Memory Channel to default.
  5. Click Restore.
  6. Click Save.

Clicking restore means changing the current camera settings to Default settings; clicking save means after a power-cycle, the camera starts up with default settings.

Using the API

It’s possible to make modifications to the custom settings within both the Spinnaker and FlyCapture2 API directly, without needing to go through the SpinView or FlyCap2 applications. Links to sample code showcasing this functionality can be found below.

SavetoUserSet.cpp shows how to save custom settings to a user set. It modifies the frame rate value to 10, then saves this change to user set 1. It also shows how to restore to factory default settings.

SavetoMemoryChannel.cpp shows how to save custom settings to a memory channel. It modifies the frame rate value to 10, then saves this change to memory channel 1. It also shows how to restore to factory default settings.

Troubleshooting

When in a situation where the camera seems to be in a bad state, it’s possible to resolve this (without power-cycling the camera) by going back to factory default settings. Follow the Restoring to factory default settings section above for details on how to do this.