User Sets#

The User Sets camera feature allows you to save or load camera settings. You can also specify which settings will be loaded at camera startup.

A user set (also called "configuration set") is a group of parameter values. It contains all parameter settings needed to control the camera, with a few exceptions.

Some user sets are preset and read-only. These user sets are also called "factory sets".

Using the Feature#

What's in a User Set?#

Each user set includes the values of all camera parameters, with the following exceptions:

• Parameter values related to the following camera features are not included:

  • Action Commands
  • Sequencer
  • User-Defined Values
  • Precision Time Protocol

• On ace Classic/U/L cameras, parameter values related to the LUT camera feature are also not included.

• Values of parameters that include the term "Selector" in their names are not included (e.g., GainSelector). Exceptions: TestImageSelector, GammaSelector, BslLightSourcePreset.
• The value of the DeviceUserID parameter is not included.

• The value of the GevGVSPExtendedIDMode parameter is not included.

• Only the following Network-Related Parameters are included:

  • Packet Size (GevSCPSPacketSize)
  • Inter-Packet Delay (GevSCPD)
  • Frame Transmission Delay (GevSCFTD)
  • Bandwidth Reserve (GevSCBWR)
  • Bandwidth Reserve Accumulation (GevSCBWRA)
  • Bandwidth Reserve Mode (BandwidthReserveMode)

This means that when you load or save a user set, the values of all camera parameters will be loaded or saved, except the parameters listed above.

Loading a User Set#

1. Set the UserSetSelector parameter to one of the available user sets, e.g., UserSet1.
2. Execute the UserSetLoad command.

Saving a User Set#

1. Set the UserSetSelector parameter to one of the available user sets, e.g., UserSet1.
2. Execute the UserSetSave command.

Choosing a Startup Set#

1. Set the UserSetDefault parameter to one of the available user sets, e.g., UserSet1.
2. Power-cycle the camera for the new startup set to become effective.

Available User Sets#

Depending on your camera model, the following user sets are available:

Default#

The Default user set is a read-only factory set. This is the default startup set on all cameras, except Basler MED ace cameras.

Loading this set configures the camera to provide good camera performance for a variety of applications under average operating conditions.

The Default user set contains the factory default settings of all the camera's parameter values.

High Gain#

The HighGain user set is a read-only factory set.

Loading this set increases the gain by 6 dB.

The HighGain user set contains the same parameter values as the Default user set, with the following exception:

• If available, the Gain parameter is set to a value that increases the gain by 6 dB compared to the Default user set. The actual parameter value varies by camera model.

Auto Functions#

The AutoFunctions user set is a read-only factory set.

Loading this user set enables the camera's Exposure Auto and Gain Auto auto functions.

The AutoFunctions user set contains the same parameter values as the Default user set, with the following exceptions:

• The GainAuto parameter is set to Continuous.
• The ExposureAuto parameter is set to Continuous.
• The AutoFunctionProfile parameter is set to MinimizeGain.

Color#

The Color user set is a read-only factory set.

Loading this user set configures the camera to produce good color images under the most common lighting conditions.

The Color user set contains the same parameter values as the Default user set, with the following exceptions:

• The BslLightSourcePreset parameter is set to Daylight5000K.
• The BalanceRatio parameter values are set according to the Daylight5000K light source preset.
• If available, the GammaSelector parameter is set to sRGB.
• If available, the ProcessedRawEnable parameter is set to true.

Color Raw#

The ColorRaw user set is a read-only factory set.

Loading this set disables the color enhancement features.

The ColorRaw user set contains the same parameter values as the Default user set, with the following exceptions:

• The BslLightSourcePreset parameter is set to Off.
• The BalanceRatio parameter values for all color channels (red, green, blue) are set to 1.
• If available, the BslColorAdjustmentEnable parameter is set to false.
• If available, the GammaEnable parameter is set to false.
• If available, the GammaSelector parameter is set to User.

Light Microscopy#

The LightMicroscopy user set is a read-only factory set. This is the default startup set on Basler MED ace cameras.

Loading this set configures the camera to produce good images with light microscopes.

The LightMicroscopy user set contains the same parameter values as the Default user set, with the following exceptions:

• The ExposureAuto parameter is set to Continuous.
• The AutoFunctionProfile parameter is set to MinimizeGainQuick.
• The AutoTargetBrightness parameter is set to 0.592.
• The AutoFunctionROIUseTonalRange parameter is set to true.
• The BslBrightness parameter is set to -0.0625.
• The BslContrast parameter is set to 0.15625.
• The BslSharpnessEnhancement parameter is set to the following value:
  • acA2440-35umMED and acA2440-75umMED cameras: 1.7
  • acA2500-20gmMED cameras: 2.2
  • All other Basler MED ace cameras: 3.7
• On color cameras, the BslLightSourcePreset parameter is set to Daylight6500K.
• On color cameras, the PixelFormat parameter is set to RGB8.
• On color cameras, the DemosaicingMode parameter is set to BaslerPGI.
• On mono cameras, the PgiMode parameter is set to On.

User Set 1, User Set 2, and User Set 3#

You can use the UserSet1, UserSet2, and UserSet3 user sets to load and save your own camera settings.

Initially, these user sets contain the same parameter values as the Default user set. You can overwrite those values with your own settings to create a user set that is customized for your application.

To restore those settings every time the camera is reset, choose a user set as the startup set.

Specifics#

Show all camera models

Sample Code#

ace Classic/U/L GigE Cameras#

// Load the High Gain user set
camera.UserSetSelector.SetValue(UserSetSelector_HighGain);
camera.UserSetLoad.Execute();
// Load the User Set 1 user set
camera.UserSetSelector.SetValue(UserSetSelector_UserSet1);
camera.UserSetLoad.Execute();
// Adjust some camera settings
camera.Width.SetValue(600);
camera.Height.SetValue(400);
camera.ExposureTime.SetValue(3500.0);
// Save the settings in User Set 1
camera.UserSetSelector.SetValue(UserSetSelector_UserSet1);
camera.UserSetSave.Execute();
// Designate User Set 1 as the startup set
camera.UserSetDefaultSelector.SetValue(UserSetDefaultSelector_UserSet1);

INodeMap& nodemap = camera.GetNodeMap();
// Load the High Gain user set
CEnumParameter(nodemap, "UserSetSelector").SetValue("HighGain");
CCommandParameter(nodemap, "UserSetLoad").Execute();
// Load the User Set 1 user set
CEnumParameter(nodemap, "UserSetSelector").SetValue("UserSet1");
CCommandParameter(nodemap, "UserSetLoad").Execute();
// Adjust some camera settings
CIntegerParameter(nodemap, "Width").SetValue(600);
CIntegerParameter(nodemap, "Height").SetValue(400);
CFloatParameter(nodemap, "ExposureTime").SetValue(3500.0);
// Save the settings in User Set 1
CEnumParameter(nodemap, "UserSetSelector").SetValue("UserSet1");
CCommandParameter(nodemap, "UserSetSave").Execute();
// Designate User Set 1 as the startup set
CEnumParameter(nodemap, "UserSetDefaultSelector").SetValue("UserSet1");

// Load the High Gain user set
camera.Parameters[PLCamera.UserSetSelector].SetValue(PLCamera.UserSetSelector.HighGain);
camera.Parameters[PLCamera.UserSetLoad].Execute();
// Load the User Set 1 user set
camera.Parameters[PLCamera.UserSetSelector].SetValue(PLCamera.UserSetSelector.UserSet1);
camera.Parameters[PLCamera.UserSetLoad].Execute();
// Adjust some camera settings
camera.Parameters[PLCamera.Width].SetValue(600);
camera.Parameters[PLCamera.Height].SetValue(400);
camera.Parameters[PLCamera.ExposureTime].SetValue(3500.0);
// Save the settings in User Set 1
camera.Parameters[PLCamera.UserSetSelector].SetValue(PLCamera.UserSetSelector.UserSet1);
camera.Parameters[PLCamera.UserSetSave].Execute();
// Designate User Set 1 as the startup set
camera.Parameters[PLCamera.UserSetDefaultSelector].SetValue(PLCamera.UserSetDefaultSelector.UserSet1);

/* Macro to check for errors */
#define CHECK(errc) if (GENAPI_E_OK != errc) printErrorAndExit(errc)
GENAPIC_RESULT errRes = GENAPI_E_OK;  /* Return value of pylon methods */
/* Load the High Gain user set */
errRes = PylonDeviceFeatureFromString(hdev, "UserSetSelector", "HighGain");
CHECK(errRes);
errRes = PylonDeviceExecuteCommandFeature(hdev, "UserSetLoad");
CHECK(errRes);
/* Load the User Set 1 user set */
errRes = PylonDeviceFeatureFromString(hdev, "UserSetSelector", "UserSet1");
CHECK(errRes);
errRes = PylonDeviceExecuteCommandFeature(hdev, "UserSetLoad");
CHECK(errRes);
/* Adjust some camera settings */
errRes = PylonDeviceSetIntegerFeature(hdev, "Width", 600);
CHECK(errRes);
errRes = PylonDeviceSetIntegerFeature(hdev, "Height", 400);
CHECK(errRes);
errRes = PylonDeviceSetFloatFeature(hdev, "ExposureTime", 3500.0);
CHECK(errRes);
/* Save the settings in User Set 1 */
errRes = PylonDeviceFeatureFromString(hdev, "UserSetSelector", "UserSet1");
CHECK(errRes);
errRes = PylonDeviceExecuteCommandFeature(hdev, "UserSetSave");
CHECK(errRes);
/* Designate User Set 1 as the startup set */
errRes = PylonDeviceFeatureFromString(hdev, "UserSetDefaultSelector", "UserSet1");
CHECK(errRes);

# Load the High Gain user set
camera.UserSetSelector.Value = "HighGain"
camera.UserSetLoad.Execute()
# Load the User Set 1 user set
camera.UserSetSelector.Value = "UserSet1"
camera.UserSetLoad.Execute()
# Adjust some camera settings
camera.Width.Value = 600
camera.Height.Value = 400
camera.ExposureTime.Value = 3500.0
# Save the settings in User Set 1
camera.UserSetSelector.Value = "UserSet1"
camera.UserSetSave.Execute()
# Designate User Set 1 as the startup set
camera.UserSetDefaultSelector.Value = "UserSet1"

Other Cameras#

// Load the High Gain user set
camera.UserSetSelector.SetValue(UserSetSelector_HighGain);
camera.UserSetLoad.Execute();
// Load the User Set 1 user set
camera.UserSetSelector.SetValue(UserSetSelector_UserSet1);
camera.UserSetLoad.Execute();
// Adjust some camera settings
camera.Width.SetValue(600);
camera.Height.SetValue(400);
camera.ExposureTime.SetValue(3500.0);
// Save the settings in User Set 1
camera.UserSetSelector.SetValue(UserSetSelector_UserSet1);
camera.UserSetSave.Execute();
// Designate User Set 1 as the startup set
camera.UserSetDefault.SetValue(UserSetDefault_UserSet1);

INodeMap& nodemap = camera.GetNodeMap();
// Load the High Gain user set
CEnumParameter(nodemap, "UserSetSelector").SetValue("HighGain");
CCommandParameter(nodemap, "UserSetLoad").Execute();
// Load the User Set 1 user set
CEnumParameter(nodemap, "UserSetSelector").SetValue("UserSet1");
CCommandParameter(nodemap, "UserSetLoad").Execute();
// Adjust some camera settings
CIntegerParameter(nodemap, "Width").SetValue(600);
CIntegerParameter(nodemap, "Height").SetValue(400);
CFloatParameter(nodemap, "ExposureTime").SetValue(3500.0);
// Save the settings in User Set 1
CEnumParameter(nodemap, "UserSetSelector").SetValue("UserSet1");
CCommandParameter(nodemap, "UserSetSave").Execute();
// Designate User Set 1 as the startup set
CEnumParameter(nodemap, "UserSetDefault").SetValue("UserSet1");

// Load the High Gain user set
camera.Parameters[PLCamera.UserSetSelector].SetValue(PLCamera.UserSetSelector.HighGain);
camera.Parameters[PLCamera.UserSetLoad].Execute();
// Load the User Set 1 user set
camera.Parameters[PLCamera.UserSetSelector].SetValue(PLCamera.UserSetSelector.UserSet1);
camera.Parameters[PLCamera.UserSetLoad].Execute();
// Adjust some camera settings
camera.Parameters[PLCamera.Width].SetValue(600);
camera.Parameters[PLCamera.Height].SetValue(400);
camera.Parameters[PLCamera.ExposureTime].SetValue(3500.0);
// Save the settings in User Set 1
camera.Parameters[PLCamera.UserSetSelector].SetValue(PLCamera.UserSetSelector.UserSet1);
camera.Parameters[PLCamera.UserSetSave].Execute();
// Designate User Set 1 as the startup set
camera.Parameters[PLCamera.UserSetDefault].SetValue(PLCamera.UserSetDefault.UserSet1);

/* Macro to check for errors */
#define CHECK(errc) if (GENAPI_E_OK != errc) printErrorAndExit(errc)
GENAPIC_RESULT errRes = GENAPI_E_OK;  /* Return value of pylon methods */
/* Load the High Gain user set */
errRes = PylonDeviceFeatureFromString(hdev, "UserSetSelector", "HighGain");
CHECK(errRes);
errRes = PylonDeviceExecuteCommandFeature(hdev, "UserSetLoad");
CHECK(errRes);
/* Load the User Set 1 user set */
errRes = PylonDeviceFeatureFromString(hdev, "UserSetSelector", "UserSet1");
CHECK(errRes);
errRes = PylonDeviceExecuteCommandFeature(hdev, "UserSetLoad");
CHECK(errRes);
/* Adjust some camera settings */
errRes = PylonDeviceSetIntegerFeature(hdev, "Width", 600);
CHECK(errRes);
errRes = PylonDeviceSetIntegerFeature(hdev, "Height", 400);
CHECK(errRes);
errRes = PylonDeviceSetFloatFeature(hdev, "ExposureTime", 3500.0);
CHECK(errRes);
/* Save the settings in User Set 1 */
errRes = PylonDeviceFeatureFromString(hdev, "UserSetSelector", "UserSet1");
CHECK(errRes);
errRes = PylonDeviceExecuteCommandFeature(hdev, "UserSetSave");
CHECK(errRes);
/* Designate User Set 1 as the startup set */
errRes = PylonDeviceFeatureFromString(hdev, "UserSetDefault", "UserSet1");
CHECK(errRes);

# Load the High Gain user set
camera.UserSetSelector.Value = "HighGain"
camera.UserSetLoad.Execute()
# Load the User Set 1 user set
camera.UserSetSelector.Value = "UserSet1"
camera.UserSetLoad.Execute()
# Adjust some camera settings
camera.Width.Value = 600
camera.Height.Value = 400
camera.ExposureTime.Value = 3500.0
# Save the settings in User Set 1
camera.UserSetSelector.Value = "UserSet1"
camera.UserSetSave.Execute()
# Designate User Set 1 as the startup set
camera.UserSetDefault.Value = "UserSet1"

You can also use the pylon Viewer to easily set the parameters.