Spinnaker SDK C++
4.1.0.157
 
 

 
Loading...
Searching...
No Matches
SpinnakerDefs.h File Reference

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...
 

Namespaces

namespace  Spinnaker
 

Enumerations

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_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
}
 
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 }
 

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