Class Spinnaker::Camera¶
ClassList > Spinnaker > Camera
The camera object class.
#include <Camera.h>
Inherits the following classes: Spinnaker::CameraBase
Public Attributes¶
Public Attributes inherited from Spinnaker::ICameraBase¶
| Type | Name |
|---|---|
| TransportLayerDevice | TLDevice |
| TransportLayerStream | TLStream |
Public Functions¶
| Type | Name |
|---|---|
| virtual void | Init () |
| ~Camera () |
Public Functions inherited from Spinnaker::CameraBase¶
| Type | Name |
|---|---|
| virtual void | BeginAcquisition () |
| virtual void | DeInit () |
| virtual unsigned int | DiscoverMaxPacketSize () |
| virtual void | EndAcquisition () |
| virtual void | ForceIP () |
| virtual GenApi::EAccessMode | GetAccessMode () const |
| virtual unsigned int | GetActiveNumDataStreams () |
| virtual BufferOwnership | GetBufferOwnership () const |
| virtual GenICam::gcstring | GetDeviceID () |
| GenICam::gcstring | GetDeviceSerialNumber () |
| virtual GenICam::gcstring | GetGuiXml () const |
| virtual ImagePtr | GetNextImage (uint64_t grabTimeout=EVENT_TIMEOUT_INFINITE, uint64_t streamIndex=0) |
| virtual ImageList | GetNextImageSync (uint64_t grabTimeout=EVENT_TIMEOUT_INFINITE) |
| virtual GenApi::INodeMap & | GetNodeMap () const |
| virtual unsigned int | GetNumDataStreams () |
| virtual unsigned int | GetNumImagesInUse () |
| virtual ProducerPtr | GetProducer () const |
| virtual GenApi::INodeMap & | GetTLDeviceNodeMap () const |
| virtual GenApi::INodeMap & | GetTLStreamNodeMap (uint64_t streamIndex=0) const |
| virtual GenICam::gcstring | GetUniqueID () |
| virtual uint64_t | GetUserBufferCount () const |
| virtual uint64_t | GetUserBufferSize () const |
| virtual uint64_t | GetUserBufferTotalSize () const |
| virtual void | Init () |
| virtual bool | IsInitialized () |
| virtual bool | IsStreaming () const |
| virtual bool | IsValid () |
| virtual void | ReadPort (uint64_t iAddress, void * pBuffer, size_t iSize) |
| virtual void | RegisterEventHandler (EventHandler & evtHandlerToRegister) |
| virtual void | RegisterEventHandler (DeviceEventHandler & evtHandlerToRegister, const GenICam::gcstring & eventName) |
| virtual void | RegisterEventHandler (ImageEventHandler & evtHandlerToRegister, uint64_t streamIndex) |
| virtual void | SetBufferOwnership (const BufferOwnership mode) |
| virtual void | SetUserBuffers (void *const pMemBuffers, uint64_t totalSize) |
| virtual void | SetUserBuffers (void **const ppMemBuffers, const uint64_t bufferCount, const uint64_t bufferSize) |
| virtual void | UnregisterAllLoggingEventHandlers () |
| virtual void | UnregisterEventHandler (EventHandler & evtHandlerToUnregister) |
| virtual void | WritePort (uint64_t iAddress, const void * pBuffer, size_t iSize) |
| virtual | ~CameraBase (void) |
Public Functions inherited from Spinnaker::ICameraBase¶
| Type | Name |
|---|---|
| virtual void | BeginAcquisition () = 0 |
| virtual void | DeInit () = 0 |
| virtual unsigned int | DiscoverMaxPacketSize () = 0 |
| virtual void | EndAcquisition () = 0 |
| virtual void | ForceIP () = 0 |
| virtual GenApi::EAccessMode | GetAccessMode () const = 0 |
| virtual unsigned int | GetActiveNumDataStreams () = 0 |
| virtual BufferOwnership | GetBufferOwnership () const = 0 |
| virtual GenICam::gcstring | GetDeviceID () = 0 |
| virtual GenICam::gcstring | GetGuiXml () const = 0 |
| virtual ImagePtr | GetNextImage (uint64_t grabTimeout=EVENT_TIMEOUT_INFINITE, uint64_t streamIndex=0) = 0 |
| virtual ImageList | GetNextImageSync (uint64_t grabTimeout=EVENT_TIMEOUT_INFINITE) = 0 |
| virtual GenApi::INodeMap & | GetNodeMap () const = 0 |
| virtual unsigned int | GetNumDataStreams () = 0 |
| virtual unsigned int | GetNumImagesInUse () = 0 |
| virtual ProducerPtr | GetProducer () const = 0 |
| virtual GenApi::INodeMap & | GetTLDeviceNodeMap () const = 0 |
| virtual GenApi::INodeMap & | GetTLStreamNodeMap (uint64_t streamIndex) const = 0 |
| virtual GenICam::gcstring | GetUniqueID () = 0 |
| virtual uint64_t | GetUserBufferCount () const = 0 |
| virtual uint64_t | GetUserBufferSize () const = 0 |
| virtual uint64_t | GetUserBufferTotalSize () const = 0 |
| virtual void | Init () = 0 |
| virtual bool | IsInitialized () = 0 |
| virtual bool | IsStreaming () const = 0 |
| virtual bool | IsValid () = 0 |
| virtual void | ReadPort (uint64_t iAddress, void * pBuffer, size_t iSize) = 0 |
| virtual void | RegisterEventHandler (EventHandler & evtHandlerToRegister) = 0 |
| virtual void | RegisterEventHandler (DeviceEventHandler & evtHandlerToRegister, const GenICam::gcstring & eventName) = 0 |
| virtual void | RegisterEventHandler (ImageEventHandler & evtHandlerToRegister, uint64_t streamIndex) = 0 |
| virtual void | SetBufferOwnership (const BufferOwnership mode) = 0 |
| virtual void | SetUserBuffers (void *const pMemBuffers, uint64_t totalSize) = 0 |
| virtual void | SetUserBuffers (void **const ppMemBuffers, const uint64_t bufferCount, const uint64_t bufferSize) = 0 |
| virtual void | UnregisterAllLoggingEventHandlers () = 0 |
| virtual void | UnregisterEventHandler (EventHandler & evtHandlerToUnregister) = 0 |
| virtual void | WritePort (uint64_t iAddress, const void * pBuffer, size_t iSize) = 0 |
| virtual | ~ICameraBase (void) |
Protected Attributes inherited from Spinnaker::ICameraBase¶
| Type | Name |
|---|---|
| CameraBaseData * | m_pCameraBaseData |
Protected Functions¶
| Type | Name |
|---|---|
| Camera () |
Protected Functions inherited from Spinnaker::CameraBase¶
| Type | Name |
|---|---|
| CameraBase (void) |
|
| CameraBase (const CameraBase &) |
|
| CameraBase & | operator= (const CameraBase &) |
Protected Functions inherited from Spinnaker::ICameraBase¶
| Type | Name |
|---|---|
| ICameraBase () |
|
| ICameraBase (const ICameraBase &) |
|
| ICameraBase & | operator= (const ICameraBase &) |
Public Attributes Documentation¶
variable AasRoiEnable¶
Description: Controls whether a user-specified ROI is used for auto algorithm that is currently selected by the AutoAlgorithmSelector feature. Visibility:
variable AasRoiHeight¶
Description: Controls the width of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature. Visibility:
variable AasRoiOffsetX¶
Description: Controls the x-offset of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature. Visibility:
variable AasRoiOffsetY¶
Description: Controls the y-offset of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature. Visibility:
variable AasRoiWidth¶
Description: Controls the width of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature. Visibility:
variable AcquisitionAbort¶
Description: Aborts the Acquisition immediately. This will end the capture without completing the current Frame or waiting on a trigger. If no Acquisition is in progress, the command is ignored. Visibility: Expert
variable AcquisitionArm¶
Description: Arms the device before an AcquisitionStart command. This optional command validates all the current features for consistency and prepares the device for a fast start of the Acquisition. Visibility: Expert
variable AcquisitionBurstFrameCount¶
Description: This feature is used only if the FrameBurstStart trigger is enabled and the FrameBurstEnd trigger is disabled. Note that the total number of frames captured is also conditioned by AcquisitionFrameCount if AcquisitionMode is MultiFrame and ignored if AcquisitionMode is Single. Visibility:
variable AcquisitionFrameCount¶
Description: Number of images to acquire during a multi frame acquisition. Visibility:
variable AcquisitionFramePeriod¶
Description: Controls the acquisition rate (in 1us steps) at which the frames are captured. Visibility: Beginner
variable AcquisitionFramePeriodRaw¶
Description: Controls the acquisition rate (in 1us steps) at which the frames are captured. Visibility: Invisible
variable AcquisitionFrameRate¶
Description: User controlled acquisition frame rate in Hertz Visibility:
variable AcquisitionFrameRateEnable¶
Description: If enabled, AcquisitionFrameRate can be used to manually control the frame rate. Visibility:
variable AcquisitionFrameRatePersistence¶
Description: If enabled, the camera will try to preserve the frame rate to what is entered when changed by other features. Visibility:
variable AcquisitionLineRate¶
Description: Controls the rate (in Hertz) at which the Lines in a Frame are captured. Visibility:
variable AcquisitionMaxFrameRate¶
Description: Sets the camera to the maximum frame rate, with respect to the given settings Visibility: Beginner
variable AcquisitionMode¶
Description: Sets the acquisition mode of the device. Continuous: acquires images continuously. Multi Frame: acquires a specified number of images before stopping acquisition. Single Frame: acquires 1 image before stopping acquisition. Visibility:
variable AcquisitionModeAddress¶
Description: The address in the manufacturer-specific register space of the feature with the corresponding name. Visibility: Guru
variable AcquisitionResultingFrameRate¶
Description: Resulting frame rate in Hertz. If this does not equal the Acquisition Frame Rate it is because the Exposure Time is greater than the frame time. Visibility:
variable AcquisitionStart¶
Description: This command starts the acquisition of images. Visibility:
variable AcquisitionStartAddress¶
Description: The address in the manufacturer-specific register space of the feature with the corresponding name. Visibility: Guru
variable AcquisitionStatus¶
Description: Reads the state of the internal acquisition signal selected using AcquisitionStatusSelector. Visibility: Expert
variable AcquisitionStatusSelector¶
GenApi::IEnumerationT<AcquisitionStatusSelectorEnums>& Spinnaker::Camera::AcquisitionStatusSelector;
Description: Selects the internal acquisition signal to read using AcquisitionStatus. Visibility: Expert
variable AcquisitionStop¶
Description: This command stops the acquisition of images. Visibility:
variable AcquisitionStopAddress¶
Description: The address in the manufacturer-specific register space of the feature with the corresponding name. Visibility: Guru
variable AcquisitionTransferFrameRate¶
Description: Transfer frame rate in Hertz. If this does not equal the Acquisition Frame Rate it is because the Exposure Time is greater than the frame time. Visibility:
variable ActionDeviceKey¶
Description: Provides the device key that allows the device to check the validity of action commands. The device internal assertion of an action signal is only authorized if the ActionDeviceKey and the action device key value in the protocol message are equal. Visibility:
variable ActionGroupKey¶
Description: Provides the key that the device will use to validate the action on reception of the action protocol message. Visibility:
variable ActionGroupMask¶
Description: Provides the mask that the device will use to validate the action on reception of the action protocol message. Visibility:
variable ActionQueueEmpty¶
Description: Removes all action commands in the queue. Visibility:
variable ActionQueueSize¶
Description: Indicates the size of the scheduled action commands queue. This number represents the maximum number of scheduled action commands that can be pending at a given point in time. Visibility:
variable ActionSelector¶
Description: Selects to which Action Signal further Action settings apply. Visibility:
variable ActionSignalSize¶
Description: Indicates the number of seperate action commands supported by this device. Visibility:
variable ActionUnconditionalMode¶
Description: Enables the unconditional action command mode where action commands are processed even when the primary control channel is closed. Visibility:
variable AdaptiveCompressionEnable¶
Description: If selected, allows dynamic updates to the compression tables to achieve better compression ratio. If deselected, a fixed encoding table is used. Visibility:
variable AdcBitDepth¶
Description: Selects which ADC bit depth to use. A higher ADC bit depth results in better image quality but slower maximum frame rate. Visibility:
variable AdvancedParameter¶
Description: Visibility: Guru
variable AdvancedParameterSave¶
Description: Visibility: Guru
variable AdvancedParameterSelector¶
Description: Visibility: Guru
variable AutoAlgorithmSelector¶
Description: Selects which Auto Algorithm is controlled by the RoiEnable, OffsetX, OffsetY, Width, Height features. Visibility:
variable AutoExposureControlLoopDamping¶
Description: It controls how fast the exposure and gain get settled. If the value is too small, it may cause the system to be unstable. Range is from 0.0 to 1.0. Default = 0.2. Visibility:
variable AutoExposureControlPriority¶
GenApi::IEnumerationT<AutoExposureControlPriorityEnums>& Spinnaker::Camera::AutoExposureControlPriority;
Description: Selects whether to adjust gain or exposure first. When gain priority is selected, the camera fixes the gain to 0 dB, and the exposure is adjusted according to the target grey level. If the maximum exposure is reached before the target grey level is hit, the gain starts to change to meet the target. This mode is used to have the minimum noise. When exposure priority is selected, the camera sets the exposure to a small value (default is 5 ms). The gain is adjusted according to the target grey level. If maximum gain is reached before the target grey level is hit, the exposure starts to change to meet the target. This mode is used to capture fast motion. Visibility:
variable AutoExposureEVCompensation¶
Description: The EV compensation value used in the exposure compensation. This allows you to adjust the resultant image intensity with one control. A positive value makes the image brighter. A negative value makes the image darker. Range from -3 to 3 with a step of 1/3. Default = 0. Visibility:
variable AutoExposureExposureTimeLowerLimit¶
Description: The smallest exposure time that auto exposure can set. Visibility:
variable AutoExposureExposureTimeUpperLimit¶
Description: The largest exposure time that auto exposure can set. Visibility:
variable AutoExposureGainLowerLimit¶
Description: The smallest gain that auto exposure can set. Visibility:
variable AutoExposureGainUpperLimit¶
Description: The largest gain that auto exposure can set. Visibility:
variable AutoExposureGreyValueLowerLimit¶
Description: The lowest value in percentage that the target mean may reach. Visibility:
variable AutoExposureGreyValueUpperLimit¶
Description: The highest value in percentage that the target mean may reach. Visibility:
variable AutoExposureLightingMode¶
Description: Selects a lighting mode: Backlight, Frontlight or Normal (default). a. Backlight compensation: used when a strong light is coming from the back of the object. b. Frontlight compensation: used when a strong light is shining in the front of the object while the background is dark. c. Normal lighting: used when the object is not under backlight or frontlight conditions. When normal lighting is selected, metering modes are available. Visibility:
variable AutoExposureMeteringMode¶
Description: Selects a metering mode: average, spot, or partial metering. a. Average: Measures the light from the entire scene uniformly to determine the final exposure value. Every portion of the exposed area has the same contribution. b. Spot: Measures a small area (about 3%) in the center of the scene while the rest of the scene is ignored. This mode is used when the scene has a high contrast and the object of interest is relatively small. c. Partial: Measures the light from a larger area (about 11%) in the center of the scene. This mode is used when very dark or bright regions appear at the edge of the frame. Note: Metering mode is available only when Lighting Mode Selector is Normal. Visibility:
variable AutoExposureTargetGreyValue¶
Description: This is the user-specified target grey level (image mean) to apply to the current image. Note that the target grey level is in the linear domain before gamma correction is applied. Visibility:
variable AutoExposureTargetGreyValueAuto¶
GenApi::IEnumerationT<AutoExposureTargetGreyValueAutoEnums>& Spinnaker::Camera::AutoExposureTargetGreyValueAuto;
Description: This indicates whether the target image grey level is automatically set by the camera or manually set by the user. Note that the target grey level is in the linear domain before gamma correction is applied. Visibility:
variable BalanceRatio¶
Description: Controls the balance ratio of the selected color relative to green. Used for white balancing. Visibility:
variable BalanceRatioSelector¶
Description: Selects a balance ratio to configure once a balance ratio control has been selected. Visibility:
variable BalanceWhiteAuto¶
Description: White Balance compensates for color shifts caused by different lighting conditions. It can be automatically or manually controlled. For manual control, set to Off. For automatic control, set to Once or Continuous. Visibility:
variable BalanceWhiteAutoDamping¶
Description: Controls how quickly 'BalanceWhiteAuto' adjusts the values for Red and Blue BalanceRatio in response to changing conditions. Higher damping means the changes are more gradual. Visibility:
variable BalanceWhiteAutoLowerLimit¶
Description: Controls the minimum value Auto White Balance can set for the Red/Blue BalanceRatio. Visibility:
variable BalanceWhiteAutoProfile¶
Description: Selects the profile used by BalanceWhiteAuto. Visibility:
variable BalanceWhiteAutoUpperLimit¶
Description: Controls the maximum value Auto White Balance can set the Red/Blue BalanceRatio. Visibility:
variable BinningHorizontal¶
Description: Number of horizontal photo-sensitive cells to combine together. This reduces the horizontal resolution (width) of the image. A value of 1 indicates that no horizontal binning is performed by the camera. This value must be 1 for decimation to be active. Visibility:
variable BinningHorizontalMode¶
Description: Visibility:
variable BinningSelector¶
Description: Selects which binning engine is controlled by the BinningHorizontal and BinningVertical features. Visibility:
variable BinningVertical¶
Description: Number of vertical photo-sensitive cells to combine together. This reduces the vertical resolution (height) of the image. A value of 1 indicates that no vertical binning is performed by the camera. This value must be 1 for decimation to be active. Visibility:
variable BinningVerticalMode¶
Description: Visibility:
variable BlackLevel¶
Description: Controls the offset of the video signal in percent. Visibility:
variable BlackLevelAuto¶
Description: Controls the mode for automatic black level adjustment. The exact algorithm used to implement this adjustment is device-specific. Visibility: Expert
variable BlackLevelAutoBalance¶
Description: Controls the mode for automatic black level balancing between the sensor color channels or taps. The black level coefficients of each channel are adjusted so they are matched. Visibility: Expert
variable BlackLevelClampingEnable¶
Description: Enable the black level auto clamping feature which performs dark current compensation. This feature is not supported by rolling shutter sensors. Visibility:
variable BlackLevelRaw¶
Description: Controls the offset of the video signal in camera specific units. Visibility:
variable BlackLevelSelector¶
Description: Selects which black level to control. Only All can be set by the user. Analog and Digital are read-only. Visibility:
variable BsiFlatFieldCorrectionAuto¶
GenApi::IEnumerationT<BsiFlatFieldCorrectionAutoEnums>& Spinnaker::Camera::BsiFlatFieldCorrectionAuto;
Description: Sets the auto BSI flat field correction mode. Set to Off to manually set the correction gains. Set to Continuous to automaticaly adjust the gains continually based on the current image content. Set to Once for a one-time admatic adjustment of the gains. Visibility:
variable BsiFlatFieldCorrectionAutoDamping¶
Description: Controls how quickly BsiFlatFieldCorrectionAuto adjusts the values of BsiFlatFieldCorrectionGain. Higher damping means the gains are changed more gradually. Visibility:
variable BsiFlatFieldCorrectionEnable¶
Description: Enables flat field correction for Back Size Illuminated sensors that have fixed pattern noise across 2x2 groups of pixels. Visibility:
variable BsiFlatFieldCorrectionGain¶
Description: Controls the flat field correction gain of the pixel location specified by BsiFlatFieldCorrectionGainSelector. This is a linear multiplier applied to the pixel value. Visibility:
variable BsiFlatFieldCorrectionGainSelector¶
GenApi::IEnumerationT<BsiFlatFieldCorrectionGainSelectorEnums>& Spinnaker::Camera::BsiFlatFieldCorrectionGainSelector;
Description: Selects which pixel position has its correction gain controlled by the BsiFlatFieldCorrectionGain feature. Visibility:
variable BufferedBurstFrameCountMax¶
Description: Number of images that can be acquired in buffered burst mode without transfer overflow. Visibility:
variable BufferedBurstMode¶
Description: If enabled, sensor is able to be triggered at sensor maximum frame rate. Device link throughtput will be ignored in calculating sensor maximum frame rate. Visibility:
variable BuiltInTest¶
Description: Returns the Built In Test status of the camera. Visibility: Expert
variable CFG_COLOR¶
Description: Visibility: Invisible
variable CFG_FACTORY¶
Description: Visibility: Invisible
variable CFG_GAMMA¶
Description: Visibility: Invisible
variable CFG_LF_FFC¶
Description: Visibility: Invisible
variable ChunkBlackLevel¶
Description: Returns the black level used to capture the image. Visibility:
variable ChunkBlackLevelSelector¶
Description: Selects which black level to retrieve Visibility:
variable ChunkCRC¶
Description: Returns the CRC of the image payload. Visibility:
variable ChunkCompressionMode¶
Description: Visibility:
variable ChunkCompressionRatio¶
Description: Visibility:
variable ChunkCounterSelector¶
Description: Selects which counter to retrieve data from. Visibility: Expert
variable ChunkCounterValue¶
Description: Returns the value of the selected Chunk counter at the time of the FrameStart event. Visibility: Expert
variable ChunkCurrentDatarate¶
Description: Visibility:
variable ChunkEnable¶
Description: Enables the inclusion of the selected Chunk data in the payload of the image. Visibility:
variable ChunkEncoderSelector¶
Description: Selects which Encoder to retrieve data from. Visibility: Expert
variable ChunkEncoderStatus¶
Description: Returns the motion status of the selected encoder. Visibility: Expert
variable ChunkEncoderValue¶
Description: Returns the counter's value of the selected Encoder at the time of the FrameStart in area scan mode or the counter's value at the time of the LineStart selected by ChunkScanLineSelector in LineScan mode. Visibility: Expert
variable ChunkExposureEndLineStatusAll¶
Description: Returns the status of all the I/O lines at the end of exposure event. Visibility:
variable ChunkExposureTime¶
Description: Returns the exposure time used to capture the image. Visibility:
variable ChunkExposureTimeSelector¶
GenApi::IEnumerationT<ChunkExposureTimeSelectorEnums>& Spinnaker::Camera::ChunkExposureTimeSelector;
Description: Selects which exposure time is read by the ChunkExposureTime feature. Visibility: Expert
variable ChunkFrameID¶
Description: Returns the image frame ID. Visibility:
variable ChunkGain¶
Description: Returns the gain used to capture the image. Visibility:
variable ChunkGainSelector¶
Description: Selects which gain to retrieve Visibility:
variable ChunkHeight¶
Description: Returns the height of the image included in the payload. Visibility:
variable ChunkImage¶
Description: Returns the image payload. Visibility:
variable ChunkImageComponent¶
Description: Returns the component of the payload image. This can be used to identify the image component of a generic part in a multipart transfer. Visibility: Expert
variable ChunkInferenceBoundingBoxResult¶
Description: Returns the chunk inference bounding box result data. Visibility: Expert
variable ChunkInferenceConfidence¶
Description: Returns the chunk data inference confidence percentage. Visibility: Expert
variable ChunkInferenceFrameId¶
Description: Returns the frame ID associated with the most recent inference result. Visibility: Expert
variable ChunkInferenceResult¶
Description: Returns the chunk data inference result. Visibility: Expert
variable ChunkLargePenalty¶
Description: Returns the penalty when the change of Disparity Change is plus or minus 1. Visibility: Expert
variable ChunkLinePitch¶
Description: Returns the LinePitch of the image included in the payload. Visibility: Expert
variable ChunkLineStatusAll¶
Description: Returns the status of all the I/O lines at the start of exposure event. Visibility:
variable ChunkMaxZ¶
Description: Returns the maximum depth in meters for the point cloud range. Visibility: Expert
variable ChunkMinZ¶
Description: Returns the minimum depth in meters for the point cloud range. Visibility: Expert
variable ChunkModeActive¶
Description: Activates the inclusion of Chunk data in the payload of the image. Visibility:
variable ChunkOffsetX¶
Description: Returns the Offset X of the image included in the payload. Visibility:
variable ChunkOffsetY¶
Description: Returns the Offset Y of the image included in the payload. Visibility:
variable ChunkPartSelector¶
Description: Selects the part to access in chunk data in a multipart transmission. Visibility: Expert
variable ChunkPixelDynamicRangeMax¶
Description: Returns the maximum value of dynamic range of the image included in the payload. Visibility: Expert
variable ChunkPixelDynamicRangeMin¶
Description: Returns the minimum value of dynamic range of the image included in the payload. Visibility: Expert
variable ChunkPixelFormat¶
Description: Format of the pixel provided by the camera Visibility:
variable ChunkRegionID¶
Description: Returns the identifier of Region that the image comes from. Visibility: Expert
variable ChunkScan3dAxisMax¶
Description: Returns the Maximum Axis value for the selected coordinate axis of the image included in the payload. Visibility: Expert
variable ChunkScan3dAxisMin¶
Description: Returns the Minimum Axis value for the selected coordinate axis of the image included in the payload. Visibility: Expert
variable ChunkScan3dBaseline¶
Description: Returns the baseline as the physical distance of two cameras in a stereo camera setup. The value of this feature can be used for 3D reconstruction from disparity images. In this case, the unit of the 3D coordinates corresponds to the unit of the baseline. Visibility: Expert
variable ChunkScan3dCoordinateOffset¶
Description: Returns the Offset for the selected coordinate axis of the image included in the payload. Visibility: Expert
variable ChunkScan3dCoordinateReferenceSelector¶
GenApi::IEnumerationT<ChunkScan3dCoordinateReferenceSelectorEnums>& Spinnaker::Camera::ChunkScan3dCoordinateReferenceSelector;
Description: Selector to read a coordinate system reference value defining the transform of a point from one system to the other. Visibility: Expert
variable ChunkScan3dCoordinateReferenceValue¶
Description: Reads the value of a position or pose coordinate for the anchor or transformed coordinate systems relative to the reference point. Visibility: Expert
variable ChunkScan3dCoordinateScale¶
Description: Returns the Scale for the selected coordinate axis of the image included in the payload. Visibility: Expert
variable ChunkScan3dCoordinateSelector¶
GenApi::IEnumerationT<ChunkScan3dCoordinateSelectorEnums>& Spinnaker::Camera::ChunkScan3dCoordinateSelector;
Description: Selects which Coordinate to retrieve data from. Visibility: Expert
variable ChunkScan3dCoordinateSystem¶
GenApi::IEnumerationT<ChunkScan3dCoordinateSystemEnums>& Spinnaker::Camera::ChunkScan3dCoordinateSystem;
Description: Returns the Coordinate System of the image included in the payload. Visibility: Expert
variable ChunkScan3dCoordinateSystemReference¶
GenApi::IEnumerationT<ChunkScan3dCoordinateSystemReferenceEnums>& Spinnaker::Camera::ChunkScan3dCoordinateSystemReference;
Description: Returns the Coordinate System Position of the image included in the payload. Visibility: Expert
variable ChunkScan3dCoordinateTransformSelector¶
GenApi::IEnumerationT<ChunkScan3dCoordinateTransformSelectorEnums>& Spinnaker::Camera::ChunkScan3dCoordinateTransformSelector;
Description: Selector for transform values. Visibility: Expert
variable ChunkScan3dDistanceUnit¶
Description: Returns the Distance Unit of the payload image. Visibility: Expert
variable ChunkScan3dFocalLength¶
Description: Returns the focal length of the camera in pixel. The focal length depends on the selected region. The value of this feature takes into account horizontal binning, decimation, or any other function changing the image resolution. Visibility: Expert
variable ChunkScan3dInvalidDataFlag¶
Description: Returns if a specific non-valid data flag is used in the data stream. Visibility: Expert
variable ChunkScan3dInvalidDataValue¶
Description: Returns the Invalid Data Value used for the image included in the payload. Visibility: Expert
variable ChunkScan3dOutputMode¶
Description: Returns the Calibrated Mode of the payload image. Visibility: Expert
variable ChunkScan3dPrincipalPointU¶
Description: Returns the value of this feature gives the horizontal position of the principal point, relative to the region origin, i.e. OffsetX. The value of this feature takes into account horizontal binning, decimation, or any other function changing the image resolution. Visibility: Expert
variable ChunkScan3dPrincipalPointV¶
Description: Returns the value of this feature gives the vertical position of the principal point, relative to the region origin, i.e. OffsetY. The value of this feature takes into account vertical binning, decimation, or any other function changing the image resolution. Visibility: Expert
variable ChunkScan3dTransformValue¶
Description: Returns the transform value. Visibility: Expert
variable ChunkScanLineSelector¶
Description: Index for vector representation of one chunk value per line in an image. Visibility: Expert
variable ChunkSelector¶
Description: Selects which chunk data to enable or disable. Visibility:
variable ChunkSequencerSetActive¶
Description: Returns the index of the active set of the running sequencer included in the payload. Visibility:
variable ChunkSerialData¶
Description: Returns the serial data that was received. Visibility:
variable ChunkSerialDataLength¶
Description: Returns the length of the received serial data that was included in the payload. Visibility:
variable ChunkSerialReceiveOverflow¶
Description: Returns the status of the chunk serial receive overflow. Visibility:
variable ChunkSmallPenalty¶
Description: Returns the penalty when the change of Disparity Change is plus or minus 1. Visibility: Expert
variable ChunkSourceID¶
Description: Returns the identifier of Source that the image comes from. Visibility: Expert
variable ChunkStereoHeight¶
Description: Returns the height of the image after stereo processing by the device (in pixels). Visibility: Expert
variable ChunkStereoWidth¶
Description: Returns the width of the image after stereo processing by the device (in pixels). Visibility: Expert
variable ChunkStreamChannelID¶
Description: Returns identifier of the stream channel used to carry the block. Visibility: Expert
variable ChunkTimerSelector¶
Description: Selects which Timer to retrieve data from. Visibility: Expert
variable ChunkTimerValue¶
Description: Returns the value of the selected Timer at the time of the FrameStart internal event. Visibility: Expert
variable ChunkTimestamp¶
Description: Returns the Timestamp of the image. Visibility:
variable ChunkTimestampLatchValue¶
Description: Returns the last Timestamp latched with the TimestampLatch command. Visibility: Expert
variable ChunkTransferBlockID¶
Description: Returns the unique identifier of the transfer block used to transport the payload. Visibility: Expert
variable ChunkTransferQueueCurrentBlockCount¶
Description: Returns the current number of blocks in the transfer queue. Visibility: Expert
variable ChunkTransferStreamID¶
Description: Returns identifier of the stream that generated this block. Visibility: Expert
variable ChunkUniquenessRatio¶
Description: Returns the difference between the best matching disparity and the second-best matching disparity. Visibility: Expert
variable ChunkWidth¶
Description: Returns the width of the image included in the payload. Visibility:
variable ClConfiguration¶
Description: This Camera Link specific feature describes the configuration used by the camera. It helps especially when a camera is capable of operation in a non-standard configuration, and when the features PixelSize, SensorDigitizationTaps, and DeviceTapGeometry do not provide enough information for interpretation of the image data provided by the camera. Visibility: Beginner
variable ClTimeSlotsCount¶
Description: This Camera Link specific feature describes the time multiplexing of the camera link connection to transfer more than the configuration allows, in one single clock. Visibility: Expert
variable ColorTransformationEnable¶
Description: Enables/disables the color transform selected with ColorTransformationSelector. For RGB to YUV this is read-only. Enabling/disabling RGB to YUV can only be done by changing pixel format. Visibility:
variable ColorTransformationSelector¶
GenApi::IEnumerationT<ColorTransformationSelectorEnums>& Spinnaker::Camera::ColorTransformationSelector;
Description: Selects which Color Transformation module is controlled by the various Color Transformation features Visibility:
variable ColorTransformationValue¶
Description: Represents the value of the selected Gain factor or Offset inside the Transformation matrix in floating point precision. Visibility:
variable ColorTransformationValueSelector¶
GenApi::IEnumerationT<ColorTransformationValueSelectorEnums>& Spinnaker::Camera::ColorTransformationValueSelector;
Description: Selects the Gain factor or Offset of the Transformation matrix to access in the selected Color Transformation module Visibility:
variable ComponentActiveCount¶
Description: Displays the number of active streams based on the number of components enabled. Visibility:
variable ComponentDestination¶
Description: Displays the destination of the selected component that is enabled (For example: stream 0/1/2 etc). Visibility:
variable ComponentEnable¶
Description: Control for enabling or disabling the selected component. Visibility:
variable ComponentSelector¶
Description: Control for selecting the component of a source (i.e. Raw/Rectified/Disparity). Visibility:
variable CompressedFrameDropCount¶
Description: Reports how many frames dropped to keep the datarate below the max threshold. Visibility:
variable CompressionSaturationPriority¶
GenApi::IEnumerationT<CompressionSaturationPriorityEnums>& Spinnaker::Camera::CompressionSaturationPriority;
Description: When FrameRate is enabled, camera drops frames if datarate is saturated. If FrameRate is disabled, camera adjusts the framerate to match the maximum achievable datarate. Visibility:
variable ConfigurationFactoryInfo¶
Description: Visibility: Invisible
variable ConfigurationInfo¶
Description: Visibility: Invisible
variable ConnectionConfig¶
Description: Select a combination of the Device connection speed and the number of active connections at which the camera should be operated. Visibility: Beginner
variable ConnectionConfigDefault¶
Description: The default ConnectionConfig that will be loaded at power-up. Visibility: Beginner
variable ConnectionReset¶
Description: Resets all connections of the Device. Visibility: Guru
variable ControlPacketSizeMax¶
Description: The maximum control packet data size. The size is defined in bytes, and shall be a multiple of 4 bytes. Visibility: Guru
variable ControlPacketsReservedBandwidth¶
Description: Reserved device link bandwidth(in bps) for control data. Visibility:
variable CounterDelay¶
Description: Sets the delay (or number of events) before the CounterStart event is generated. Visibility:
variable CounterDuration¶
Description: Sets the duration (or number of events) before the CounterEnd event is generated. Visibility:
variable CounterEventActivation¶
Description: Selects the activation mode of the event to increment the Counter. Visibility:
variable CounterEventSource¶
Description: Selects the event that will increment the counter Visibility:
variable CounterReset¶
Description: Does a software reset of the selected Counter and starts it. The counter starts counting events immediately after the reset unless a Counter trigger is active. CounterReset can be used to reset the Counter independently from the CounterResetSource. To disable the counter temporarily, set CounterEventSource to Off. Visibility: Expert
variable CounterResetActivation¶
Description: Selects the Activation mode of the Counter Reset Source signal. Visibility:
variable CounterResetSource¶
Description: Selects the signal that will be the source to reset the Counter. Visibility:
variable CounterSelector¶
Description: Selects which counter to configure Visibility:
variable CounterStatus¶
Description: Returns the current status of the Counter. Visibility:
variable CounterTriggerActivation¶
Description: Selects the activation mode of the trigger to start the Counter. Visibility:
variable CounterTriggerSource¶
Description: Selects the source of the trigger to start the counter Visibility:
variable CounterValue¶
Description: Current counter value Visibility:
variable CounterValueAtReset¶
Description: Value of the selected Counter when it was reset by a trigger. Visibility:
variable CrosshairOverlay¶
Description: Add a crosshair overlay to the image sent by the device. The crosshair is applied to the center of the image. Visibility: Expert
variable CxpConnectionSelector¶
Description: Selects the CoaXPress physical connection to control. Visibility: Expert
variable CxpConnectionTestErrorCount¶
Description: Reports the current connection error count for test packets recieved by the device on the connection selected by CxpConnectionSelector. Visibility: Expert
variable CxpConnectionTestMode¶
Description: Enables the test mode for an individual physical connection of the Device. Visibility: Expert
variable CxpConnectionTestPacketCount¶
Description: Reports the current count for test packets recieved by the device on the connection selected by CxpConnectionSelector. Visibility: Expert
variable CxpLinkConfiguration¶
Description: This feature allows specifying the Link configuration for the communication between the Receiver and Transmitter Device. In most cases this feature does not need to be written because automatic discovery will set configuration correctly to the value returned by CxpLinkConfigurationPreferred. Note that the currently active configuration of the Link can be read using CxpLinkConfigurationStatus. Visibility: Beginner
variable CxpLinkConfigurationPreferred¶
GenApi::IEnumerationT<CxpLinkConfigurationPreferredEnums>& Spinnaker::Camera::CxpLinkConfigurationPreferred;
Description: Provides the Link configuration that allows the Transmitter Device to operate in its default mode. Visibility: Expert
variable CxpLinkConfigurationStatus¶
GenApi::IEnumerationT<CxpLinkConfigurationStatusEnums>& Spinnaker::Camera::CxpLinkConfigurationStatus;
Description: This feature indicates the current and active Link configuration used by the Device. Visibility: Beginner
variable CxpPoCxpAuto¶
Description: Activate automatic control of the Power over CoaXPress (PoCXP) for the Link. Visibility: Expert
variable CxpPoCxpStatus¶
Description: Returns the Power over CoaXPress (PoCXP) status of the Device. Visibility: Expert
variable CxpPoCxpTripReset¶
Description: Reset the Power over CoaXPress (PoCXP) Link after an over-current trip on the Device connection(s). Visibility: Expert
variable CxpPoCxpTurnOff¶
Description: Disable Power over CoaXPress (PoCXP) for the Link. Visibility: Expert
variable DecimationHorizontal¶
Description: Horizontal decimation of the image. This reduces the horizontal resolution (width) of the image by only retaining a single pixel within a window whose size is the decimation factor specified here. A value of 1 indicates that no horizontal decimation is performed by the camera. This value must be 1 for binning to be active. Visibility:
variable DecimationHorizontalMode¶
Description: The mode used to reduce the horizontal resolution when DecimationHorizontal is used. The current implementation only supports a single decimation mode: Discard. Average should be achieved via Binning. Visibility:
variable DecimationSelector¶
Description: Selects which decimation layer is controlled by the DecimationHorizontal and DecimationVertical features. Visibility:
variable DecimationVertical¶
Description: Vertical decimation of the image. This reduces the vertical resolution (height) of the image by only retaining a single pixel within a window whose size is the decimation factor specified here. A value of 1 indicates that no vertical decimation is performed by the camera. This value must be 1 for binning to be active. Visibility:
variable DecimationVerticalMode¶
Description: The mode used to reduce the vertical resolution when DecimationVertical is used. The current implementation only supports a single decimation mode: Discard. Average should be achieved via Binning. Visibility:
variable DefectCorrectStaticEnable¶
Description: Enables/Disables table-based defective pixel correction. Visibility:
variable DefectCorrectionMode¶
Description: Controls the method used for replacing defective pixels. Visibility:
variable DefectPixelAdd¶
Description: Add the pixel determined by DefectPixelWriteX and DefectPixelWriteY to the defect pixel list in volatile memory. Visibility: Expert
variable DefectPixelClearAll¶
Description: Clear all pixels from the defect pixel list in volatile memory. Visibility: Expert
variable DefectPixelCorrectionEnable¶
Description: Enable or disable the defect pixel correction. Visibility: Guru
variable DefectPixelReadX¶
Description: The horizontal coordinate of the pixel selected by DefectPixelSelect. The origin of the coordinates is 0. Visibility: Expert
variable DefectPixelReadY¶
Description: The vertical coordinate of the pixel selected by DefectPixelSelect. The origin of the coordinates is 0. Visibility: Expert
variable DefectPixelRemove¶
Description: Remove the pixel determined by DefectPixelWriteX and DefectPixelWriteY from the defect pixel list in volatile memory. Visibility: Expert
variable DefectPixelRestore¶
Description: Restore the current defect pixel list to the user defect pixel list as saved in non-volatile memory. Visibility: Expert
variable DefectPixelRestoreFactory¶
Description: Restore the active defect pixel list to the factory default defect pixel list as saved in non-volatile memory. Visibility: Expert
variable DefectPixelSave¶
Description: Save the defect pixel list as a user list to the non-volatile memory. Visibility: Expert
variable DefectPixelSaveAsFactoryDefault¶
Description: Visibility: Guru
variable DefectPixelSelect¶
Description: Select an index position in the defect pixel list to read back the coordinates of the pixel. Visibility: Expert
variable DefectPixelStatus¶
Description: The status of the defect pixel list. Visibility: Beginner
variable DefectPixelTestMode¶
Description: Display the defect pixels in the output image. Visibility: Expert
variable DefectPixelTotal¶
Description: The total amount of pixels in the defect pixel list that will be corrected. Visibility: Expert
variable DefectPixelWriteX¶
Description: Set the horizontal coordinate of a pixel. The origin of the coordinates is 0. Visibility: Expert
variable DefectPixelWriteY¶
Description: Set the vertical coordinate of a pixel. The origin of the coordinates is 0. Visibility: Expert
variable DefectTableApply¶
Description: Applies the current defect table, so that any changes made affect images captured by the camera. This writes the table to volatile memory, so changes to the table are lost if the camera loses power. To save the table to non-volatile memory, use DefectTableSave. Visibility:
variable DefectTableCoordinateX¶
Description: Returns the X coordinate of the defective pixel at DefectTableIndex within the defective pixel table. Changes made do not take effect in captured images until the command DefectTableApply is written. Visibility:
variable DefectTableCoordinateY¶
Description: Returns the Y coordinate of the defective pixel at DefectTableIndex within the defective pixel table. Changes made do not take effect in captured images until the command DefectTableApply is written. Visibility:
variable DefectTableFactoryRestore¶
Description: Restores the Defective Pixel Table to its factory default state, which was calibrated during manufacturing. This permanently overwrites any changes made to the defect table. Visibility:
variable DefectTableIndex¶
Description: Controls the offset of the element to access in the defective pixel location table. Visibility:
variable DefectTablePixelCount¶
Description: The number of defective pixel locations in the current table. Visibility:
variable DefectTableSave¶
Description: Saves the current defective pixel table non-volatile memory, so that it is preserved when the camera boots up. This overwrites the existing defective pixel table. The new table is loaded whenever the camera powers up. Visibility:
variable DefectTableSensor¶
Description: Each sensor has its own defect table in volatile memory. This selector controls which sensor's defect table is being accessed. Visibility:
variable Deinterlacing¶
Description: Controls how the device performs de-interlacing. Visibility: Beginner
variable DeviceCharacterSet¶
Description: Character set used by the strings of the device`s bootstrap registers. Visibility:
variable DeviceClockFrequency¶
Description: Returns the frequency of the selected Clock. Visibility: Expert
variable DeviceClockSelector¶
Description: Selects the clock frequency to access from the device. Visibility: Expert
variable DeviceConnectionID¶
Description: The ID of the Device connection via which this register is read. Visibility: Guru
variable DeviceConnectionSelector¶
Description: Selects which Connection of the device to control. Visibility: Beginner
variable DeviceConnectionSpeed¶
Description: Indicates the speed of transmission of the specified Connection Visibility: Expert
variable DeviceConnectionStatus¶
Description: Indicates the status of the specified Connection. Visibility: Expert
variable DeviceData¶
Description: Data from the device Visibility: Beginner
variable DeviceDataFinalWrite¶
Description: Visibility: Guru
variable DeviceDataIndex¶
Description: Visibility: Beginner
variable DeviceDataRW_Select¶
Description: Select between reading and writing the DeviceData Visibility: Guru
variable DeviceDataRestart¶
Description: Visibility: Beginner
variable DeviceDataStatus¶
Description: DeviceDataStatus Visibility: Beginner
variable DeviceEventChannelCount¶
Description: Indicates the number of event channels supported by the device. Visibility:
variable DeviceFamilyName¶
Description: Identifier of the product family of the device. Visibility: Beginner
variable DeviceFeaturePersistenceEnd¶
Description: Indicate to the device the end of feature persistence. Visibility: Guru
variable DeviceFeaturePersistenceStart¶
Description: Indicate to the device and GenICam XML to get ready for persisting of all streamable features. Visibility: Guru
variable DeviceFirmwareVersion¶
Description: Version of the firmware on the device. Visibility:
variable DeviceGenCPVersionMajor¶
Description: Major version of the GenCP protocol supported by the device. Visibility:
variable DeviceGenCPVersionMinor¶
Description: Minor version of the GenCP protocol supported by the device. Visibility:
variable DeviceID¶
Description: Device identifier (serial number). Visibility:
variable DeviceIndicatorMode¶
Description: Controls the LED behaviour: Inactive (off), Active (current status), or Error Status (off unless an error occurs). Visibility:
variable DeviceLinkBandwidthReserve¶
Description: Percentage of streamed data bandwidth reserved for packet resend. Visibility:
variable DeviceLinkCommandTimeout¶
Description: Indicates the command timeout of the specified Link. This corresponds to the maximum response time of the device for a command sent on that link. Visibility: Guru
variable DeviceLinkConnectionCount¶
Description: Returns the number of physical connection of the device used by a particular Link. Visibility: Beginner
variable DeviceLinkCurrentThroughput¶
Description: Current bandwidth(in bps) of streamed data. Visibility:
variable DeviceLinkHeartbeatMode¶
Description: Activate or deactivate the Link's heartbeat. Visibility: Expert
variable DeviceLinkHeartbeatTimeout¶
Description: Controls the current heartbeat timeout of the specific Link. Visibility: Guru
variable DeviceLinkSelector¶
Description: Selects which Link of the device to control. Visibility: Beginner
variable DeviceLinkSpeed¶
Description: Indicates the speed of transmission negotiated on the specified Link. (Bps) Visibility:
variable DeviceLinkThroughputLimit¶
Description: Limits the maximum bandwidth(in bps) of the data that will be streamed out by the device on the selected Link. If necessary, delays will be uniformly inserted between transport layer packets in order to control the peak bandwidth. Visibility:
variable DeviceLinkThroughputLimitMode¶
GenApi::IEnumerationT<DeviceLinkThroughputLimitModeEnums>& Spinnaker::Camera::DeviceLinkThroughputLimitMode;
Description: Controls if the DeviceLinkThroughputLimit is active. When disabled, lower level TL specific features are expected to control the throughput. When enabled, DeviceLinkThroughputLimit controls the overall throughput. Visibility: Expert
variable DeviceManifestEntrySelector¶
Description: Selects the manifest entry to reference. Visibility: Guru
variable DeviceManifestPrimaryURL¶
Description: Indicates the first URL to the GenICam XML device description file of the selected manifest entry. Visibility: Guru
variable DeviceManifestSchemaMajorVersion¶
Description: Indicates the major version number of the schema file of the selected manifest entry. Visibility: Guru
variable DeviceManifestSchemaMinorVersion¶
Description: Indicates the minor version number of the schema file of the selected manifest entry. Visibility: Guru
variable DeviceManifestSecondaryURL¶
Description: Indicates the second URL to the GenICam XML device description file of the selected manifest entry. Visibility: Guru
variable DeviceManifestXMLMajorVersion¶
Description: Indicates the major version number of the GenICam XML file of the selected manifest entry. Visibility: Guru
variable DeviceManifestXMLMinorVersion¶
Description: Indicates the minor version number of the GenICam XML file of the selected manifest entry. Visibility: Guru
variable DeviceManifestXMLSubMinorVersion¶
Description: Indicates the subminor version number of the GenICam XML file of the selected manifest entry. Visibility: Guru
variable DeviceManufacturerInfo¶
Description: Manufacturer information about the device. Visibility:
variable DeviceMaxThroughput¶
Description: Maximum bandwidth(in bps) of the data that can be streamed out of the device. This can be used to estimate if the physical connection(s) can sustain transfer of free-running images from the camera at its maximum speed. Visibility:
variable DeviceModelName¶
Description: Model of the device. Visibility:
variable DevicePowerSupplySelector¶
GenApi::IEnumerationT<DevicePowerSupplySelectorEnums>& Spinnaker::Camera::DevicePowerSupplySelector;
Description: Selects the power supply source to control or read. Visibility:
variable DeviceRegistersCheck¶
Description: Perform the validation of the current register set for consistency. This will update the DeviceRegistersValid flag. Visibility: Expert
variable DeviceRegistersEndianness¶
GenApi::IEnumerationT<DeviceRegistersEndiannessEnums>& Spinnaker::Camera::DeviceRegistersEndianness;
Description: Endianess of the registers of the device. Visibility:
variable DeviceRegistersStreamingEnd¶
Description: Announce the end of registers streaming. This will do a register set validation for consistency and activate it. This will also update the DeviceRegistersValid flag. Visibility: Guru
variable DeviceRegistersStreamingStart¶
Description: Prepare the device for registers streaming without checking for consistency. Visibility: Guru
variable DeviceRegistersValid¶
Description: Returns if the current register set is valid and consistent. Visibility: Expert
variable DeviceReset¶
Description: This is a command that immediately resets and reboots the device. Visibility:
variable DeviceSFNCVersionMajor¶
Description: Major version of the Standard Features Naming Convention that was used to create the device's GenICam XML. Visibility: Beginner
variable DeviceSFNCVersionMinor¶
Description: Minor version of the Standard Features Naming Convention that was used to create the device's GenICam XML. Visibility: Beginner
variable DeviceSFNCVersionSubMinor¶
Description: Sub minor version of Standard Features Naming Convention that was used to create the device's GenICam XML. Visibility: Beginner
variable DeviceScanType¶
Description: Scan type of the sensor of the device. Visibility:
variable DeviceSensorChroma¶
Description: Indicates whether the camera is polarized mono, mono or color. Visibility:
variable DeviceSerialNumber¶
Description: Device's serial number. This string is a unique identifier of the device. Visibility:
variable DeviceSerialPortBaudRate¶
Description: This feature controls the baud rate used by the selected serial port. Visibility: Expert
variable DeviceSerialPortSelector¶
Description: Selects which serial port of the device to control. Visibility: Expert
variable DeviceStreamChannelCount¶
Description: Indicates the number of streaming channels supported by the device. Visibility:
variable DeviceStreamChannelEndianness¶
GenApi::IEnumerationT<DeviceStreamChannelEndiannessEnums>& Spinnaker::Camera::DeviceStreamChannelEndianness;
Description: Endianness of multi-byte pixel data for this stream. Visibility: Guru
variable DeviceStreamChannelLink¶
Description: Index of device's Link to use for streaming the specifed stream channel. Visibility: Guru
variable DeviceStreamChannelPacketSize¶
Description: Specifies the stream packet size, in bytes, to send on the selected channel for a Transmitter or specifies the maximum packet size supported by a receiver. Visibility: Expert
variable DeviceStreamChannelSelector¶
Description: Selects the stream channel to control. Visibility: Expert
variable DeviceStreamChannelType¶
Description: Reports the type of the stream channel. Visibility: Guru
variable DeviceTLType¶
Description: Transport Layer type of the device. Visibility:
variable DeviceTLVersionMajor¶
Description: Major version of the Transport Layer of the device. Visibility:
variable DeviceTLVersionMinor¶
Description: Minor version of the Transport Layer of the device. Visibility:
variable DeviceTLVersionSubMinor¶
Description: Sub minor version of the Transport Layer of the device. Visibility: Beginner
variable DeviceTapGeometry¶
Description: This device tap geometry feature describes the geometrical properties characterizing the taps of a camera as presented at the output of the device. Visibility: Expert
variable DeviceTapGeometryAddress¶
Description: The address in the manufacturer-specific register space of the feature with the corresponding name. Visibility: Guru
variable DeviceTemperature¶
Description: Device temperature in degrees Celsius (C). Visibility:
variable DeviceTemperatureSelector¶
GenApi::IEnumerationT<DeviceTemperatureSelectorEnums>& Spinnaker::Camera::DeviceTemperatureSelector;
Description: Selects the location within the device, where the temperature will be measured. Visibility:
variable DeviceType¶
Description: Returns the device type. Visibility: Guru
variable DeviceUptime¶
Description: Total time since the device was powered up in seconds. Visibility:
variable DeviceUserID¶
Description: User-programmable device identifier. Visibility:
variable DeviceVendorName¶
Description: Name of the manufacturer of the device. Visibility:
variable DeviceVersion¶
Description: Version of the device. Visibility:
variable ElectricalCompliancyTest¶
Description: To be used for the formal electrical compliancy testing of the Device. Visibility: Guru
variable EncoderDivider¶
Description: Sets how many Encoder increment/decrements that are needed generate an Encoder output pulse signal. Visibility: Expert
variable EncoderMode¶
Description: Selects if the count of encoder uses FourPhase mode with jitter filtering or the HighResolution mode without jitter filtering. Visibility: Expert
variable EncoderOutputMode¶
Description: Selects the conditions for the Encoder interface to generate a valid Encoder output signal. Visibility: Expert
variable EncoderReset¶
Description: Does a software reset of the selected Encoder and starts it. The Encoder starts counting events immediately after the reset. EncoderReset can be used to reset the Encoder independently from the EncoderResetSource. Visibility: Expert
variable EncoderResetActivation¶
Description: Selects the Activation mode of the Encoder Reset Source signal. Visibility: Expert
variable EncoderResetSource¶
Description: Selects the signals that will be the source to reset the Encoder. Visibility: Expert
variable EncoderSelector¶
Description: Selects which Encoder to configure. Visibility: Expert
variable EncoderSourceA¶
Description: Selects the signal which will be the source of the A input of the Encoder. Visibility: Expert
variable EncoderSourceB¶
Description: Selects the signal which will be the source of the B input of the Encoder. Visibility: Expert
variable EncoderStatus¶
Description: Returns the motion status of the encoder. Visibility: Expert
variable EncoderTimeout¶
Description: Sets the maximum time interval between encoder counter increments before the status turns to static. Visibility: Expert
variable EncoderValue¶
Description: Reads or writes the current value of the position counter of the selected Encoder. Visibility: Expert
variable EncoderValueAtReset¶
Description: Reads the value of the of the position counter of the selected Encoder when it was reset by a signal or by an explicit EncoderReset command. Visibility: Expert
variable EnumerationCount¶
Description: Number of enumerations since uptime. Visibility:
variable EventAcquisitionEnd¶
Description: Returns the unique Identifier of the Acquisition End type of Event. Visibility: Expert
variable EventAcquisitionEndFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition End Event. Visibility: Expert
variable EventAcquisitionEndTimestamp¶
Description: Returns the Timestamp of the Acquisition End Event. Visibility: Expert
variable EventAcquisitionError¶
Description: Returns the unique Identifier of the Acquisition Error type of Event. Visibility: Expert
variable EventAcquisitionErrorFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition Error Event. Visibility: Expert
variable EventAcquisitionErrorTimestamp¶
Description: Returns the Timestamp of the Acquisition Error Event. Visibility: Expert
variable EventAcquisitionStart¶
Description: Returns the unique Identifier of the Acquisition Start type of Event. Visibility: Expert
variable EventAcquisitionStartFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition Start Event. Visibility: Expert
variable EventAcquisitionStartTimestamp¶
Description: Returns the Timestamp of the Acquisition Start Event. Visibility: Expert
variable EventAcquisitionTransferEnd¶
Description: Returns the unique Identifier of the Acquisition Transfer End type of Event. Visibility: Expert
variable EventAcquisitionTransferEndFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition Transfer End Event. Visibility: Expert
variable EventAcquisitionTransferEndTimestamp¶
Description: Returns the Timestamp of the Acquisition Transfer End Event. Visibility: Expert
variable EventAcquisitionTransferStart¶
Description: Returns the unique Identifier of the Acquisition Transfer Start type of Event. Visibility: Expert
variable EventAcquisitionTransferStartFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition Transfer Start Event. Visibility: Expert
variable EventAcquisitionTransferStartTimestamp¶
Description: Returns the Timestamp of the Acquisition Transfer Start Event. Visibility: Expert
variable EventAcquisitionTrigger¶
Description: Returns the unique Identifier of the Acquisition Trigger type of Event. Visibility: Expert
variable EventAcquisitionTriggerFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition Trigger Event. Visibility: Expert
variable EventAcquisitionTriggerTimestamp¶
Description: Returns the Timestamp of the Acquisition Trigger Event. Visibility: Expert
variable EventActionLate¶
Description: Returns the unique Identifier of the Action Late type of Event. Visibility: Expert
variable EventActionLateFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Action Late Event. Visibility: Expert
variable EventActionLateTimestamp¶
Description: Returns the Timestamp of the Action Late Event. Visibility: Expert
variable EventCounter0End¶
Description: Returns the unique Identifier of the Counter 0 End type of Event. Visibility: Expert
variable EventCounter0EndFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Counter 0 End Event. Visibility: Expert
variable EventCounter0EndTimestamp¶
Description: Returns the Timestamp of the Counter 0 End Event. Visibility: Expert
variable EventCounter0Start¶
Description: Returns the unique Identifier of the Counter 0 Start type of Event. Visibility: Expert
variable EventCounter0StartFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Counter 0 Start Event. Visibility: Expert
variable EventCounter0StartTimestamp¶
Description: Returns the Timestamp of the Counter 0 Start Event. Visibility: Expert
variable EventCounter1End¶
Description: Returns the unique Identifier of the Counter 1 End type of Event. Visibility: Expert
variable EventCounter1EndFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Counter 1 End Event. Visibility: Expert
variable EventCounter1EndTimestamp¶
Description: Returns the Timestamp of the Counter 1 End Event. Visibility: Expert
variable EventCounter1Start¶
Description: Returns the unique Identifier of the Counter 1 Start type of Event. Visibility: Expert
variable EventCounter1StartFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Counter 1 Start Event. Visibility: Expert
variable EventCounter1StartTimestamp¶
Description: Returns the Timestamp of the Counter 1 Start Event. Visibility: Expert
variable EventEncoder0Restarted¶
Description: Returns the unique Identifier of the Encoder 0 Restarted type of Event. Visibility: Expert
variable EventEncoder0RestartedFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Encoder 0 Restarted Event. Visibility: Expert
variable EventEncoder0RestartedTimestamp¶
Description: Returns the Timestamp of the Encoder 0 Restarted Event. Visibility: Expert
variable EventEncoder0Stopped¶
Description: Returns the unique Identifier of the Encoder 0 Stopped type of Event. Visibility: Expert
variable EventEncoder0StoppedFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Encoder 0 Stopped Event. Visibility: Expert
variable EventEncoder0StoppedTimestamp¶
Description: Returns the Timestamp of the Encoder 0 Stopped Event. Visibility: Expert
variable EventEncoder1Restarted¶
Description: Returns the unique Identifier of the Encoder 1 Restarted type of Event. Visibility: Expert
variable EventEncoder1RestartedFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Encoder 1 Restarted Event. Visibility: Expert
variable EventEncoder1RestartedTimestamp¶
Description: Returns the Timestamp of the Encoder 1 Restarted Event. Visibility: Expert
variable EventEncoder1Stopped¶
Description: Returns the unique Identifier of the Encoder 1 Stopped type of Event. Visibility: Expert
variable EventEncoder1StoppedFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Encoder 1 Stopped Event. Visibility: Expert
variable EventEncoder1StoppedTimestamp¶
Description: Returns the Timestamp of the Encoder 1 Stopped Event. Visibility: Expert
variable EventError¶
Description: Returns the unique identifier of the Error type of Event. Visibility:
variable EventErrorCode¶
Description: Returns the error code for the error that happened Visibility:
variable EventErrorFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Error Event. Visibility:
variable EventErrorTimestamp¶
Description: Returns the Timestamp of the Error Event. Visibility:
variable EventExposureEnd¶
Description: Returns the unique identifier of the Exposure End type of Event. Visibility:
variable EventExposureEndFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Exposure End Event. Visibility:
variable EventExposureEndTimestamp¶
Description: Returns the Timestamp of the Exposure End Event. Visibility:
variable EventExposureStart¶
Description: Returns the unique Identifier of the Exposure Start type of Event. Visibility: Expert
variable EventExposureStartFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Exposure Start Event. Visibility: Expert
variable EventExposureStartTimestamp¶
Description: Returns the Timestamp of the Exposure Start Event. Visibility: Expert
variable EventFrameBurstEnd¶
Description: Returns the unique Identifier of the Frame Burst End type of Event. Visibility: Expert
variable EventFrameBurstEndFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Frame Burst End Event. Visibility: Expert
variable EventFrameBurstEndTimestamp¶
Description: Returns the Timestamp of the Frame Burst End Event. Visibility: Expert
variable EventFrameBurstStart¶
Description: Returns the unique Identifier of the Frame Burst Start type of Event. Visibility: Expert
variable EventFrameBurstStartFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Frame Burst Start Event. Visibility: Expert
variable EventFrameBurstStartTimestamp¶
Description: Returns the Timestamp of the Frame Burst Start Event. Visibility: Expert
variable EventFrameEnd¶
Description: Returns the unique Identifier of the Frame End type of Event. Visibility: Expert
variable EventFrameEndFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Frame End Event. Visibility: Expert
variable EventFrameEndTimestamp¶
Description: Returns the Timestamp of the Frame End Event. Visibility: Expert
variable EventFrameStart¶
Description: Returns the unique Identifier of the Frame Start type of Event. Visibility: Expert
variable EventFrameStartFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Frame Start Event. Visibility: Expert
variable EventFrameStartTimestamp¶
Description: Returns the Timestamp of the Frame Start Event. Visibility: Expert
variable EventFrameTransferEnd¶
Description: Returns the unique Identifier of the Frame Transfer End type of Event. Visibility: Expert
variable EventFrameTransferEndFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Frame Transfer End Event. Visibility: Expert
variable EventFrameTransferEndTimestamp¶
Description: Returns the Timestamp of the Frame Transfer End Event. Visibility: Expert
variable EventFrameTransferStart¶
Description: Returns the unique Identifier of the Frame Transfer Start type of Event. Visibility: Expert
variable EventFrameTransferStartFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Frame Transfer Start Event. Visibility: Expert
variable EventFrameTransferStartTimestamp¶
Description: Returns the Timestamp of the Frame Transfer Start Event. Visibility: Expert
variable EventFrameTrigger¶
Description: Returns the unique Identifier of the FrameTrigger type of Event. It can be used to register a callback function to be notified of the event occurrence. Its value uniquely identifies the type event received. Visibility: Expert
variable EventFrameTriggerFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the FrameTrigger Event. Visibility: Expert
variable EventFrameTriggerTimestamp¶
Description: Returns the Timestamp of the FrameTrigger Event. It can be used to determine precisely when the event occurred. Visibility: Expert
variable EventLine0AnyEdge¶
Description: Returns the unique Identifier of the Line 0 Any Edge type of Event. Visibility: Expert
variable EventLine0AnyEdgeFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Line 0 Any Edge Event. Visibility: Expert
variable EventLine0AnyEdgeTimestamp¶
Description: Returns the Timestamp of the Line 0 Any Edge Event. Visibility: Expert
variable EventLine0FallingEdge¶
Description: Returns the unique Identifier of the Line 0 Falling Edge type of Event. Visibility: Expert
variable EventLine0FallingEdgeFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Line 0 Falling Edge Event. Visibility: Expert
variable EventLine0FallingEdgeTimestamp¶
Description: Returns the Timestamp of the Line 0 Falling Edge Event. Visibility: Expert
variable EventLine0RisingEdge¶
Description: Returns the unique Identifier of the Line 0 Rising Edge type of Event. Visibility: Expert
variable EventLine0RisingEdgeFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Line 0 Rising Edge Event. Visibility: Expert
variable EventLine0RisingEdgeTimestamp¶
Description: Returns the Timestamp of the Line 0 Rising Edge Event. Visibility: Expert
variable EventLine1AnyEdge¶
Description: Returns the unique Identifier of the Line 1 Any Edge type of Event. Visibility: Expert
variable EventLine1AnyEdgeFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Line 1 Any Edge Event. Visibility: Expert
variable EventLine1AnyEdgeTimestamp¶
Description: Returns the Timestamp of the Line 1 Any Edge Event. Visibility: Expert
variable EventLine1FallingEdge¶
Description: Returns the unique Identifier of the Line 1 Falling Edge type of Event. Visibility: Expert
variable EventLine1FallingEdgeFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Line 1 Falling Edge Event. Visibility: Expert
variable EventLine1FallingEdgeTimestamp¶
Description: Returns the Timestamp of the Line 1 Falling Edge Event. Visibility: Expert
variable EventLine1RisingEdge¶
Description: Returns the unique Identifier of the Line 1 Rising Edge type of Event. Visibility: Expert
variable EventLine1RisingEdgeFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Line 1 Rising Edge Event. Visibility: Expert
variable EventLine1RisingEdgeTimestamp¶
Description: Returns the Timestamp of the Line 1 Rising Edge Event. Visibility: Expert
variable EventLinkSpeedChange¶
Description: Returns the unique Identifier of the Link Speed Change type of Event. Visibility: Expert
variable EventLinkSpeedChangeFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Link Speed Change Event. Visibility: Expert
variable EventLinkSpeedChangeTimestamp¶
Description: Returns the Timestamp of the Link Speed Change Event. Visibility: Expert
variable EventLinkTrigger0¶
Description: Returns the unique Identifier of the Link Trigger 0 type of Event. Visibility: Expert
variable EventLinkTrigger0FrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Link Trigger 0 Event. Visibility: Expert
variable EventLinkTrigger0Timestamp¶
Description: Returns the Timestamp of the Link Trigger 0 Event. Visibility: Expert
variable EventLinkTrigger1¶
Description: Returns the unique Identifier of the Link Trigger 1 type of Event. Visibility: Expert
variable EventLinkTrigger1FrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Link Trigger 1 Event. Visibility: Expert
variable EventLinkTrigger1Timestamp¶
Description: Returns the Timestamp of the Link Trigger 1 Event. Visibility: Expert
variable EventNotification¶
Description: Enables/Disables the selected event. Visibility:
variable EventSelector¶
Description: Selects which Event to enable or disable. Visibility:
variable EventSequencerSetChange¶
Description: Returns the unique Identifier of the Sequencer Set Change type of Event. Visibility: Expert
variable EventSequencerSetChangeFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Sequencer Set Change Event. Visibility: Expert
variable EventSequencerSetChangeTimestamp¶
Description: Returns the Timestamp of the Sequencer Set Change Event. Visibility: Expert
variable EventSerialData¶
Description: Returns the serial data that was received. Visibility:
variable EventSerialDataLength¶
Description: Returns the length of the received serial data that was included in the event payload. Visibility:
variable EventSerialPortReceive¶
Description: Returns the unique identifier of the Serial Port Receive type of Event. Visibility:
variable EventSerialPortReceiveTimestamp¶
Description: Returns the Timestamp of the Serial Port Receive Event. Visibility:
variable EventSerialReceiveOverflow¶
Description: Returns the status of the event serial receive overflow. Visibility:
variable EventStream0TransferBlockEnd¶
Description: Returns the unique Identifier of the Stream 0 Transfer Block End type of Event. Visibility: Expert
variable EventStream0TransferBlockEndFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Block End Event. Visibility: Expert
variable EventStream0TransferBlockEndTimestamp¶
Description: Returns the Timestamp of the Stream 0 Transfer Block End Event. Visibility: Expert
variable EventStream0TransferBlockStart¶
Description: Returns the unique Identifier of the Stream 0 Transfer Block Start type of Event. Visibility: Expert
variable EventStream0TransferBlockStartFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Block Start Event. Visibility: Expert
variable EventStream0TransferBlockStartTimestamp¶
Description: Returns the Timestamp of the Stream 0 Transfer Block Start Event. Visibility: Expert
variable EventStream0TransferBlockTrigger¶
Description: Returns the unique Identifier of the Stream 0 Transfer Block Trigger type of Event. Visibility: Expert
variable EventStream0TransferBlockTriggerFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Block Trigger Event. Visibility: Expert
variable EventStream0TransferBlockTriggerTimestamp¶
Description: Returns the Timestamp of the Stream 0 Transfer Block Trigger Event. Visibility: Expert
variable EventStream0TransferBurstEnd¶
Description: Returns the unique Identifier of the Stream 0 Transfer Burst End type of Event. Visibility: Expert
variable EventStream0TransferBurstEndFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Burst End Event. Visibility: Expert
variable EventStream0TransferBurstEndTimestamp¶
Description: Returns the Timestamp of the Stream 0 Transfer Burst End Event. Visibility: Expert
variable EventStream0TransferBurstStart¶
Description: Returns the unique Identifier of the Stream 0 Transfer Burst Start type of Event. Visibility: Expert
variable EventStream0TransferBurstStartFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Burst Start Event. Visibility: Expert
variable EventStream0TransferBurstStartTimestamp¶
Description: Returns the Timestamp of the Stream 0 Transfer Burst Start Event. Visibility: Expert
variable EventStream0TransferEnd¶
Description: Returns the unique Identifier of the Stream 0 Transfer End type of Event. Visibility: Expert
variable EventStream0TransferEndFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer End Event. Visibility: Expert
variable EventStream0TransferEndTimestamp¶
Description: Returns the Timestamp of the Stream 0 Transfer End Event. Visibility: Expert
variable EventStream0TransferOverflow¶
Description: Returns the unique Identifier of the Stream 0 Transfer Overflow type of Event. Visibility: Expert
variable EventStream0TransferOverflowFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Overflow Event. Visibility: Expert
variable EventStream0TransferOverflowTimestamp¶
Description: Returns the Timestamp of the Stream 0 Transfer Overflow Event. Visibility: Expert
variable EventStream0TransferPause¶
Description: Returns the unique Identifier of the Stream 0 Transfer Pause type of Event. Visibility: Expert
variable EventStream0TransferPauseFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Pause Event. Visibility: Expert
variable EventStream0TransferPauseTimestamp¶
Description: Returns the Timestamp of the Stream 0 Transfer Pause Event. Visibility: Expert
variable EventStream0TransferResume¶
Description: Returns the unique Identifier of the Stream 0 Transfer Resume type of Event. Visibility: Expert
variable EventStream0TransferResumeFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Resume Event. Visibility: Expert
variable EventStream0TransferResumeTimestamp¶
Description: Returns the Timestamp of the Stream 0 Transfer Resume Event. Visibility: Expert
variable EventStream0TransferStart¶
Description: Returns the unique Identifier of the Stream 0 Transfer Start type of Event. Visibility: Expert
variable EventStream0TransferStartFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Start Event. Visibility: Expert
variable EventStream0TransferStartTimestamp¶
Description: Returns the Timestamp of the Stream 0 Transfer Start Event. Visibility: Expert
variable EventTest¶
Description: Returns the unique identifier of the Test type of Event. Visibility:
variable EventTestTimestamp¶
Description: Returns the Timestamp of the Test Event. Visibility:
variable EventTimer0End¶
Description: Returns the unique Identifier of the Timer 0 End type of Event. Visibility: Expert
variable EventTimer0EndFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Timer 0 End Event. Visibility: Expert
variable EventTimer0EndTimestamp¶
Description: Returns the Timestamp of the Timer 0 End Event. Visibility: Expert
variable EventTimer0Start¶
Description: Returns the unique Identifier of the Timer 0 Start type of Event. Visibility: Expert
variable EventTimer0StartFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Timer 0 Start Event. Visibility: Expert
variable EventTimer0StartTimestamp¶
Description: Returns the Timestamp of the Timer 0 Start Event. Visibility: Expert
variable EventTimer1End¶
Description: Returns the unique Identifier of the Timer 1 End type of Event. Visibility: Expert
variable EventTimer1EndFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Timer 1 End Event. Visibility: Expert
variable EventTimer1EndTimestamp¶
Description: Returns the Timestamp of the Timer 1 End Event. Visibility: Expert
variable EventTimer1Start¶
Description: Returns the unique Identifier of the Timer 1 Start type of Event. Visibility: Expert
variable EventTimer1StartFrameID¶
Description: Returns the unique Identifier of the Frame (or image) that generated the Timer 1 Start Event. Visibility: Expert
variable EventTimer1StartTimestamp¶
Description: Returns the Timestamp of the Timer 1 Start Event. Visibility: Expert
variable ExposureActiveMode¶
Description: Control sensor active exposure mode. Visibility:
variable ExposureAuto¶
Description: Sets the automatic exposure mode Visibility:
variable ExposureMode¶
Description: Sets the operation mode of the Exposure. Visibility:
variable ExposureTime¶
Description: Sets the Exposure time when ExposureMode is Timed and ExposureAuto is Off. This controls the duration where the photosensitive cells are exposed to light. Visibility: Beginner
variable ExposureTimeMode¶
Description: Sets the configuration mode of the ExposureTime feature. Visibility: Beginner
variable ExposureTimeRaw¶
Description: Sets the Exposure time (in 1us steps). Visibility: Invisible
variable ExposureTimeSelector¶
Description: Selects which exposure time is controlled by the ExposureTime feature. This allows for independent control over the exposure components. Visibility: Beginner
variable ExternalVoltageEnable¶
Description: Internally generated output voltage rail. Enable to supply external circuits with power. This is different than standard logic outputs in that it is comparatively slow to switch but can supply a more significant amount of power. Visibility:
variable ExternalVoltageSelector¶
Description: Selects the kind of generated output voltage: 3.3V, 5.0V, Adjustable (0-10V) Visibility:
variable ExternalVoltageValue¶
Description: Configures the adjustable voltage rail between 0.0 - 10.0V. Values are uniformly scaled from user input to maximum DAC values. Visibility:
variable FPGATemperature¶
Description: Returns the temperature of the FPGA. Visibility: Beginner
variable FPGATemperatureRaw¶
Description: Returns the temperature of the FPGA. Visibility: Invisible
variable FPGA_RegisterAddress¶
Description: Visibility: Guru
variable FPGA_RegisterData¶
Description: Visibility: Guru
variable FPGA_RegisterRead¶
Description: Visibility: Guru
variable FPGA_RegisterSize¶
Description: Visibility: Guru
variable FPGA_RegisterWrite¶
Description: Visibility: Guru
variable FactoryReset¶
Description: Returns all user tables to factory default Visibility:
variable FanEnabled¶
Description: Enable Fan. Visibility: Beginner
variable FanPercentage¶
Description: Percentage of the fan speed 20-100% Visibility: Beginner
variable FanSpeed¶
Description: Speed of the fan in RPM Visibility: Beginner
variable FanType¶
Description: Select the type of fan that is connected. Visibility: Expert
variable FfcEnable¶
Description: Enable or disable flat field correction. Visibility:
variable FfcMode¶
Description: Selects flat field correction mode. Note that flat field correction parameters are accessible only in Calibration mode. When switching modes from Calibration to User or Factory, it is recommended to stop image streaming to give the camera enough time to load the corresponding table. Visibility:
variable FfcUserGain¶
Description: The value of user flat field gain correction for the current pixel. Visibility:
variable FfcUserOffset¶
Description: The value of user flat field offset correction for the current pixel. Visibility:
variable FfcUserTableReset¶
Description: Resets the user flat field correction table to the last saved values loaded from the camera. If nothing has been previously saved, this resets to the default values which is the equivalent of disabling FFC. Visibility:
variable FfcUserTableSave¶
Description: Saves the current User flat field correction table into the camera, which means the table is still available after a power cycle. Note that this overwrites the existing saved User table. Visibility:
variable FfcUserTableXCoordinate¶
Description: Controls the pixel X coordinate of the user flat field correction coefficients. Visibility:
variable FileAccessBuffer¶
Description: Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application. Visibility: Guru
variable FileAccessLength¶
Description: Controls the Length of the mapping between the device file storage and the FileAccessBuffer. Visibility:
variable FileAccessOffset¶
Description: Controls the Offset of the mapping between the device file storage and the FileAccessBuffer. Visibility:
variable FileOpenMode¶
Description: The mode of the file when it is opened. The file can be opened for reading, writting or both. This must be set before opening the file. Visibility:
variable FileOperationExecute¶
Description: This is a command that executes the selected file operation on the selected file. Visibility:
variable FileOperationResult¶
Description: Represents the file operation result. For Read or Write operations, the number of successfully read/written bytes is returned. Visibility:
variable FileOperationSelector¶
Description: Sets operation to execute on the selected file when the execute command is given. Visibility:
variable FileOperationStatus¶
Description: Represents the file operation execution status. Visibility:
variable FileSelector¶
Description: Selects which file is being operated on. This must be set before performing any file operations. Visibility:
variable FileSize¶
Description: Represents the size of the selected file in bytes. Visibility:
variable FlashStrobeActiveState¶
Description: The active state of the flash strobe output Visibility: Beginner
variable FlashStrobeDelay¶
Description: Controls the delay of the flashstrobe in us. Visibility: Beginner
variable FlashStrobeDelayRaw¶
Description: Controls the delay of the flashstrobe in steps of 1us. Visibility: Invisible
variable FlashStrobeDuration¶
Description: Controls the duration of the flash strobe in us. Visibility: Beginner
variable FlashStrobeDurationRaw¶
Description: Controls the duration of the flash strobe in steps of 1us. Visibility: Invisible
variable FlashStrobeMode¶
Description: Selects the mode of the flashstrobe. Visibility: Beginner
variable FrameCounterOverlay¶
Description: Add a frame counter overlay to the image sent by the device. The frame counter is positioned in the first 4 pixels of the first image row. Visibility: Expert
variable FrameCounterReset¶
Description: Reset the frame counter to 0. Visibility: Expert
variable Gain¶
Description: Controls the selected gain as an absolute physical value. This is an amplification factor applied to the video signal. Visibility: Beginner
variable GainAuto¶
Description: Sets the automatic gain mode. Set to Off for manual control. Set to Once for a single automatic adjustment then return to Off. Set to Continuous for constant adjustment. In automatic modes, the camera adjusts the gain to maximize the dynamic range. Visibility:
variable GainAutoBalance¶
Description: Sets the mode for automatic gain balancing between the sensor color channels or taps. The gain coefficients of each channel or tap are adjusted so they are matched. Visibility: Beginner
variable GainConversion¶
Description: Selects which gain conversion mode to use. Visibility:
variable GainMode¶
- Maximum Full Well
- High Full Well
- Maximum Dynamic Range
- High Sensitivity Visibility: Beginner
variable GainRaw¶
Description: Controls the selected gain as an absolute physical value. Visibility: Invisible
variable GainSelector¶
Description: Selects which gain to control. The All selection is a total amplification across all channels (or taps). Visibility:
variable Gamma¶
Description: Controls the gamma correction of pixel intensity. Visibility:
variable GammaEnable¶
Description: Enables/disables gamma correction. Visibility:
variable GammaFactor¶
Description: Set the gamma factor (only for LUTselection = Gamma). Visibility: Expert
variable GammaFactorRaw¶
Description: Set the gamma factor (only for LUTselection = Gamma). Visibility: Invisible
variable GevActiveLinkCount¶
Description: Indicates the current number of active logical links. Visibility: Expert
variable GevCCP¶
Description: Controls the device access privilege of an application. Visibility:
variable GevCurrentDefaultGateway¶
Description: Reports the default gateway IP address to be used on the given logical link. Visibility:
variable GevCurrentIPAddress¶
Description: Reports the IP address for the given logical link. Visibility:
variable GevCurrentIPConfigurationDHCP¶
Description: Controls whether the DHCP IP configuration scheme is activated on the given logical link. Visibility:
variable GevCurrentIPConfigurationLLA¶
Description: Controls whether the Link Local Address IP configuration scheme is activated on the given logical link. Visibility:
variable GevCurrentIPConfigurationPersistentIP¶
Description: Controls whether the PersistentIP configuration scheme is activated on the given logical link. Visibility:
variable GevCurrentPhysicalLinkConfiguration¶
GenApi::IEnumerationT<GevCurrentPhysicalLinkConfigurationEnums>& Spinnaker::Camera::GevCurrentPhysicalLinkConfiguration;
Description: Indicates the current physical link configuration of the device. Visibility: Expert
variable GevCurrentSubnetMask¶
Description: Reports the subnet mask of the given logical link. Visibility:
variable GevDiscoveryAckDelay¶
Description: Indicates the maximum randomized delay the device will wait to acknowledge a discovery command. Visibility: Expert
variable GevFirstURL¶
Description: The first choice of URL for the XML device description file. Visibility:
variable GevGVCPExtendedStatusCodes¶
Description: Enables the generation of extended status codes. Visibility:
variable GevGVCPExtendedStatusCodesSelector¶
GenApi::IEnumerationT<GevGVCPExtendedStatusCodesSelectorEnums>& Spinnaker::Camera::GevGVCPExtendedStatusCodesSelector;
Description: Selects the GigE Vision version to control extended status codes for. Visibility:
variable GevGVCPHeartbeatDisable¶
Description: Disables the GVCP heartbeat. Visibility:
variable GevGVCPPendingAck¶
Description: Enables the generation of PENDING_ACK. Visibility:
variable GevGVCPPendingTimeout¶
Description: Indicates the longest GVCP command execution time before the device returns a PENDING_ACK in milliseconds. Visibility:
variable GevGVSPExtendedIDMode¶
Description: Enables the extended IDs mode. Visibility: Expert
variable GevHeartbeatTimeout¶
Description: Indicates the current heartbeat timeout in milliseconds. Visibility:
variable GevIEEE1588¶
Description: Enables the IEEE 1588 Precision Time Protocol to control the timestamp register. Visibility:
variable GevIEEE1588ClockAccuracy¶
Description: Indicates the expected accuracy of the device clock when it is the grandmaster, or in the event it becomes the grandmaster. Visibility:
variable GevIEEE1588ClockId¶
Description: Port identity of the current best master. The clock ID is an Extended Unique Identifier (EUI)-64 64-bit ID. Visibility:
variable GevIEEE1588DataSetLatch¶
Description: Latches the current IEEE 1588 dataset Visibility:
variable GevIEEE1588Mode¶
Description: Provides the mode of the IEEE 1588 clock. Visibility:
variable GevIEEE1588OffsetFromMasterLatched¶
Description: Dynamically returns the 64-bit value of the PTP offset with the master, in nanoseconds. This value is the input for clock corrections for the slave device clock servo algorithms. Visibility:
variable GevIEEE1588ParentClockIdLatched¶
Description: IEEE 1588 Latched Parent ID Visibility:
variable GevIEEE1588Status¶
Description: Provides the status of the IEEE 1588 clock. Visibility:
variable GevIEEE1588StatusLatched¶
Description: IEEE 1588 Latched Status Visibility:
variable GevIPConfigurationStatus¶
Description: Reports the current IP configuration status. Visibility: Beginner
variable GevInterfaceSelector¶
Description: Selects which logical link to control. Visibility:
variable GevMACAddress¶
Description: MAC address of the logical link. Visibility:
variable GevMCDA¶
Description: Controls the destination IP address of the message channel Visibility:
variable GevMCPHostPort¶
Description: The port to which the device must send messages Visibility:
variable GevMCRC¶
Description: Indicates the number of retries of the message channel. Visibility:
variable GevMCSP¶
Description: Indicates the source port of the message channel. Visibility:
variable GevMCTT¶
Description: Indicates the transmission timeout of the message channel. Visibility:
variable GevNumberOfActiveLinks¶
Description: Indicates the number of active links supported by this device. Visibility:
variable GevNumberOfInterfaces¶
Description: Indicates the number of physical network interfaces supported by this device. Visibility:
variable GevPAUSEFrameReception¶
Description: Controls whether the Pause Frame is activated on the given logical link. Visibility:
variable GevPAUSEFrameTransmission¶
Description: Controls whether PAUSE Frames can be generated on the given logical link. Visibility: Expert
variable GevPersistentDefaultGateway¶
Description: Controls the persistent default gateway for this logical link. Visibility:
variable GevPersistentIPAddress¶
Description: Controls the Persistent IP address for this logical link. Visibility:
variable GevPersistentSubnetMask¶
Description: Controls the Persistent subnet mask associated with the Persistent IP address on this logical link. Visibility:
variable GevPhysicalLinkConfiguration¶
GenApi::IEnumerationT<GevPhysicalLinkConfigurationEnums>& Spinnaker::Camera::GevPhysicalLinkConfiguration;
Description: Indicates the principal physical link configuration currently enabled on this device. Visibility:
variable GevPhysicalLinkConfigurationCapability¶
Description: Indicates the physical link configuration supported by this device. Visibility:
variable GevPrimaryApplicationIPAddress¶
Description: Returns the address of the primary application. Visibility: Guru
variable GevPrimaryApplicationSocket¶
Description: Returns the UDP source port of the primary application. Visibility: Guru
variable GevPrimaryApplicationSwitchoverKey¶
Description: Controls the key to use to authenticate primary application switchover requests. Visibility: Guru
variable GevSCCFGAllInTransmission¶
Description: Enables the selected GVSP transmitter to use the single packet per data block All-in Transmission mode. Visibility: Guru
variable GevSCCFGExtendedChunkData¶
Description: Enables cameras to use the extended chunk data payload type for this stream channel. Visibility:
variable GevSCCFGPacketResendDestination¶
Description: Enables the alternate IP destination for stream packets resent due to a packet resend request. When True, the source IP address provided in the packet resend command packet is used. When False, the value set in the GevSCDA[GevStreamChannelSelector] feature is used. Visibility: Guru
variable GevSCCFGUnconditionalStreaming¶
Description: Enables the camera to continue to stream, for this stream channel, if its control channel is closed or regardless of the reception of any ICMP messages (such as destination unreachable messages). Visibility:
variable GevSCDA¶
Description: Controls the destination IP address of the selected stream channel to which a GVSP transmitter must send data stream or the destination IP address from which a GVSP receiver may receive data stream. Visibility:
variable GevSCPD¶
Description: Controls the delay (in GEV timestamp counter unit) to insert between each packet for this stream channel. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device. Visibility:
variable GevSCPDirection¶
Description: Visibility:
variable GevSCPHostPort¶
Description: Controls the port of the selected channel to which a GVSP transmitter must send data stream or the port from which a GVSP receiver may receive data stream. Visibility:
variable GevSCPInterfaceIndex¶
Description: Index of the logical link to use. Visibility:
variable GevSCPSBigEndian¶
Description: Endianess of multi-byte pixel data for this stream. Visibility:
variable GevSCPSDoNotFragment¶
Description: The state of this feature is copied into the "do not fragment" bit of the IP header of each stream packet. Visibility:
variable GevSCPSFireTestPacket¶
Description: Sends a test packet. Visibility:
variable GevSCPSPacketSize¶
Description: Specifies the stream packet size (in bytes) to send on this channel. Visibility:
variable GevSCSP¶
Description: Indicates the source port of the stream channel. Visibility:
variable GevSCZoneConfigurationLock¶
Description: Controls whether the selected stream channel multi-zone configuration is locked. When locked, the GVSP transmitter is not allowed to change the number of zones and their direction during block acquisition and transmission. Visibility: Guru
variable GevSCZoneCount¶
Description: Reports the number of zones per block transmitted on the selected stream channel. Visibility: Guru
variable GevSCZoneDirectionAll¶
Description: Reports the transmission direction of each zone transmitted on the selected stream channel. Visibility: Guru
variable GevSecondURL¶
Description: The second choice of URL to the XML device description file. Visibility:
variable GevStreamChannelSelector¶
Description: Selects the stream channel to control. Visibility:
variable GevSupportedOption¶
Description: Returns if the selected GEV option is supported. Visibility:
variable GevSupportedOptionSelector¶
GenApi::IEnumerationT<GevSupportedOptionSelectorEnums>& Spinnaker::Camera::GevSupportedOptionSelector;
Description: Selects the GEV option to interrogate for existing support. Visibility:
variable GevTimestampTickFrequency¶
Description: Indicates the number of timestamp ticks in 1 second (frequency in Hz). Visibility:
variable GuiXmlManifestAddress¶
Description: Location of the GUI XML manifest table. Visibility:
variable Height¶
Description: Height of the image provided by the device (in pixels). Visibility: Beginner
variable HeightAddress¶
Description: The address in the manufacturer-specific register space of the feature with the corresponding name. Visibility: Guru
variable HeightMax¶
Description: Maximum height of the image (in pixels). This dimension is calculated after vertical binning. HeightMax does not take into account the current Region of interest (Height or OffsetY). Visibility:
variable HsUpconnection¶
Description: Indicates the Device support of the optional high speed upconnection. Visibility: Guru
variable Iidc2Address¶
Description: If the Device supports the IIDC2 protocol, then this register shall provide the address of the start of the IIDC2 register space. Visibility: Guru
variable Image1StreamID¶
Description: Identification of stream 1. Visibility: Guru
variable Image1StreamIDAddress¶
Description: The address in the manufacturer-specific register space of the feature with the corresponding name. Visibility: Guru
variable Image2StreamID¶
Description: Identification of stream 2. Visibility: Guru
variable Image2StreamIDAddress¶
Description: The address in the manufacturer-specific register space of the feature with the corresponding name. Visibility: Guru
variable ImageComponentEnable¶
Description: Controls if the selected component streaming is active. Visibility: Beginner
variable ImageComponentSelector¶
Description: Selects a component to activate data streaming from. Visibility: Beginner
variable ImageCompressionBitrate¶
Description: Control the rate of the produced compressed stream. Visibility: Expert
variable ImageCompressionJPEGFormatOption¶
GenApi::IEnumerationT<ImageCompressionJPEGFormatOptionEnums>& Spinnaker::Camera::ImageCompressionJPEGFormatOption;
Description: When JPEG is selected as the compression format, a device might optionally offer better control over JPEG-specific options through this feature. Visibility: Expert
variable ImageCompressionMode¶
Description: Enabling lowers bandwidth usage or increases frame rate for typical scenes. For Lossless, ISP must be off and Pixel format must be Mono8 or BayerRG8. Visibility:
variable ImageCompressionQuality¶
Description: Control the quality of the produced compressed stream. Visibility: Expert
variable ImageCompressionRateOption¶
GenApi::IEnumerationT<ImageCompressionRateOptionEnums>& Spinnaker::Camera::ImageCompressionRateOption;
Description: Two rate controlling options are offered: fixed bit rate or fixed quality. The exact implementation to achieve one or the other is vendor-specific. Visibility: Expert
variable InterfaceUtilization¶
Description: Decreases the line rate of the sensor in order to prevent the framegrabber from being overrun. Visibility: Beginner
variable IspEnable¶
Description: Controls whether the image processing core is used for optional pixel format mode (i.e. mono). Visibility:
variable LF_FF_Calibrate¶
Description: Execute the calibration if camera is in manual SetSelectionMode. A successful result is stored in the set indicated by the SetSelector. Visibility: Expert
variable LF_FF_CalibrationROI¶
Description: Select if the calibration is performed on the complete sensor ROI or on the user ROI. Visibility: Expert
variable LF_FF_CalibrationStatus¶
Description: The Low Frequency Flat Field calibration status of the camera. Visibility: Expert
variable LF_FF_Correction¶
Description: Enable or disable the spatially low frequency flat field correction. Not possible in co-operation with the Binning or Band function. Visibility: Beginner
variable LF_FF_ManualSetSelector¶
Description: Select the active FF correction set (Only for SetSelectionMode = Manual). Visibility: Expert
variable LF_FF_RawSetData¶
Description: Raw data register for reading or writing an LF_FFC set. Visibility: Expert
variable LF_FF_RawSetDataEnd¶
Description: End the raw data transfer of a LF_FFC set. Visibility: Expert
variable LF_FF_RawSetDataReadStart¶
Description: Start the raw data transfer of a LF_FFC set from the camera. Visibility: Expert
variable LF_FF_RawSetDataStatus¶
Description: Status of a LF_FFC set read or write action. The status is updated on a WriteStart, ReadStart or DataEnd action. Visibility: Expert
variable LF_FF_RawSetDataTransferSize¶
Description: The size (in bytes) of a LF_FFC set. Visibility: Expert
variable LF_FF_RawSetDataWriteStart¶
Description: Start the raw data transfer of a LF_FFC set to the camera. Visibility: Expert
variable LF_FF_ReferencePoint¶
Description: Determine if the flat reference level after FF calibration aligns with the peak or average video level that is present during calibration. Visibility: Expert
variable LF_FF_ResetCurrentSet¶
Description: The current selected set is being reset. The gain is set to 1 for the whole image. Visibility: Expert
variable LF_FF_SequenceIndexSelector¶
Description: Select the sequence index that will be read with SequenceReadSelectedIndex feature. Visibility: Expert
variable LF_FF_SequenceLoad¶
Description: Load the programmed sequence from non-volatile memory. Visibility: Expert
variable LF_FF_SequenceReadCurrentSet¶
Description: The set number which is currently used for correction. Visibility: Expert
variable LF_FF_SequenceReadSelectedIndex¶
Description: The set number of the sequence index position indicated by SequenceIndexSelector. Visibility: Expert
variable LF_FF_SequenceRepeat¶
Description: Determine if the sequence repeats or sticks at the last step. Visibility: Expert
variable LF_FF_SequenceReset¶
Description: Reset the sequencer pointer to the first step during sequenced correction. Visibility: Expert
variable LF_FF_SequenceSave¶
Description: Save the programmed sequence to non-volatile memory. Visibility: Expert
variable LF_FF_SequenceSet¶
Description: After a SequenceStartProgram, repetitive write actions to this register builds the sequence. Visibility: Expert
variable LF_FF_SequenceStartProgram¶
Description: Start sequencer programming. Visibility: Expert
variable LF_FF_SequenceStatus¶
Description: The status when programming a sequence in the camera. Visibility: Expert
variable LF_FF_SequenceStopProgram¶
Description: Stop sequencer programming. Visibility: Expert
variable LF_FF_SequenceTotal¶
Description: The total amount of sequence entries. Visibility: Expert
variable LF_FF_SetSelectionMode¶
Description: Select if the active set is determined manually with ManualSetSelector or by the sequencer. Visibility: Expert
variable LF_FF_ViewCorrection¶
Description: When enabled the active spatially low frequency flat field correction set will be shown. In 10 bit, a correction factor of 1 equals a grey level of 256. Visibility: Expert
variable LF_FF_ViewMetaData¶
Description: Enable or disable the inclusion of meta data in the first pixel row. Visibility: Expert
variable LUTEnable¶
Description: Activates the selected LUT. Visibility:
variable LUTEnd¶
Description: End the LUT programming mode. Visibility: Expert
variable LUTIndex¶
Description: Control the index (offset) of the coefficient to access in the selected LUT. Visibility:
variable LUTSelection¶
Description: Select which LUT should be used. Visibility: Expert
variable LUTSelector¶
Description: Selects which LUT to control. Visibility:
variable LUTStart¶
Description: Start the LUT programming mode. After the programming mode is started the LUT can be programmed with LUTvalue. Visibility: Expert
variable LUTStatus¶
Description: The status of the camera LUT. Visibility: Expert
variable LUTValue¶
Description: Returns the Value at entry LUTIndex of the LUT selected by LUTSelector. Visibility:
variable LUTValueAll¶
Description: Accesses all the LUT coefficients in a single access without using individual LUTIndex. Visibility: Guru
variable LargePenalty¶
Description: Displays the penalty when the change of Disparity Change is more than 1. Visibility:
variable LensShadingCoefficientActiveSet¶
GenApi::IEnumerationT<LensShadingCoefficientActiveSetEnums>& Spinnaker::Camera::LensShadingCoefficientActiveSet;
Description: Facilitates selection of on camera shading correction calibration files. Visibility:
variable LensShadingCorrectionCalibration¶
Description: Performs the shading correction calibration on the last image transmitted to the host in memory. Visibility:
variable LensShadingCorrectionCalibrationGainLimit¶
Description: Maximum gain value set for the lens shading algorithm on the camera. Visibility:
variable LensShadingCorrectionCalibrationSetup¶
Description: Set up the camera parameters needed to be set for shading correction calibration. At least one image must be acquired after the setup for proper calibration. Visibility:
variable LensShadingCorrectionCalibrationStatus¶
Description: Returns the current status of the Calibration. Visibility:
variable LensShadingCorrectionMode¶
GenApi::IEnumerationT<LensShadingCorrectionModeEnums>& Spinnaker::Camera::LensShadingCorrectionMode;
Description: Activates Lens Shading Correction with the selected Lens Shading Coefficient Active Set. Visibility:
variable LensShadingCorrectionStepSize¶
Description: The grid step size for the lens shading algorithm on the camera. Visibility:
variable LensShadingCorrectionVersion¶
Description: The version number of the lens shading algorithm on the camera. Visibility:
variable LineFilterWidth¶
Description: Filter width in microseconds for the selected line and filter combination Visibility:
variable LineFormat¶
Description: Displays the current electrical format of the selected physical input or output Line. Visibility:
variable LineInputFilterSelector¶
Description: Selects the kind of input filter to configure: Deglitch or Debounce. Visibility:
variable LineInverter¶
Description: Controls the inversion of the signal of the selected input or output line. Visibility:
variable LineMode¶
Description: Controls if the physical Line is used to Input or Output a signal. Visibility:
variable LinePitch¶
Description: Total number of bytes between 2 successive lines. This feature is used to facilitate alignment of image data. Visibility: Expert
variable LineSelector¶
Description: Selects the physical line (or pin) of the external device connector to configure Visibility:
variable LineSource¶
Description: Selects which internal acquisition or I/O source signal to output on the selected line. LineMode must be Output. Visibility:
variable LineStatus¶
Description: Returns the current status of the selected input or output Line Visibility:
variable LineStatusAll¶
Description: Returns the current status of all available Line signals at time of polling in a single bitfield. Visibility: Expert
variable LinkErrorCount¶
Description: Counts the number of error on the link. Visibility:
variable LinkRecoveryCount¶
Description: Counts the number of times the USB link has recovered. Visibility:
variable LinkUptime¶
Description: Time since the last phy negotiation (enumeration). Visibility:
variable LogicBlockLUTInputActivation¶
GenApi::IEnumerationT<LogicBlockLUTInputActivationEnums>& Spinnaker::Camera::LogicBlockLUTInputActivation;
Description: Selects the activation mode of the Logic Input Source signal. Visibility:
variable LogicBlockLUTInputSelector¶
GenApi::IEnumerationT<LogicBlockLUTInputSelectorEnums>& Spinnaker::Camera::LogicBlockLUTInputSelector;
Description: Controls which LogicBlockLUT Input Source & Activation to access. Visibility:
variable LogicBlockLUTInputSource¶
Description: Selects the source for the input into the Logic LUT. Visibility:
variable LogicBlockLUTOutputValue¶
Description: Controls the output column of the truth table for the selected LogicBlockLUTRowIndex. Visibility:
variable LogicBlockLUTOutputValueAll¶
Description: Sets the value of all the output bits in the selected LUT. Visibility:
variable LogicBlockLUTRowIndex¶
Description: Controls the row of the truth table to access in the selected LUT. Visibility:
variable LogicBlockLUTSelector¶
Description: Selects which LogicBlock LUT to configure Visibility:
variable LogicBlockSelector¶
Description: Selects which LogicBlock to configure Visibility:
variable MasterHostConnectionID¶
Description: The Host Connection ID of the host connection connected to the Device Master connection. Visibility: Guru
variable MaxDatarateThreshold¶
Description: Maximum desired datarate (B/s) for the compressed stream. If this is exceeded, then compression saturation priority type determines how the camera handles the payload. Visibility:
variable MaxDeviceResetTime¶
Description: Time to wait until device reset complete (ms). Visibility:
variable MaxNumberOfDefects¶
Description: The maximum number of defect pixels that can be stored in the defect pixel list. Visibility: Beginner
variable MaxZ¶
Description: Displays the maximum depth in meters for the point cloud range. Visibility:
variable MinZ¶
Description: Displays the minimum depth in meters for the point cloud range. Visibility:
variable MultiRoiConfigurationInvalidReason¶
GenApi::IEnumerationT<MultiRoiConfigurationInvalidReasonEnums>& Spinnaker::Camera::MultiRoiConfigurationInvalidReason;
Description: Displays the reason for invalid multiple ROI configuration. Visibility:
variable MultiRoiConfigurationInvalidReasonAll¶
Description: Represents the reason for invalid multiple ROI configuration. Visibility:
variable MultiRoiEnable¶
Description: Controls if the selected Region of interest is enabled. This can only be enabled if the Multiple ROI configuration is valid. Visibility:
variable MultiRoiFeatureEnable¶
Description: Controls whether a Multiple ROI feature is used. Visibility:
variable MultiRoiHeight¶
Description: This reflects the current Region of interest. Visibility:
variable MultiRoiOffsetX¶
Description: Horizontal offset from the origin to the region of interest (in pixels). Visibility:
variable MultiRoiOffsetY¶
Description: Vertical offset from the origin to the region of interest (in pixels). Visibility:
variable MultiRoiSelector¶
Description: Selects the Region of interest to control. The RegionSelector feature allows devices that are able to extract multiple regions out of an image. Visibility:
variable MultiRoiWidth¶
Description: This reflects the current Region of interest. Visibility:
variable MultiRoiWindows¶
Description: This reflects the total number of regions output from sensor. Visibility:
variable NumDirections¶
Description: Visibility:
variable OffsetX¶
Description: Horizontal offset from the origin to the region of interest (in pixels). Visibility: Beginner
variable OffsetY¶
Description: Vertical offset from the origin to the region of interest (in pixels). Visibility: Beginner
variable PacketResendRequestCount¶
Description: Counts the number of resend requests received from the host. Visibility:
variable PacketResendRequestsDroppedCount¶
Description: Counts the number of resend requests that were not processed due to an error condition. Visibility:
variable PauseFrameCount¶
Description: Number of pause frame requests received for the image tranmission interface in the current acquisition session. Visibility:
variable PayloadSize¶
Description: Provides the number of bytes transferred for each image or chunk on the stream channel. Visibility:
variable PixelColorFilter¶
Description: Type of color filter that is applied to the image. Only applies to Bayer pixel formats. All others have no color filter. Visibility:
variable PixelDynamicRangeMax¶
Description: Maximum value that can be returned during the digitization process. This corresponds to the brightest value of the camera. For color cameras, this returns the biggest value that each color component can take. Visibility:
variable PixelDynamicRangeMin¶
Description: Minimum value that can be returned during the digitization process. This corresponds to the darkest value of the camera. For color cameras, this returns the smallest value that each color component can take. Visibility:
variable PixelFormat¶
Description: Format of the pixel provided by the camera. Visibility:
variable PixelFormatAddress¶
Description: The address in the manufacturer-specific register space of the feature with the corresponding name. Visibility: Guru
variable PixelFormatInfoID¶
Description: Returns the value used by the streaming channels to identify the selected pixel format. Visibility: Guru
variable PixelFormatInfoSelector¶
Description: Select the pixel format for which the information will be returned. Visibility: Guru
variable PixelSize¶
Description: Total size in bits of a pixel of the image. Visibility:
variable PowerSupplyCurrent¶
Description: Indicates the output current of the selected power supply (A). Visibility:
variable PowerSupplyVoltage¶
Description: Indicates the current voltage of the selected power supply (V). Visibility:
variable RegionDestination¶
Description: Control the destination of the selected region. Visibility: Expert
variable RegionMode¶
Description: Controls if the selected Region of interest is active and streaming. Visibility: Beginner
variable RegionSelector¶
Description: Selects the Region of interest to control. The RegionSelector feature allows devices that are able to extract multiple regions out of an image, to configure the features of those individual regions independently. Visibility: Beginner
variable ReverseX¶
Description: Horizontally flips the image sent by the device. The region of interest is applied after flipping. For color cameras the bayer pixel format is affected. For example, BayerRG16 changes to BayerGR16. Visibility:
variable ReverseY¶
Description: Vertically flips the image sent by the device. The region of interest is applied after flipping. For color cameras the bayer pixel format is affected. For example, BayerRG16 changes to BayerGB16. Visibility:
variable Revision¶
Description: Revision of the CoaXPress specifciation implemented. Visibility: Beginner
variable RgbTransformLightSource¶
Description: Used to select from a set of RGBtoRGB transform matricies calibrated for different light sources. Selecting a value also sets the white balance ratios (BalanceRatioRed and BalanceRatioBlue), but those can be overwritten through manual or auto white balance. Visibility:
variable Saturation¶
Description: Controls the color saturation. Visibility:
variable SaturationEnable¶
Description: Enables/disables Saturation adjustment. Visibility:
variable Scan3dAxisMax¶
Description: Maximum valid transmitted coordinate value of the selected Axis. Visibility: Expert
variable Scan3dAxisMin¶
Description: Minimum valid transmitted coordinate value of the selected Axis. Visibility: Expert
variable Scan3dBaseline¶
Description: Displays the baseline in meters as the physical distance of two image sensors in the stereo camera. Visibility:
variable Scan3dCoordinateOffset¶
Description: Offset when transforming a pixel from relative coordinates to world coordinates. In terms of disparity computation, it is equivalent to minimum disparity. Visibility:
variable Scan3dCoordinateReferenceSelector¶
GenApi::IEnumerationT<Scan3dCoordinateReferenceSelectorEnums>& Spinnaker::Camera::Scan3dCoordinateReferenceSelector;
Description: Sets the index to read a coordinate system reference value defining the transform of a point from the current (Anchor or Transformed) system to the reference system. Visibility: Expert
variable Scan3dCoordinateReferenceValue¶
Description: Returns the reference value selected. Reads the value of a rotation or translation value for the current (Anchor or Transformed) coordinate system transformation to the Reference system. Visibility: Expert
variable Scan3dCoordinateScale¶
Description: Displays the Scale factor when transforming a pixel from relative coordinates to world coordinates. Visibility:
variable Scan3dCoordinateSelector¶
Description: Selects the individual coordinates in the vectors for 3D information/transformation. Visibility: Expert
variable Scan3dCoordinateSystem¶
Description: Specifies the Coordinate system to use for the device. Visibility: Expert
variable Scan3dCoordinateSystemReference¶
GenApi::IEnumerationT<Scan3dCoordinateSystemReferenceEnums>& Spinnaker::Camera::Scan3dCoordinateSystemReference;
Description: Defines coordinate system reference location. Visibility: Expert
variable Scan3dCoordinateTransformSelector¶
GenApi::IEnumerationT<Scan3dCoordinateTransformSelectorEnums>& Spinnaker::Camera::Scan3dCoordinateTransformSelector;
Description: Sets the index to read/write a coordinate transform value. Visibility: Expert
variable Scan3dDistanceUnit¶
Description: Specifies the unit used when delivering (calibrated) distance data. Visibility: Expert
variable Scan3dFocalLength¶
Description: Displays the focal length of the camera in pixels. Visibility:
variable Scan3dInvalidDataFlag¶
Description: Enables the definition of a non-valid flag value in the data stream. Visibility:
variable Scan3dInvalidDataValue¶
Description: Value which identifies a non-valid pixel if Scan3dInvalidDataFlag is enabled. Visibility:
variable Scan3dOutputMode¶
Description: Controls the Calibration and data organization of the device and the coordinates transmitted. Visibility: Expert
variable Scan3dPrincipalPointU¶
Description: Displays the value of the horizontal position of the principal point, relative to the region origin, i.e. OffsetX . Visibility:
variable Scan3dPrincipalPointV¶
Description: Displays the value of the vertical position of the principal point, relative to the region origin, i.e. OffsetY. Visibility:
variable Scan3dTransformValue¶
Description: Specifies the transform value selected. For translations (Scan3dCoordinateTransformSelector = TranslationX/Y/Z) it is expressed in the distance unit of the system, for rotations (Scan3dCoordinateTransformSelector =RotationX/Y/Z) in degrees. Visibility: Expert
variable SensitivityMatching¶
Description: Sensitivity matching is the factory calibration to match the conversion factor accros all cameras. By disabling this feature the applied gain stage for this feature is disabled, which can also cause some pixels to not reach the maximum pixelvalue. Visibility: Beginner
variable SensorBitDepth¶
Description: Controls the resolution of the Sensor ADC. Visibility: Expert
variable SensorDescription¶
Description: Returns Sensor Description Visibility:
variable SensorDigitizationTaps¶
Description: Number of digitized samples outputted simultaneously by the camera A/D conversion stage. Visibility: Expert
variable SensorHeight¶
Description: Effective height of the sensor in pixels. Visibility:
variable SensorRegisterAddress¶
Description: Visibility: Guru
variable SensorRegisterData¶
Description: Visibility: Guru
variable SensorRegisterNonVolatileListSize¶
Description: Visibility: Guru
variable SensorRegisterNonVolatileReadSelector¶
Description: Visibility: Guru
variable SensorRegisterRead¶
Description: Visibility: Guru
variable SensorRegisterReadWriteMode¶
GenApi::IEnumerationT<SensorRegisterReadWriteModeEnums>& Spinnaker::Camera::SensorRegisterReadWriteMode;
Description: Visibility: Guru
variable SensorRegisterRemove¶
Description: Visibility: Guru
variable SensorRegisterRemoveAll¶
Description: Visibility: Guru
variable SensorRegisterSize¶
Description: Visibility: Guru
variable SensorRegisterWrite¶
Description: Visibility: Guru
variable SensorShutterMode¶
Description: Sets the shutter mode of the device. Visibility:
variable SensorTaps¶
Description: Number of taps of the camera sensor. Visibility: Expert
variable SensorTemperature¶
Description: Returns the temperature of the sensor. Visibility: Beginner
variable SensorTemperatureRaw¶
Description: Returns the temperature of the sensor. Visibility: Invisible
variable SensorWidth¶
Description: Effective width of the sensor in pixels. Visibility:
variable SequencerConfigurationMode¶
GenApi::IEnumerationT<SequencerConfigurationModeEnums>& Spinnaker::Camera::SequencerConfigurationMode;
Description: Controls whether or not a sequencer is in configuration mode. Visibility:
variable SequencerConfigurationReset¶
Description: Resets the sequencer configuration by erasing all saved sequencer sets. Visibility:
variable SequencerConfigurationValid¶
GenApi::IEnumerationT<SequencerConfigurationValidEnums>& Spinnaker::Camera::SequencerConfigurationValid;
Description: Display whether the current sequencer configuration is valid to run. Visibility:
variable SequencerFeatureEnable¶
Description: Enables the selected feature and makes it active in all sequencer sets. Visibility:
variable SequencerMode¶
Description: Controls whether or not a sequencer is active. Visibility:
variable SequencerPathSelector¶
Description: Selects branching path to be used for subsequent settings. Visibility:
variable SequencerSetActive¶
Description: Contains the currently active sequencer set. Visibility: Expert
variable SequencerSetLoad¶
Description: Loads currently selected sequencer to the current device configuration. Visibility:
variable SequencerSetNext¶
Description: Specifies the next sequencer set. Visibility:
variable SequencerSetSave¶
Description: Saves the current device configuration to the currently selected sequencer set. Visibility:
variable SequencerSetSelector¶
Description: Selects the sequencer set to which subsequent settings apply. Visibility:
variable SequencerSetStart¶
Description: Sets the first sequencer set to be used. Visibility:
variable SequencerSetValid¶
Description: Displays whether the currently selected sequencer set's register contents are valid to use. Visibility:
variable SequencerTriggerActivation¶
GenApi::IEnumerationT<SequencerTriggerActivationEnums>& Spinnaker::Camera::SequencerTriggerActivation;
Description: Specifies the activation mode of the sequencer trigger. Visibility:
variable SequencerTriggerSource¶
Description: Specifies the internal signal or physical input line to use as the sequencer trigger source. Visibility:
variable SerialPortBaudRate¶
Description: This feature controls the baud rate used by the selected serial port. Visibility:
variable SerialPortDataBits¶
Description: This feature controls the number of data bits used by the selected serial port. Possible values that can be used are between 5 and 9. Visibility:
variable SerialPortParity¶
Description: This feature controls the parity used by the selected serial port. Visibility:
variable SerialPortSelector¶
Description: Selects which serial port of the device to control. Visibility:
variable SerialPortSource¶
Description: Specifies the physical input Line on which to receive serial data. Visibility:
variable SerialPortStopBits¶
Description: This feature controls the number of stop bits used by the selected serial port. Visibility:
variable SerialReceiveFramingErrorCount¶
Description: Returns the number of framing errors that have occurred on the serial port. Visibility:
variable SerialReceiveParityErrorCount¶
Description: Returns the number of parity errors that have occurred on the serial port. Visibility:
variable SerialReceiveQueueClear¶
Description: This is a command that clears the device serial port receive queue. Visibility:
variable SerialReceiveQueueCurrentCharacterCount¶
Description: Returns the number of characters currently in the serial port receive queue. Visibility:
variable SerialReceiveQueueMaxCharacterCount¶
Description: >Returns the maximum number of characters in the serial port receive queue. Visibility:
variable SerialTransmitQueueCurrentCharacterCount¶
Description: Returns the number of characters currently in the serial port transmit queue. Visibility:
variable SerialTransmitQueueMaxCharacterCount¶
Description: >Returns the maximum number of characters in the serial port transmit queue. Visibility:
variable Sharpening¶
Description: Controls the amount to sharpen a signal. The sharpened amount is proportional to the difference between a pixel and its neighbors. A negative value smooths out the difference, while a positive value amplifies the difference. You can boost by a maximum of 8x, but smoothing is limited to 1x (in float). Default value: 2.0 Visibility:
variable SharpeningAuto¶
Description: Enables/disables the auto sharpening feature. When enabled, the camera automatically determines the sharpening threshold based on the noise level of the camera. Visibility:
variable SharpeningEnable¶
Description: Enables/disables the sharpening feature. Sharpening is disabled by default. Visibility:
variable SharpeningThreshold¶
Description: Controls the minimum intensity gradient change to invoke sharpening. When "Sharpening Auto" is enabled, this is determined automatically by the device. The threshold is specified as a fraction of the total intensity range, and ranges from 0 to 0.25. A threshold higher than 25% produces little to no difference than 25%. High thresholds sharpen only areas with significant intensity changes. Low thresholds sharpen more areas. Visibility:
variable SmallPenalty¶
Description: Displays the penalty when the change of Disparity Change is plus or minus 1. Visibility:
variable SoftwareSignalPulse¶
Description: Generates a pulse signal that can be used as a software trigger. This command can be used to trigger other modules that accept a SoftwareSignal as trigger source. Visibility: Beginner
variable SoftwareSignalSelector¶
Description: Selects which Software Signal features to control. Visibility: Beginner
variable SoftwareUpdateStatus¶
Description: Visibility: Beginner
variable SourceCount¶
Description: Returns the number of sources supported by the device. Visibility:
variable SourceSelector¶
Description: Control for selecting the source of the stream (i.e. Sensor 1 or Sensor 2). Component disparity uses the selected source as master and other source as slave for calcluating disparity. Visibility:
variable Standard¶
Description: Unique Identification of the CoaXPress Standard. Visibility: Beginner
variable StereoHeight¶
Description: Height of the image after stereo processing by the device (in pixels). Visibility:
variable StereoResolution¶
Description: Selects the resolution output of the stereo engine. Stereo resolution can be viewed through Stereo Width and Stereo Height. Visibility:
variable StereoWidth¶
Description: Width of the image after stereo processing by the device (in pixels). Visibility:
variable StreamPacketSizeMax¶
Description: The maximum stream packet data size the Host can accept. The size is defined in bytes, and shall be a multiple of 4 bytes. Visibility: Guru
variable TLParamsLocked¶
Description: Visibility:
variable Test0001¶
Description: For testing only. Visibility:
variable TestErrorCount¶
Description: The error count for the connection ID as selected by TestErrorCountSelector. Visibility: Guru
variable TestErrorCountSelector¶
Description: Select a Device Connection ID for which to use the TestErrorCount feature. Visibility: Guru
variable TestEventGenerate¶
Description: This command generates a test event and sends it to the host. Visibility:
variable TestImageSelector¶
Description: Selects the type of test image that is sent by the camera. Visibility: Expert
variable TestImageVideoLevel¶
Description: Set the video level for the UniformVideoLevel test pattern. Visibility: Expert
variable TestMode¶
Description: Enable test packet transmission from Device to Host. Visibility: Guru
variable TestPacketCountRx¶
Description: The received test packet count for the connection ID as selected by TestErrorCountSelector. Visibility: Guru
variable TestPacketCountTx¶
Description: The transmitted test packet count for the connection ID as selected by TestErrorCountSelector. Visibility: Guru
variable TestPattern¶
Description: Selects the type of test pattern that is generated by the device as image source. Visibility:
variable TestPatternGeneratorSelector¶
GenApi::IEnumerationT<TestPatternGeneratorSelectorEnums>& Spinnaker::Camera::TestPatternGeneratorSelector;
Description: Selects which test pattern generator is controlled by the TestPattern feature. Visibility:
variable TestPendingAck¶
Description: Test PENDING_ACK feature. Visibility:
variable TimerDelay¶
Description: Sets the duration (in microseconds) of the delay to apply at the reception of a trigger before starting the Timer. Visibility: Expert
variable TimerDuration¶
Description: Sets the duration (in microseconds) of the Timer pulse. Visibility: Expert
variable TimerReset¶
Description: Does a software reset of the selected timer and starts it. The timer starts immediately after the reset unless a timer trigger is active. Visibility: Expert
variable TimerSelector¶
Description: Selects which Timer to configure. Visibility: Expert
variable TimerStatus¶
Description: Returns the current status of the Timer. Visibility: Expert
variable TimerTriggerActivation¶
Description: Selects the activation mode of the trigger to start the Timer. Visibility: Expert
variable TimerTriggerSource¶
Description: Selects the source of the trigger to start the Timer. Visibility: Expert
variable TimerValue¶
Description: Reads or writes the current value (in microseconds) of the selected Timer. Visibility: Expert
variable Timestamp¶
Description: Reports the current value of the device timestamp counter. Visibility: Expert
variable TimestampIncrement¶
Description: Indicates the timestamp increment in ns/tick. Visibility:
variable TimestampLatch¶
Description: Latches the current timestamp counter into TimestampLatchValue. Visibility:
variable TimestampLatchValue¶
Description: Returns the latched value of the timestamp counter. Visibility:
variable TimestampReset¶
Description: Resets the current value of the device timestamp counter. Visibility:
variable TotalDisparity¶
Description: Displays the search range for the stereo algorithm. Visibility:
variable TransferAbort¶
Description: Aborts immediately the streaming of data block(s). Aborting the transfer will result in the lost of the data that is present or currently entering in the block queue. However, the next new block received will be stored in the queue and transferred to the host when the streaming is restarted. If implemented, this feature should be available when the TransferControlMode is set to "UserControlled". Visibility: Expert
variable TransferBlockCount¶
Description: Specifies the number of data blocks (images) that the device should stream before stopping. This feature is only active if the Transfer Operation Mode is set to Multi Block. Visibility:
variable TransferBurstCount¶
Description: Number of Block(s) to transfer for each TransferBurstStart trigger. Visibility: Expert
variable TransferComponentSelector¶
GenApi::IEnumerationT<TransferComponentSelectorEnums>& Spinnaker::Camera::TransferComponentSelector;
Description: Selects the color component for the control of the TransferStreamChannel feature. Visibility: Guru
variable TransferControlMode¶
Description: Selects the control method for the transfers. Basic and Automatic start transmitting data as soon as there is enough data to fill a link layer packet. User Controlled allows you to directly control the transfer of blocks. Visibility:
variable TransferOperationMode¶
Description: Selects the operation mode of the transfer. Continuous is similar to Basic/Automatic but you can start/stop the transfer while acquisition runs independently. Multi Block transmits a specified number of blocks and then stops. Visibility:
variable TransferPause¶
Description: Pauses the streaming of data Block(s). Pausing the streaming will immediately suspend the ongoing data transfer even if a block is partially transfered. The device will resume its transmission at the reception of a TransferResume command. Visibility: Guru
variable TransferQueueCurrentBlockCount¶
Description: Returns number of data blocks (images) currently in the transfer queue. Visibility:
variable TransferQueueMaxBlockCount¶
Description: Returns the maximum number of data blocks (images) in the transfer queue Visibility:
variable TransferQueueMode¶
Description: Specifies the operation mode of the transfer queue. Visibility:
variable TransferQueueOverflowCount¶
Description: Returns number of images that have been lost before being transmitted because the transmit queue hasn't been cleared fast enough. Visibility:
variable TransferResume¶
Description: Resumes a data Blocks streaming that was previously paused by a TransferPause command. Visibility: Guru
variable TransferSelector¶
Description: Selects which stream transfers are currently controlled by the selected Transfer features. Visibility: Expert
variable TransferStart¶
Description: Starts the streaming of data blocks (images) out of the device. This feature is available when the Transfer Control Mode is set to User Controlled. Visibility:
variable TransferStatus¶
Description: Reads the status of the Transfer module signal selected by TransferStatusSelector. Visibility: Guru
variable TransferStatusSelector¶
Description: Selects which status of the transfer module to read. Visibility: Guru
variable TransferStop¶
Description: Stops the streaming of data block (images). The current block transmission is completed. This feature is available when the Transfer Control Mode is set to User Controlled. Visibility:
variable TransferStreamChannel¶
Description: Selects the streaming channel that will be used to transfer the selected stream of data. In general, this feature can be omitted and the default streaming channel will be used. Visibility: Guru
variable TransferTriggerActivation¶
GenApi::IEnumerationT<TransferTriggerActivationEnums>& Spinnaker::Camera::TransferTriggerActivation;
Description: Specifies the activation mode of the transfer control trigger. Visibility: Guru
variable TransferTriggerMode¶
Description: Controls if the selected trigger is active. Visibility: Guru
variable TransferTriggerSelector¶
Description: Selects the type of transfer trigger to configure. Visibility: Guru
variable TransferTriggerSource¶
Description: Specifies the signal to use as the trigger source for transfers. Visibility: Guru
variable TransmissionDelay¶
Description: Delay in us from image acquisition to image transmission. Visibility:
variable TransmissionDelayAverage¶
Description: Average delay in us from image acquisition to image transmission. Visibility:
variable TransmissionDelayMax¶
Description: Maximum delay in us from image acquisition to image transmission in the current acquisition session. Visibility:
variable TriggerActivation¶
Description: Specifies the activation mode of the trigger. Visibility:
variable TriggerDeglitch¶
Description: Specify the value for trigger deglitching Visibility: Beginner
variable TriggerDelay¶
Description: Specifies the delay in microseconds (µs) to apply after the trigger reception before activating it. Visibility:
variable TriggerDivider¶
Description: Specifies a division factor for the incoming trigger pulses. Visibility: Expert
variable TriggerEventTest¶
Description: This command generates a test event and sends it to the host. Visibility:
variable TriggerMode¶
Description: Controls whether or not trigger is active. Visibility:
variable TriggerMultiplier¶
Description: Specifies a multiplication factor for the incoming trigger pulses. It is used generally used in conjunction with TriggerDivider to control the ratio of triggers that are accepted. Visibility: Expert
variable TriggerOverlap¶
Description: Specifies the overlap mode of the trigger. Visibility:
variable TriggerSelector¶
Description: Selects the type of trigger to configure. Visibility:
variable TriggerSoftware¶
Description: Generates an internal trigger if Trigger Source is set to Software. Visibility:
variable TriggerSource¶
Description: Specifies the internal signal or physical input line to use as the trigger source. Visibility:
variable U3VAccessPrivilege¶
Description: Access Privilege. Visibility:
variable U3VCPCapability¶
Description: Indicates additional features on the control channel. Visibility:
variable U3VCPEIRMAvailable¶
Description: Set if the device supports at least one device event interface. Visibility:
variable U3VCPIIDC2Available¶
Description: Set if the device supports IIDC2 register map. Visibility:
variable U3VCPSIRMAvailable¶
Description: Set if the device supports at least one device streaming interface. Visibility:
variable U3VCurrentSpeed¶
Description: Specifies the current speed of the USB link. Visibility:
variable U3VMaxAcknowledgeTransferLength¶
Description: Specifies the max suuported ack transfer length of the device. Visibility:
variable U3VMaxCommandTransferLength¶
Description: Specifies the max suuported command transfer length of the device. Visibility:
variable U3VMaxDeviceResponseTime¶
Description: Max Resonse Time in ms. Visibility:
variable U3VMessageChannelID¶
Description: Channel ID Used For The Message Channel. Visibility:
variable U3VNumberOfStreamChannels¶
Description: Number of Stream Channels and its Corresponding Streaming Interface Register Maps. Visibility:
variable U3VVersionMajor¶
Description: U3V Version. Visibility:
variable U3VVersionMinor¶
Description: U3V Version. Visibility:
variable UniquenessRatio¶
Description: Displays the difference between the best matching disparity and the second-best matching disparity. Visibility:
variable UserMode¶
Description: Visibility: Guru
variable UserModeUpdate¶
Description: Visibility: Guru
variable UserOutputSelector¶
Description: Selects which bit of the User Output register is set by UserOutputValue. Visibility:
variable UserOutputValue¶
Description: Value of the selected user output, either logic high (enabled) or logic low (disabled). Visibility:
variable UserOutputValueAll¶
Description: Returns the current status of all the user output status bits in a hexadecimal representation (UserOutput 0 status corresponds to bit 0, UserOutput 1 status with bit 1, etc). This allows simultaneous reading of all user output statuses at once. Visibility:
variable UserOutputValueAllMask¶
Description: Sets the write mask to apply to the value specified by UserOutputValueAll before writing it in the User Output register. If the UserOutputValueAllMask feature is present, setting the user Output register using UserOutputValueAll will only change the bits that have a corresponding bit in the mask set to one. Visibility: Expert
variable UserSetDefault¶
Description: Selects the feature User Set to load and make active by default when the device is reset. Visibility: Beginner
variable UserSetFeatureEnable¶
Description: Whether or not the selected feature is saved to user sets. Visibility:
variable UserSetIsLocked¶
Description: Indicates if the current UserSet can be configured by the user. Visibility: Beginner
variable UserSetLoad¶
Description: Loads the User Set specified by UserSetSelector to the device and makes it active. Visibility:
variable UserSetLock¶
Description: Lock or Unlock the current UserSet. Visibility: Guru
variable UserSetRestoreCurrentSet¶
Description: Restore the current UserSet to the Default UserSet. Visibility: Beginner
variable UserSetSave¶
Description: Saves the User Set specified by UserSetSelector to the non-volatile memory of the device. Visibility:
variable UserSetSelector¶
Description: Selects the feature User Set to load, save or configure. Visibility:
variable V3_3Enable¶
Description: Internally generated 3.3V rail. Enable to supply external circuits with power. This is different than standard logic outputs in that it is comparatively slow to switch but can supply a more significant amount of power. This is only available on some pins. Visibility:
variable WhiteBalanceCalibrate¶
Description: Starts the white balance calibration in the white balance region of interest. All write requests and commands are ignored until WriteParamsLockedhas become idle (0) Visibility: Beginner
variable WhiteBalanceHeight¶
Description: Height of the white balance region of interest (in pixels). Visibility: Expert
variable WhiteBalanceOffsetX¶
Description: Horizontal offset from the output image region of interest to the white balance region of interest (in pixels). Visibility: Expert
variable WhiteBalanceOffsetY¶
Description: Vertical offset from the output image region of interest to the white balance region of interest (in pixels). Visibility: Expert
variable WhiteBalanceStatus¶
Description: Returns the white balance status of the camera. The status is only final when WriteParamsLocked has become idle (0) Visibility: Expert
variable WhiteBalanceStatusProgress¶
Description: Shows the progress of the calibration operation as percentage done Visibility: Expert
variable WhiteBalanceWidth¶
Description: Width of the white balance region of interest (in pixels). Visibility: Expert
variable WhiteClip¶
Description: Controls the maximal intensity taken by the video signal before being clipped as an absolute physical value. The video signal will never exceed the white clipping point: it will saturate at that level. Visibility: Expert
variable WhiteClipSelector¶
Description: Selects which White Clip to control. Visibility: Expert
variable Width¶
Description: Width of the image provided by the device (in pixels). Visibility: Beginner
variable WidthAddress¶
Description: The address in the manufacturer-specific register space of the feature with the corresponding name. Visibility: Guru
variable WidthMax¶
Description: Maximum width of the image (in pixels). The dimension is calculated after horizontal binning. WidthMax does not take into account the current Region of interest (Width or OffsetX). Visibility:
variable WindowSizeH¶
Description: Visibility:
variable WindowSizeW¶
Description: Visibility:
variable WriteParamsLocked¶
Status can be polled but commands and writable parameters are locked for the duration of the background task Visibility: Beginner
variable XmlManifestSelector¶
Description: Selects the XML manifest entry. Visibility: Guru
variable XmlManifestSize¶
Description: The number of XML manifests available. Visibility: Guru
variable XmlSchemeVersion¶
Description: The scheme version of the XML file referenced by the XmlManifestSelector. Visibility: Guru
variable XmlUrlAddress¶
Description: The start of the URL string referenced by the XmlManifestSelector. Visibility: Guru
variable XmlVersion¶
Description: The version of the XML file referenced by the XmlManifestSelector. Visibility: Guru
variable aPAUSEMACCtrlFramesReceived¶
Description: Reports the number of received PAUSE frames. Visibility: Guru
variable aPAUSEMACCtrlFramesTransmitted¶
Description: Reports the number of transmitted PAUSE frames. Visibility: Guru
Public Functions Documentation¶
function Init¶
Implements Spinnaker::ICameraBase::Init
function ~Camera¶
Protected Functions Documentation¶
function Camera [1/2]¶
The documentation for this class was generated from the following file C:/workspace/include/Camera.h