Spinnaker SDK C++
4.2.0.21
 
 

 
Loading...
Searching...
No Matches
Spinnaker Definitions

Definitions file for Spinnaker. More...

Classes

struct  PNGOption
 Options for saving PNG images. More...
 
struct  PPMOption
 Options for saving PPM images. More...
 
struct  PGMOption
 Options for saving PGM images. More...
 
struct  TIFFOption
 Options for saving TIFF images. More...
 
struct  JPEGOption
 Options for saving JPEG image. More...
 
struct  JPG2Option
 Options for saving JPEG2000 image. More...
 
struct  BMPOption
 Options for saving Bitmap image. More...
 
struct  SIOption
 Options for saving Spinnaker image. More...
 
struct  LibraryVersion
 Provides easier access to the current version of Spinnaker. More...
 
struct  ActionCommandResult
 Action Command Result. More...
 
struct  CCMSettings
 
struct  DeviceEventInferenceData
 Data fields for Device Event payload for EventInference. More...
 
struct  DeviceEventExposureEndData
 Data Fields for Device Event payload for EventExposureEnd. More...
 
struct  ImagePixel
 Image Pixel Structure. More...
 
struct  Stereo3DPoint
 3D Point Structure More...
 
struct  PointCloudParameters
 
struct  StereoCameraParameters
 

Variables

const uint64_t EVENT_TIMEOUT_NONE = 0
 Timeout values for getting next image, device, or interface event.
 
const uint64_t EVENT_TIMEOUT_INFINITE = 0xFFFFFFFFFFFFFFFF
 

Spinnaker Enum Definitions

enum  Error {
  SPINNAKER_ERR_SUCCESS = 0 , SPINNAKER_ERR_ERROR = -1001 , SPINNAKER_ERR_NOT_INITIALIZED = -1002 , SPINNAKER_ERR_NOT_IMPLEMENTED = -1003 ,
  SPINNAKER_ERR_RESOURCE_IN_USE = -1004 , SPINNAKER_ERR_ACCESS_DENIED = -1005 , SPINNAKER_ERR_INVALID_HANDLE = -1006 , SPINNAKER_ERR_INVALID_ID = -1007 ,
  SPINNAKER_ERR_NO_DATA = -1008 , SPINNAKER_ERR_INVALID_PARAMETER = -1009 , SPINNAKER_ERR_IO = -1010 , SPINNAKER_ERR_TIMEOUT = -1011 ,
  SPINNAKER_ERR_ABORT = -1012 , SPINNAKER_ERR_INVALID_BUFFER = -1013 , SPINNAKER_ERR_NOT_AVAILABLE = -1014 , SPINNAKER_ERR_INVALID_ADDRESS = -1015 ,
  SPINNAKER_ERR_BUFFER_TOO_SMALL = -1016 , SPINNAKER_ERR_INVALID_INDEX = -1017 , SPINNAKER_ERR_PARSING_CHUNK_DATA = -1018 , SPINNAKER_ERR_INVALID_VALUE = -1019 ,
  SPINNAKER_ERR_RESOURCE_EXHAUSTED = -1020 , SPINNAKER_ERR_OUT_OF_MEMORY = -1021 , SPINNAKER_ERR_BUSY = -1022 , SPINNAKER_ERR_IP_CONFLICT = -1023 ,
  SPINNAKER_ERR_GENICAM_INVALID_ARGUMENT = -2001 , SPINNAKER_ERR_GENICAM_OUT_OF_RANGE = -2002 , SPINNAKER_ERR_GENICAM_PROPERTY = -2003 , SPINNAKER_ERR_GENICAM_RUN_TIME = -2004 ,
  SPINNAKER_ERR_GENICAM_LOGICAL = -2005 , SPINNAKER_ERR_GENICAM_ACCESS = -2006 , SPINNAKER_ERR_GENICAM_TIMEOUT = -2007 , SPINNAKER_ERR_GENICAM_DYNAMIC_CAST = -2008 ,
  SPINNAKER_ERR_GENICAM_GENERIC = -2009 , SPINNAKER_ERR_GENICAM_BAD_ALLOCATION = -2010 , SPINNAKER_ERR_IM_CONVERT = -3001 , SPINNAKER_ERR_IM_COPY = -3002 ,
  SPINNAKER_ERR_IM_MALLOC = -3003 , SPINNAKER_ERR_IM_NOT_SUPPORTED = -3004 , SPINNAKER_ERR_IM_HISTOGRAM_RANGE = -3005 , SPINNAKER_ERR_IM_HISTOGRAM_MEAN = -3006 ,
  SPINNAKER_ERR_IM_MIN_MAX = -3007 , SPINNAKER_ERR_IM_COLOR_CONVERSION = -3008 , SPINNAKER_ERR_IM_DECOMPRESSION = -3009 , SPINNAKER_ERR_GPU_DECOMPRESSION = -3010 ,
  SPINNAKER_ERR_GPU_NOT_SUPPORTED = -3011 , SPINNAKER_ERR_STEREO_INVALID_PIXEL_FORMAT = -3100 , SPINNAKER_ERR_STEREO_RESOLUTION_MISMATCH = -3101 , SPINNAKER_ERR_STEREO_INVALID_FILENAME = -3102 ,
  SPINNAKER_ERR_STEREO_INVALID_PLY_FILE = -3103 , SPINNAKER_ERR_STEREO_MALLOC = -3104 , SPINNAKER_ERR_STEREO_SPECKLE_FILTER = -3104 , SPINNAKER_ERR_CUSTOM_ID = -10000
}
 The error codes used in Spinnaker. More...
 
enum  EventType {
  SPINNAKER_EVENT_ARRIVAL_REMOVAL , SPINNAKER_EVENT_DEVICE , SPINNAKER_EVENT_DEVICE_SPECIFIC , SPINNAKER_EVENT_NEW_BUFFER ,
  SPINNAKER_EVENT_NEW_BUFFER_LIST , SPINNAKER_EVENT_LOGGING_EVENT , SPINNAKER_EVENT_INTERFACE_ARRIVAL_REMOVAL , SPINNAKER_EVENT_UNKNOWN
}
 Event types in Spinnaker. More...
 
enum  TLPixelFormatNamespace {
  SPINNAKER_TLPIXELFORMAT_NAMESPACE_UNKNOWN = 0 , SPINNAKER_TLPIXELFORMAT_NAMESPACE_GEV = 1 , SPINNAKER_TLPIXELFORMAT_NAMESPACE_IIDC = 2 , SPINNAKER_TLPIXELFORMAT_NAMESPACE_PFNC_16BIT = 3 ,
  SPINNAKER_TLPIXELFORMAT_NAMESPACE_PFNC_32BIT = 4 , SPINNAKER_TLPIXELFORMAT_NAMESPACE_CUSTOM_ID = 1000
}
 This enum represents the namespace in which the TL specific pixel format resides. More...
 
enum  ColorProcessingAlgorithm {
  SPINNAKER_COLOR_PROCESSING_ALGORITHM_NONE , SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR , SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR_AVG , SPINNAKER_COLOR_PROCESSING_ALGORITHM_BILINEAR ,
  SPINNAKER_COLOR_PROCESSING_ALGORITHM_EDGE_SENSING , SPINNAKER_COLOR_PROCESSING_ALGORITHM_HQ_LINEAR , SPINNAKER_COLOR_PROCESSING_ALGORITHM_IPP , SPINNAKER_COLOR_PROCESSING_ALGORITHM_DIRECTIONAL_FILTER ,
  SPINNAKER_COLOR_PROCESSING_ALGORITHM_RIGOROUS , SPINNAKER_COLOR_PROCESSING_ALGORITHM_WEIGHTED_DIRECTIONAL_FILTER
}
 Color processing algorithms. More...
 
enum  ImageFileFormat {
  SPINNAKER_IMAGE_FILE_FORMAT_FROM_FILE_EXT = -1 , SPINNAKER_IMAGE_FILE_FORMAT_PGM , SPINNAKER_IMAGE_FILE_FORMAT_PPM , SPINNAKER_IMAGE_FILE_FORMAT_BMP ,
  SPINNAKER_IMAGE_FILE_FORMAT_JPEG , SPINNAKER_IMAGE_FILE_FORMAT_JPEG2000 , SPINNAKER_IMAGE_FILE_FORMAT_TIFF , SPINNAKER_IMAGE_FILE_FORMAT_PNG ,
  SPINNAKER_IMAGE_FILE_FORMAT_RAW , SPINNAKER_IMAGE_FILE_FORMAT_JPEG12_C , SPINNAKER_IMAGE_FILE_FORMAT_FORCE_32BITS = 0x7FFFFFFF
}
 File formats to be used for saving images to disk. More...
 
enum  ImageStatus {
  SPINNAKER_IMAGE_STATUS_UNKNOWN_ERROR = -1 , SPINNAKER_IMAGE_STATUS_NO_ERROR , SPINNAKER_IMAGE_STATUS_CRC_CHECK_FAILED = 1 , SPINNAKER_IMAGE_STATUS_DATA_OVERFLOW = 2 ,
  SPINNAKER_IMAGE_STATUS_MISSING_PACKETS , SPINNAKER_IMAGE_STATUS_LEADER_BUFFER_SIZE_INCONSISTENT , SPINNAKER_IMAGE_STATUS_TRAILER_BUFFER_SIZE_INCONSISTENT , SPINNAKER_IMAGE_STATUS_PACKETID_INCONSISTENT ,
  SPINNAKER_IMAGE_STATUS_MISSING_LEADER , SPINNAKER_IMAGE_STATUS_MISSING_TRAILER , SPINNAKER_IMAGE_STATUS_DATA_INCOMPLETE = 9 , SPINNAKER_IMAGE_STATUS_INFO_INCONSISTENT ,
  SPINNAKER_IMAGE_STATUS_CHUNK_DATA_INVALID = 11 , SPINNAKER_IMAGE_STATUS_NO_SYSTEM_RESOURCES = 12
}
 Status of images returned from GetNextImage() or Convert() calls. More...
 
enum  StatisticsChannel {
  SPINNAKER_STATISTICS_CHANNEL_GREY , SPINNAKER_STATISTICS_CHANNEL_RED , SPINNAKER_STATISTICS_CHANNEL_GREEN , SPINNAKER_STATISTICS_CHANNEL_BLUE ,
  SPINNAKER_STATISTICS_CHANNEL_HUE , SPINNAKER_STATISTICS_CHANNEL_SATURATION , SPINNAKER_STATISTICS_CHANNEL_LIGHTNESS , SPINNAKER_STATISTICS_CHANNEL_NUM_CHANNELS
}
 Channels that allow statistics to be calculated. More...
 
enum  SpinnakerLogLevel {
  SPINNAKER_LOG_LEVEL_OFF = -1 , SPINNAKER_LOG_LEVEL_FATAL = 0 , SPINNAKER_LOG_LEVEL_ALERT = 100 , SPINNAKER_LOG_LEVEL_CRIT = 200 ,
  SPINNAKER_LOG_LEVEL_ERROR = 300 , SPINNAKER_LOG_LEVEL_WARN = 400 , SPINNAKER_LOG_LEVEL_NOTICE , SPINNAKER_LOG_LEVEL_INFO = 600 ,
  SPINNAKER_LOG_LEVEL_DEBUG = 700 , SPINNAKER_LOG_LEVEL_NOTSET = 800
}
 Log levels. More...
 
enum  ImagePayloadType {
  SPINNAKER_IMAGE_PAYLOAD_TYPE_UNKNOWN = -1 , SPINNAKER_IMAGE_PAYLOAD_TYPE_IMAGE , SPINNAKER_IMAGE_PAYLOAD_TYPE_EXTENDED_CHUNK , SPINNAKER_IMAGE_PAYLOAD_TYPE_JPEG ,
  SPINNAKER_IMAGE_PAYLOAD_TYPE_LOSSLESS_COMPRESSED , SPINNAKER_IMAGE_PAYLOAD_TYPE_LOSSY_COMPRESSED , SPINNAKER_IMAGE_PAYLOAD_TYPE_JPEG_LOSSLESS_COMPRESSED , SPINNAKER_IMAGE_PAYLOAD_TYPE_RAW_SENSOR1 ,
  SPINNAKER_IMAGE_PAYLOAD_TYPE_RAW_SENSOR2 , SPINNAKER_IMAGE_PAYLOAD_TYPE_RECTIFIED_SENSOR1 , SPINNAKER_IMAGE_PAYLOAD_TYPE_RECTIFIED_SENSOR2 , SPINNAKER_IMAGE_PAYLOAD_TYPE_DISPARITY_SENSOR1
}
 
enum  TLPayloadType {
  SPINNAKER_TLPAYLOAD_TYPE_UNKNOWN = 0 , SPINNAKER_TLPAYLOAD_TYPE_IMAGE = 1 , SPINNAKER_TLPAYLOAD_TYPE_RAW_DATA = 2 , SPINNAKER_TLPAYLOAD_TYPE_FILE = 3 ,
  SPINNAKER_TLPAYLOAD_TYPE_CHUNK_DATA = 4 , SPINNAKER_TLPAYLOAD_TYPE_JPEG = 5 , SPINNAKER_TLPAYLOAD_TYPE_JPEG2000 = 6 , SPINNAKER_TLPAYLOAD_TYPE_H264 = 7 ,
  SPINNAKER_TLPAYLOAD_TYPE_CHUNK_ONLY = 8 , SPINNAKER_TLPAYLOAD_TYPE_DEVICE_SPECIFIC = 9 , SPINNAKER_TLPAYLOAD_TYPE_MULTI_PART = 10 , SPINNAKER_TLPAYLOAD_TYPE_CUSTOM_ID = 1000 ,
  SPINNAKER_TLPAYLOAD_TYPE_LOSSLESS_COMPRESSED = SPINNAKER_TLPAYLOAD_TYPE_CUSTOM_ID + 1 , SPINNAKER_TLPAYLOAD_TYPE_LOSSY_COMPRESSED = SPINNAKER_TLPAYLOAD_TYPE_CUSTOM_ID + 2 , SPINNAKER_TLPAYLOAD_TYPE_JPEG_LOSSLESS_COMPRESSED = SPINNAKER_TLPAYLOAD_TYPE_CUSTOM_ID + 3
}
 
enum  ActionCommandStatus {
  SPINNAKER_ACTION_COMMAND_STATUS_OK = 0 , SPINNAKER_ACTION_COMMAND_STATUS_NO_REF_TIME , SPINNAKER_ACTION_COMMAND_STATUS_OVERFLOW = 0x8015 , SPINNAKER_ACTION_COMMAND_STATUS_ACTION_LATE ,
  SPINNAKER_ACTION_COMMAND_STATUS_ERROR
}
 Possible Status Codes Returned from Action Command. More...
 
enum  TIFFCompressionMethod {
  SPINNAKER_TIFF_COMPRESS_METHOD_NONE = 1 , SPINNAKER_TIFF_COMPRESS_METHOD_PACKBITS , SPINNAKER_TIFF_COMPRESS_METHOD_DEFLATE , SPINNAKER_TIFF_COMPRESS_METHOD_ADOBE_DEFLATE ,
  SPINNAKER_TIFF_COMPRESS_METHOD_CCITTFAX3 , SPINNAKER_TIFF_COMPRESS_METHOD_CCITTFAX4 , SPINNAKER_TIFF_COMPRESS_METHOD_LZW , SPINNAKER_TIFF_COMPRESS_METHOD_JPEG
}
 Compression method to use for encoding TIFF images. More...
 
enum  PixelFormatIntType {
  SPINNAKER_INT_TYPE_UINT8 , SPINNAKER_INT_TYPE_INT8 , SPINNAKER_INT_TYPE_UINT10 , SPINNAKER_INT_TYPE_UINT10p ,
  SPINNAKER_INT_TYPE_UINT10P , SPINNAKER_INT_TYPE_UINT12 , SPINNAKER_INT_TYPE_UINT12p , SPINNAKER_INT_TYPE_UINT12P ,
  SPINNAKER_INT_TYPE_UINT14 , SPINNAKER_INT_TYPE_UINT16 , SPINNAKER_INT_TYPE_INT16 , SPINNAKER_INT_TYPE_FLOAT32 ,
  SPINNAKER_INT_TYPE_UNKNOWN
}
 Possible integer types and packing used in a pixel format. More...
 
enum  BufferOwnership { SPINNAKER_BUFFER_OWNERSHIP_SYSTEM , SPINNAKER_BUFFER_OWNERSHIP_USER }
 
enum  ImageScalingAlgorithm { SPINNAKER_IMAGE_SCALING_ALGORITHM_NEAREST_NEIGHBOR }
 Image scaling algorithms. More...
 
enum  SourceDataRange { SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE , SPINNAKER_SOURCE_DATA_RANGE_ABSOLUTE_DATA_RANGE , SPINNAKER_SOURCE_DATA_RANGE_IMAGE_MIN_ABSOLUTE_MAX , SPINNAKER_SOURCE_DATA_RANGE_ABSOLUTE_MIN_IMAGE_MAX }
 Image normalization source data options. More...
 
enum  HeatmapColor {
  SPINNAKER_HEATMAP_COLOR_BLACK = 1 , SPINNAKER_HEATMAP_COLOR_BLUE = 2 , SPINNAKER_HEATMAP_COLOR_CYAN = 3 , SPINNAKER_HEATMAP_COLOR_GREEN = 4 ,
  SPINNAKER_HEATMAP_COLOR_YELLOW = 5 , SPINNAKER_HEATMAP_COLOR_RED = 6 , SPINNAKER_HEATMAP_COLOR_WHITE = 7
}
 Color specifiers for the heatmap color gradient. More...
 
enum  PolarizationQuadrant { SPINNAKER_POLARIZATION_QUADRANT_I0 , SPINNAKER_POLARIZATION_QUADRANT_I45 , SPINNAKER_POLARIZATION_QUADRANT_I90 , SPINNAKER_POLARIZATION_QUADRANT_I135 }
 Polarization quadrant specifiers describing the four orientations of linear polarizing filters on polarized cameras. More...
 
enum  CCMColorTemperature {
  SPINNAKER_CCM_COLOR_TEMP_INCANDESCENT_2765K , SPINNAKER_CCM_COLOR_TEMP_TUNGSTEN_2800K , SPINNAKER_CCM_COLOR_TEMP_WARM_FLUORESCENT_3000K , SPINNAKER_CCM_COLOR_TEMP_HALOGEN_3188K ,
  SPINNAKER_CCM_COLOR_TEMP_COOL_FLUORESCENT_4000K , SPINNAKER_CCM_COLOR_TEMP_LED_4649K , SPINNAKER_CCM_COLOR_TEMP_LED_H_AND_E_4649K , SPINNAKER_CCM_COLOR_TEMP_FLUORESCENT_4665K ,
  SPINNAKER_CCM_COLOR_TEMP_SUNNY_5000K , SPINNAKER_CCM_COLOR_TEMP_DAYLIGHT_5034K , SPINNAKER_CCM_COLOR_TEMP_DAYLIGHT_H_AND_E_5034K , SPINNAKER_CCM_COLOR_TEMP_CLOUDY_6500K ,
  SPINNAKER_CCM_COLOR_TEMP_SHADE_8000K , SPINNAKER_CCM_COLOR_TEMP_GENERAL
}
 
enum  CCMType { SPINNAKER_CCM_TYPE_LINEAR , SPINNAKER_CCM_TYPE_ADVANCED }
 
enum  CCMSensor {
  SPINNAKER_CCM_SENSOR_IMX226 , SPINNAKER_CCM_SENSOR_IMX249 , SPINNAKER_CCM_SENSOR_IMX250 , SPINNAKER_CCM_SENSOR_IMX252 ,
  SPINNAKER_CCM_SENSOR_IMX253 , SPINNAKER_CCM_SENSOR_IMX255 , SPINNAKER_CCM_SENSOR_IMX264 , SPINNAKER_CCM_SENSOR_IMX265 ,
  SPINNAKER_CCM_SENSOR_IMX267 , SPINNAKER_CCM_SENSOR_IMX273 , SPINNAKER_CCM_SENSOR_IMX287 , SPINNAKER_CCM_SENSOR_IMX296 ,
  SPINNAKER_CCM_SENSOR_IMX297 , SPINNAKER_CCM_SENSOR_IMX304 , SPINNAKER_CCM_SENSOR_IMX327 , SPINNAKER_CCM_SENSOR_IMX334 ,
  SPINNAKER_CCM_SENSOR_IMX342 , SPINNAKER_CCM_SENSOR_IMX367 , SPINNAKER_CCM_SENSOR_IMX387 , SPINNAKER_CCM_SENSOR_IMX392 ,
  SPINNAKER_CCM_SENSOR_IMX420 , SPINNAKER_CCM_SENSOR_IMX421 , SPINNAKER_CCM_SENSOR_IMX422 , SPINNAKER_CCM_SENSOR_IMX425 ,
  SPINNAKER_CCM_SENSOR_IMX428 , SPINNAKER_CCM_SENSOR_IMX429 , SPINNAKER_CCM_SENSOR_IMX430
}
 
enum  CCMColorSpace { SPINNAKER_CCM_COLOR_SPACE_OFF , SPINNAKER_CCM_COLOR_SPACE_SRGB }
 
enum  CCMApplication { SPINNAKER_CCM_APPLICATION_GENERIC , SPINNAKER_CCM_APPLICATION_MICROSCOPY }
 

Detailed Description

Definitions file for Spinnaker.

Enumeration Type Documentation

◆ ActionCommandStatus

Possible Status Codes Returned from Action Command.

Enumerator
SPINNAKER_ACTION_COMMAND_STATUS_OK 
SPINNAKER_ACTION_COMMAND_STATUS_NO_REF_TIME 
SPINNAKER_ACTION_COMMAND_STATUS_OVERFLOW 
SPINNAKER_ACTION_COMMAND_STATUS_ACTION_LATE 
SPINNAKER_ACTION_COMMAND_STATUS_ERROR 

◆ BufferOwnership

Enumerator
SPINNAKER_BUFFER_OWNERSHIP_SYSTEM 
SPINNAKER_BUFFER_OWNERSHIP_USER 

◆ CCMApplication

Enumerator
SPINNAKER_CCM_APPLICATION_GENERIC 
SPINNAKER_CCM_APPLICATION_MICROSCOPY 

◆ CCMColorSpace

Enumerator
SPINNAKER_CCM_COLOR_SPACE_OFF 
SPINNAKER_CCM_COLOR_SPACE_SRGB 

◆ CCMColorTemperature

Enumerator
SPINNAKER_CCM_COLOR_TEMP_INCANDESCENT_2765K 
SPINNAKER_CCM_COLOR_TEMP_TUNGSTEN_2800K 
SPINNAKER_CCM_COLOR_TEMP_WARM_FLUORESCENT_3000K 
SPINNAKER_CCM_COLOR_TEMP_HALOGEN_3188K 
SPINNAKER_CCM_COLOR_TEMP_COOL_FLUORESCENT_4000K 
SPINNAKER_CCM_COLOR_TEMP_LED_4649K 
SPINNAKER_CCM_COLOR_TEMP_LED_H_AND_E_4649K 
SPINNAKER_CCM_COLOR_TEMP_FLUORESCENT_4665K 
SPINNAKER_CCM_COLOR_TEMP_SUNNY_5000K 
SPINNAKER_CCM_COLOR_TEMP_DAYLIGHT_5034K 
SPINNAKER_CCM_COLOR_TEMP_DAYLIGHT_H_AND_E_5034K 
SPINNAKER_CCM_COLOR_TEMP_CLOUDY_6500K 
SPINNAKER_CCM_COLOR_TEMP_SHADE_8000K 
SPINNAKER_CCM_COLOR_TEMP_GENERAL 

◆ CCMSensor

enum CCMSensor
Enumerator
SPINNAKER_CCM_SENSOR_IMX226 
SPINNAKER_CCM_SENSOR_IMX249 
SPINNAKER_CCM_SENSOR_IMX250 
SPINNAKER_CCM_SENSOR_IMX252 
SPINNAKER_CCM_SENSOR_IMX253 
SPINNAKER_CCM_SENSOR_IMX255 
SPINNAKER_CCM_SENSOR_IMX264 
SPINNAKER_CCM_SENSOR_IMX265 
SPINNAKER_CCM_SENSOR_IMX267 
SPINNAKER_CCM_SENSOR_IMX273 
SPINNAKER_CCM_SENSOR_IMX287 
SPINNAKER_CCM_SENSOR_IMX296 
SPINNAKER_CCM_SENSOR_IMX297 
SPINNAKER_CCM_SENSOR_IMX304 
SPINNAKER_CCM_SENSOR_IMX327 
SPINNAKER_CCM_SENSOR_IMX334 
SPINNAKER_CCM_SENSOR_IMX342 
SPINNAKER_CCM_SENSOR_IMX367 
SPINNAKER_CCM_SENSOR_IMX387 
SPINNAKER_CCM_SENSOR_IMX392 
SPINNAKER_CCM_SENSOR_IMX420 
SPINNAKER_CCM_SENSOR_IMX421 
SPINNAKER_CCM_SENSOR_IMX422 
SPINNAKER_CCM_SENSOR_IMX425 
SPINNAKER_CCM_SENSOR_IMX428 
SPINNAKER_CCM_SENSOR_IMX429 
SPINNAKER_CCM_SENSOR_IMX430 

◆ CCMType

enum CCMType
Enumerator
SPINNAKER_CCM_TYPE_LINEAR 
SPINNAKER_CCM_TYPE_ADVANCED 

◆ ColorProcessingAlgorithm

Color processing algorithms.

Please refer to our knowledge base at article at https://www.flir.com/support-center/iis/machine-vision/knowledge-base/different-color-processing-algorithms-in-flycapture2 for complete details for each algorithm.

Enumerator
SPINNAKER_COLOR_PROCESSING_ALGORITHM_NONE 

No color processing.

SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR 

Fastest but lowest quality.

Equivalent to FLYCAPTURE_NEAREST_NEIGHBOR_FAST in FlyCapture.

SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR_AVG 

Nearest Neighbor with averaged green pixels.

Higher quality but slower compared to nearest neighbor without averaging.

SPINNAKER_COLOR_PROCESSING_ALGORITHM_BILINEAR 

Weighted average of surrounding 4 pixels in a 2x2 neighborhood.

SPINNAKER_COLOR_PROCESSING_ALGORITHM_EDGE_SENSING 

Weights surrounding pixels based on localized edge orientation.

SPINNAKER_COLOR_PROCESSING_ALGORITHM_HQ_LINEAR 

Well-balanced speed and quality.

SPINNAKER_COLOR_PROCESSING_ALGORITHM_IPP 

Multi-threaded with similar results to edge sensing.

SPINNAKER_COLOR_PROCESSING_ALGORITHM_DIRECTIONAL_FILTER 

Best quality but much faster than rigorous.

More memory intensive than other color processing algorithms.

SPINNAKER_COLOR_PROCESSING_ALGORITHM_RIGOROUS 

Slowest but produces good results.

SPINNAKER_COLOR_PROCESSING_ALGORITHM_WEIGHTED_DIRECTIONAL_FILTER 

Weighted pixel average from different directions.

◆ Error

enum Error

The error codes used in Spinnaker.

These codes are returned as part of Spinnaker::Exception. The error codes in the range of -1000 to -1999 are reserved for exceptions that map directly to GenTL values. The error codes in the range of -2000 to -2999 are reserved for GenICam related errors. The error codes in the range of -3000 to -3999 are reserved for image processing related errors.

Enumerator
SPINNAKER_ERR_SUCCESS 
SPINNAKER_ERR_ERROR 
SPINNAKER_ERR_NOT_INITIALIZED 
SPINNAKER_ERR_NOT_IMPLEMENTED 
SPINNAKER_ERR_RESOURCE_IN_USE 
SPINNAKER_ERR_ACCESS_DENIED 
SPINNAKER_ERR_INVALID_HANDLE 
SPINNAKER_ERR_INVALID_ID 
SPINNAKER_ERR_NO_DATA 
SPINNAKER_ERR_INVALID_PARAMETER 
SPINNAKER_ERR_IO 
SPINNAKER_ERR_TIMEOUT 
SPINNAKER_ERR_ABORT 
SPINNAKER_ERR_INVALID_BUFFER 
SPINNAKER_ERR_NOT_AVAILABLE 
SPINNAKER_ERR_INVALID_ADDRESS 
SPINNAKER_ERR_BUFFER_TOO_SMALL 
SPINNAKER_ERR_INVALID_INDEX 
SPINNAKER_ERR_PARSING_CHUNK_DATA 
SPINNAKER_ERR_INVALID_VALUE 
SPINNAKER_ERR_RESOURCE_EXHAUSTED 
SPINNAKER_ERR_OUT_OF_MEMORY 
SPINNAKER_ERR_BUSY 
SPINNAKER_ERR_IP_CONFLICT 
SPINNAKER_ERR_GENICAM_INVALID_ARGUMENT 
SPINNAKER_ERR_GENICAM_OUT_OF_RANGE 
SPINNAKER_ERR_GENICAM_PROPERTY 
SPINNAKER_ERR_GENICAM_RUN_TIME 
SPINNAKER_ERR_GENICAM_LOGICAL 
SPINNAKER_ERR_GENICAM_ACCESS 
SPINNAKER_ERR_GENICAM_TIMEOUT 
SPINNAKER_ERR_GENICAM_DYNAMIC_CAST 
SPINNAKER_ERR_GENICAM_GENERIC 
SPINNAKER_ERR_GENICAM_BAD_ALLOCATION 
SPINNAKER_ERR_IM_CONVERT 
SPINNAKER_ERR_IM_COPY 
SPINNAKER_ERR_IM_MALLOC 
SPINNAKER_ERR_IM_NOT_SUPPORTED 
SPINNAKER_ERR_IM_HISTOGRAM_RANGE 
SPINNAKER_ERR_IM_HISTOGRAM_MEAN 
SPINNAKER_ERR_IM_MIN_MAX 
SPINNAKER_ERR_IM_COLOR_CONVERSION 
SPINNAKER_ERR_IM_DECOMPRESSION 
SPINNAKER_ERR_GPU_DECOMPRESSION 
SPINNAKER_ERR_GPU_NOT_SUPPORTED 
SPINNAKER_ERR_STEREO_INVALID_PIXEL_FORMAT 
SPINNAKER_ERR_STEREO_RESOLUTION_MISMATCH 
SPINNAKER_ERR_STEREO_INVALID_FILENAME 
SPINNAKER_ERR_STEREO_INVALID_PLY_FILE 
SPINNAKER_ERR_STEREO_MALLOC 
SPINNAKER_ERR_STEREO_SPECKLE_FILTER 
SPINNAKER_ERR_CUSTOM_ID 

◆ EventType

enum EventType

Event types in Spinnaker.

See also
EventHandler::GetEventType()
Enumerator
SPINNAKER_EVENT_ARRIVAL_REMOVAL 
SPINNAKER_EVENT_DEVICE 
SPINNAKER_EVENT_DEVICE_SPECIFIC 
SPINNAKER_EVENT_NEW_BUFFER 
SPINNAKER_EVENT_NEW_BUFFER_LIST 
SPINNAKER_EVENT_LOGGING_EVENT 
SPINNAKER_EVENT_INTERFACE_ARRIVAL_REMOVAL 
SPINNAKER_EVENT_UNKNOWN 

◆ HeatmapColor

Color specifiers for the heatmap color gradient.

Enumerator
SPINNAKER_HEATMAP_COLOR_BLACK 
SPINNAKER_HEATMAP_COLOR_BLUE 
SPINNAKER_HEATMAP_COLOR_CYAN 
SPINNAKER_HEATMAP_COLOR_GREEN 
SPINNAKER_HEATMAP_COLOR_YELLOW 
SPINNAKER_HEATMAP_COLOR_RED 
SPINNAKER_HEATMAP_COLOR_WHITE 

◆ ImageFileFormat

File formats to be used for saving images to disk.

Enumerator
SPINNAKER_IMAGE_FILE_FORMAT_FROM_FILE_EXT 

Determine file format from file extension.

SPINNAKER_IMAGE_FILE_FORMAT_PGM 

Portable gray map.

SPINNAKER_IMAGE_FILE_FORMAT_PPM 

Portable pixmap.

SPINNAKER_IMAGE_FILE_FORMAT_BMP 

Bitmap.

SPINNAKER_IMAGE_FILE_FORMAT_JPEG 

JPEG.

SPINNAKER_IMAGE_FILE_FORMAT_JPEG2000 

JPEG 2000.

SPINNAKER_IMAGE_FILE_FORMAT_TIFF 

Tagged image file format.

SPINNAKER_IMAGE_FILE_FORMAT_PNG 

Portable network graphics.

SPINNAKER_IMAGE_FILE_FORMAT_RAW 

Raw data.

SPINNAKER_IMAGE_FILE_FORMAT_JPEG12_C 

12 bit compressed JPEG data.

SPINNAKER_IMAGE_FILE_FORMAT_FORCE_32BITS 

◆ ImagePayloadType

Enumerator
SPINNAKER_IMAGE_PAYLOAD_TYPE_UNKNOWN 
SPINNAKER_IMAGE_PAYLOAD_TYPE_IMAGE 
SPINNAKER_IMAGE_PAYLOAD_TYPE_EXTENDED_CHUNK 
SPINNAKER_IMAGE_PAYLOAD_TYPE_JPEG 
SPINNAKER_IMAGE_PAYLOAD_TYPE_LOSSLESS_COMPRESSED 
SPINNAKER_IMAGE_PAYLOAD_TYPE_LOSSY_COMPRESSED 
SPINNAKER_IMAGE_PAYLOAD_TYPE_JPEG_LOSSLESS_COMPRESSED 
SPINNAKER_IMAGE_PAYLOAD_TYPE_RAW_SENSOR1 
SPINNAKER_IMAGE_PAYLOAD_TYPE_RAW_SENSOR2 
SPINNAKER_IMAGE_PAYLOAD_TYPE_RECTIFIED_SENSOR1 
SPINNAKER_IMAGE_PAYLOAD_TYPE_RECTIFIED_SENSOR2 
SPINNAKER_IMAGE_PAYLOAD_TYPE_DISPARITY_SENSOR1 

◆ ImageScalingAlgorithm

Image scaling algorithms.

Enumerator
SPINNAKER_IMAGE_SCALING_ALGORITHM_NEAREST_NEIGHBOR 

◆ ImageStatus

Status of images returned from GetNextImage() or Convert() calls.

Enumerator
SPINNAKER_IMAGE_STATUS_UNKNOWN_ERROR 

Image has an unknown error.

SPINNAKER_IMAGE_STATUS_NO_ERROR 

Image is returned from GetNextImage() or Convert() calls without any errors.

SPINNAKER_IMAGE_STATUS_CRC_CHECK_FAILED 

Image failed CRC check.

SPINNAKER_IMAGE_STATUS_DATA_OVERFLOW 

Received more data than the size of the image.

SPINNAKER_IMAGE_STATUS_MISSING_PACKETS 

Image has missing packets.

Potential fixes include enabling jumbo packets and adjusting packet size/delay. For more information see https://www.flir.com/support-center/iis/machine-vision/application-note/troubleshooting-image-consistency-errors/

SPINNAKER_IMAGE_STATUS_LEADER_BUFFER_SIZE_INCONSISTENT 

Image leader is incomplete.

Could be caused by missing packet(s). See link above.

SPINNAKER_IMAGE_STATUS_TRAILER_BUFFER_SIZE_INCONSISTENT 

Image trailer is incomplete.

Could be caused by missing packet(s). See link above.

SPINNAKER_IMAGE_STATUS_PACKETID_INCONSISTENT 

Image has an inconsistent packet id.

Could be caused by missing packet(s). See link above.

SPINNAKER_IMAGE_STATUS_MISSING_LEADER 

Image leader is missing.

Could be caused by missing packet(s). See link above.

SPINNAKER_IMAGE_STATUS_MISSING_TRAILER 

Image trailer is missing.

Could be caused by missing packet(s). See link above.

SPINNAKER_IMAGE_STATUS_DATA_INCOMPLETE 

Image data is incomplete.

Could be caused by missing packet(s) or decompression error. See link above.

SPINNAKER_IMAGE_STATUS_INFO_INCONSISTENT 

Image info is corrupted.

Could be caused by missing packet(s). See link above.

SPINNAKER_IMAGE_STATUS_CHUNK_DATA_INVALID 

Image chunk data is invalid.

SPINNAKER_IMAGE_STATUS_NO_SYSTEM_RESOURCES 

Image cannot be processed due to lack of system resources.

◆ PixelFormatIntType

Possible integer types and packing used in a pixel format.

Enumerator
SPINNAKER_INT_TYPE_UINT8 
SPINNAKER_INT_TYPE_INT8 
SPINNAKER_INT_TYPE_UINT10 
SPINNAKER_INT_TYPE_UINT10p 
SPINNAKER_INT_TYPE_UINT10P 
SPINNAKER_INT_TYPE_UINT12 
SPINNAKER_INT_TYPE_UINT12p 
SPINNAKER_INT_TYPE_UINT12P 
SPINNAKER_INT_TYPE_UINT14 
SPINNAKER_INT_TYPE_UINT16 
SPINNAKER_INT_TYPE_INT16 
SPINNAKER_INT_TYPE_FLOAT32 
SPINNAKER_INT_TYPE_UNKNOWN 

◆ PolarizationQuadrant

Polarization quadrant specifiers describing the four orientations of linear polarizing filters on polarized cameras.

Enumerator
SPINNAKER_POLARIZATION_QUADRANT_I0 

The 0 degree of polarization.

SPINNAKER_POLARIZATION_QUADRANT_I45 

The 45 degree of polarization.

SPINNAKER_POLARIZATION_QUADRANT_I90 

The 90 degree of polarization.

SPINNAKER_POLARIZATION_QUADRANT_I135 

The 135 degree of polarization.

◆ SourceDataRange

Image normalization source data options.

Options to normalize the source data based on the max and min values present in the specific image (image data) or the theoretical absolute max and min image data values for the image type (absolute data). By default the absolute max and min values for an image are the max and min values allowable for the image's pixel format. An exception to this is for some computed image data formats such as AoLP, DoLP and Stokes, where the absolute max and min are dependant on the algorithm used.

For a given pixel, normalization is done by: NormalizedValue = ((maxDest - minDest) * (PixelValue - minSrc) / (maxSrc - minSrc)) + minDest

Enumerator
SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE 

Normalize based on the actual max and min values for the source image.

SPINNAKER_SOURCE_DATA_RANGE_ABSOLUTE_DATA_RANGE 

Normalize based on the theoretical max and min values for the source image.

SPINNAKER_SOURCE_DATA_RANGE_IMAGE_MIN_ABSOLUTE_MAX 

Normalize based on the actual min and theoretical max values for the source image.

SPINNAKER_SOURCE_DATA_RANGE_ABSOLUTE_MIN_IMAGE_MAX 

Normalize based on the theoretical min and actual max values for the source image.

◆ SpinnakerLogLevel

Log levels.

Enumerator
SPINNAKER_LOG_LEVEL_OFF 
SPINNAKER_LOG_LEVEL_FATAL 
SPINNAKER_LOG_LEVEL_ALERT 
SPINNAKER_LOG_LEVEL_CRIT 
SPINNAKER_LOG_LEVEL_ERROR 
SPINNAKER_LOG_LEVEL_WARN 
SPINNAKER_LOG_LEVEL_NOTICE 
SPINNAKER_LOG_LEVEL_INFO 
SPINNAKER_LOG_LEVEL_DEBUG 
SPINNAKER_LOG_LEVEL_NOTSET 

◆ StatisticsChannel

Channels that allow statistics to be calculated.

Enumerator
SPINNAKER_STATISTICS_CHANNEL_GREY 
SPINNAKER_STATISTICS_CHANNEL_RED 
SPINNAKER_STATISTICS_CHANNEL_GREEN 
SPINNAKER_STATISTICS_CHANNEL_BLUE 
SPINNAKER_STATISTICS_CHANNEL_HUE 
SPINNAKER_STATISTICS_CHANNEL_SATURATION 
SPINNAKER_STATISTICS_CHANNEL_LIGHTNESS 
SPINNAKER_STATISTICS_CHANNEL_NUM_CHANNELS 

◆ TIFFCompressionMethod

Compression method to use for encoding TIFF images.

Enumerator
SPINNAKER_TIFF_COMPRESS_METHOD_NONE 

Save without any compression.

SPINNAKER_TIFF_COMPRESS_METHOD_PACKBITS 

Save using PACKBITS compression.

SPINNAKER_TIFF_COMPRESS_METHOD_DEFLATE 

Save using DEFLATE compression (ZLIB compression).

SPINNAKER_TIFF_COMPRESS_METHOD_ADOBE_DEFLATE 

Save using ADOBE DEFLATE compression.

SPINNAKER_TIFF_COMPRESS_METHOD_CCITTFAX3 

Save using CCITT Group 3 fax encoding.

This is only valid for 1-bit images only. Default to LZW for other bit depths.

SPINNAKER_TIFF_COMPRESS_METHOD_CCITTFAX4 

Save using CCITT Group 4 fax encoding.

This is only valid for 1-bit images only. Default to LZW for other bit depths.

SPINNAKER_TIFF_COMPRESS_METHOD_LZW 

Save using LZW compression.

SPINNAKER_TIFF_COMPRESS_METHOD_JPEG 

Save using JPEG compression.

This is only valid for 8-bit greyscale and 24-bit only. Default to LZW for other bit depths.

◆ TLPayloadType

Enumerator
SPINNAKER_TLPAYLOAD_TYPE_UNKNOWN 
SPINNAKER_TLPAYLOAD_TYPE_IMAGE 
SPINNAKER_TLPAYLOAD_TYPE_RAW_DATA 
SPINNAKER_TLPAYLOAD_TYPE_FILE 
SPINNAKER_TLPAYLOAD_TYPE_CHUNK_DATA 
SPINNAKER_TLPAYLOAD_TYPE_JPEG 
SPINNAKER_TLPAYLOAD_TYPE_JPEG2000 
SPINNAKER_TLPAYLOAD_TYPE_H264 
SPINNAKER_TLPAYLOAD_TYPE_CHUNK_ONLY 
SPINNAKER_TLPAYLOAD_TYPE_DEVICE_SPECIFIC 
SPINNAKER_TLPAYLOAD_TYPE_MULTI_PART 
SPINNAKER_TLPAYLOAD_TYPE_CUSTOM_ID 
SPINNAKER_TLPAYLOAD_TYPE_LOSSLESS_COMPRESSED 
SPINNAKER_TLPAYLOAD_TYPE_LOSSY_COMPRESSED 
SPINNAKER_TLPAYLOAD_TYPE_JPEG_LOSSLESS_COMPRESSED 

◆ TLPixelFormatNamespace

This enum represents the namespace in which the TL specific pixel format resides.

This enum is returned from a captured image when calling Image::GetTLPixelFormatNamespace(). It can be used to interpret the raw pixel format returned from Image::GetTLPixelFormat().

See also
Image::GetTLPixelFormat()
Image::GetTLPixelFormatNamespace()
Enumerator
SPINNAKER_TLPIXELFORMAT_NAMESPACE_UNKNOWN 
SPINNAKER_TLPIXELFORMAT_NAMESPACE_GEV 
SPINNAKER_TLPIXELFORMAT_NAMESPACE_IIDC 
SPINNAKER_TLPIXELFORMAT_NAMESPACE_PFNC_16BIT 
SPINNAKER_TLPIXELFORMAT_NAMESPACE_PFNC_32BIT 
SPINNAKER_TLPIXELFORMAT_NAMESPACE_CUSTOM_ID 

Variable Documentation

◆ EVENT_TIMEOUT_INFINITE

const uint64_t EVENT_TIMEOUT_INFINITE = 0xFFFFFFFFFFFFFFFF

◆ EVENT_TIMEOUT_NONE

const uint64_t EVENT_TIMEOUT_NONE = 0

Timeout values for getting next image, device, or interface event.