kStatus kLight_SetPrimingMode	(	kLight	light,
		kLightPrimingMode	mode
	)

Sets the light priming mode.

Some light devices rely on stored charge to provide a near-instantaneous response when the physical light exposure signal is asserted. Unfortunately, this charge can dissipate when the light is not in use. Light priming can be used to combat this effect, improving the consistency of illumination during nominal exposure time.

Three priming modes are supported. The kLIGHT_PRIMING_MODE_ALWAYS mode uses a lead-in offset to allocate time for light priming in every DEG (Delay, Exposure, Gap) cycle. This mode can reduce maximum frame rates for exposure-limited configurations but will produce uniform exposures even with sparse event triggers (e.g., continuous encoder-based triggering or software triggering, where there may be gaps of arbitrary duration between exposures). Note that if light timing is coupled to camera timing (kLIGHT_CONTROL_COUPLED_TO_CAMERA) this setting will only be honored if the light coupling mode is set to one of kLIGHT_COUPLING_MODE_LEAD_IN or kLIGHT_COUPLING_MODE_FULL. This is the recommended mode for new applications and may become the default in a future FireSync platform version.

In contrast, the kLIGHT_PRIMING_MODE_ONCE mode performs light priming during acquisition startup. This will typically result in a brief light exposure before the start of scanning. This mode is suitable for continuous time-based event triggering, where a steady sequence of triggers is guaranteed after acquisition startup (effectively, keeping the light primed). Use of this mode does not impact frame rates.

Finally, the kLIGHT_PRIMING_MODE_NONE mode disables light priming. This is the default behavior, for compatibility with older clients. However, it is recommended to use one of the two priming modes described above in newer applications.

This option is not configurable for DM647 (M2, M50) controllers.

Parameters

light	Light object.
mode	Light priming mode.

Returns

Operation status.