Spinnaker C++
2.6.0.0
Classes | Enumerations
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  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...
 

Enumerations

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, GENICAM_ERR_INVALID_ARGUMENT = -2001,
  GENICAM_ERR_OUT_OF_RANGE = -2002, GENICAM_ERR_PROPERTY = -2003, GENICAM_ERR_RUN_TIME = -2004, GENICAM_ERR_LOGICAL = -2005,
  GENICAM_ERR_ACCESS = -2006, GENICAM_ERR_TIMEOUT = -2007, GENICAM_ERR_DYNAMIC_CAST = -2008, GENICAM_ERR_GENERIC = -2009,
  GENICAM_ERR_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_CUSTOM_ID = -10000
}
 Spinnaker enum definitions. More...
 
enum  EventType {
  SPINNAKER_EVENT_ARRIVAL_REMOVAL, SPINNAKER_EVENT_DEVICE, SPINNAKER_EVENT_DEVICE_SPECIFIC, SPINNAKER_EVENT_NEW_BUFFER,
  SPINNAKER_EVENT_LOGGING_EVENT, SPINNAKER_EVENT_UNKNOWN, SPINNAKER_EVENT_INTERFACE_ARRIVAL_REMOVAL
}
 Event types in Spinnaker. More...
 
enum  PixelFormatNamespaceID {
  SPINNAKER_PIXELFORMAT_NAMESPACE_UNKNOWN = 0, SPINNAKER_PIXELFORMAT_NAMESPACE_GEV = 1, SPINNAKER_PIXELFORMAT_NAMESPACE_IIDC = 2, SPINNAKER_PIXELFORMAT_NAMESPACE_PFNC_16BIT = 3,
  SPINNAKER_PIXELFORMAT_NAMESPACE_PFNC_32BIT = 4, SPINNAKER_PIXELFORMAT_NAMESPACE_CUSTOM_ID = 1000
}
 This enum represents the namespace in which the TL specific pixel format resides. More...
 
enum  ColorProcessingAlgorithm {
  DEFAULT, NO_COLOR_PROCESSING, NEAREST_NEIGHBOR, NEAREST_NEIGHBOR_AVG,
  BILINEAR, EDGE_SENSING, HQ_LINEAR, IPP,
  DIRECTIONAL_FILTER, RIGOROUS, WEIGHTED_DIRECTIONAL_FILTER
}
 Color processing algorithms. More...
 
enum  ImageFileFormat {
  FROM_FILE_EXT = -1, PGM, PPM, BMP,
  JPEG, JPEG2000, TIFF, PNG,
  RAW, JPEG12_C, IMAGE_FILE_FORMAT_FORCE_32BITS = 0x7FFFFFFF
}
 File formats to be used for saving images to disk. More...
 
enum  ImageStatus {
  IMAGE_UNKNOWN_ERROR = -1, IMAGE_NO_ERROR = 0, IMAGE_CRC_CHECK_FAILED = 1, IMAGE_DATA_OVERFLOW = 2,
  IMAGE_MISSING_PACKETS, IMAGE_LEADER_BUFFER_SIZE_INCONSISTENT, IMAGE_TRAILER_BUFFER_SIZE_INCONSISTENT, IMAGE_PACKETID_INCONSISTENT,
  IMAGE_MISSING_LEADER = 7, IMAGE_MISSING_TRAILER, IMAGE_DATA_INCOMPLETE, IMAGE_INFO_INCONSISTENT,
  IMAGE_CHUNK_DATA_INVALID = 11, IMAGE_NO_SYSTEM_RESOURCES = 12
}
 Status of images returned from GetNextImage() call. More...
 
enum  StatisticsChannel {
  GREY, RED, GREEN, BLUE,
  HUE, SATURATION, LIGHTNESS, NUM_STATISTICS_CHANNELS
}
 Channels that allow statistics to be calculated. More...
 
enum  SpinnakerLogLevel {
  LOG_LEVEL_OFF = -1, LOG_LEVEL_FATAL = 0, LOG_LEVEL_ALERT = 100, LOG_LEVEL_CRIT = 200,
  LOG_LEVEL_ERROR = 300, LOG_LEVEL_WARN = 400, LOG_LEVEL_NOTICE = 500, LOG_LEVEL_INFO = 600,
  LOG_LEVEL_DEBUG = 700, LOG_LEVEL_NOTSET = 800
}
 log levels More...
 
enum  PayloadTypeInfoIDs {
  PAYLOAD_TYPE_UNKNOWN = 0, PAYLOAD_TYPE_IMAGE = 1, PAYLOAD_TYPE_RAW_DATA = 2, PAYLOAD_TYPE_FILE = 3,
  PAYLOAD_TYPE_CHUNK_DATA = 4, PAYLOAD_TYPE_JPEG = 5, PAYLOAD_TYPE_JPEG2000 = 6, PAYLOAD_TYPE_H264 = 7,
  PAYLOAD_TYPE_CHUNK_ONLY = 8, PAYLOAD_TYPE_DEVICE_SPECIFIC = 9, PAYLOAD_TYPE_MULTI_PART = 10, PAYLOAD_TYPE_CUSTOM_ID = 1000,
  PAYLOAD_TYPE_EXTENDED_CHUNK = 1001, PAYLOAD_TYPE_LOSSLESS_COMPRESSED = 1002, PAYLOAD_TYPE_LOSSY_COMPRESSED = 1003, PAYLOAD_TYPE_JPEG_LOSSLESS_COMPRESSED = 1004,
  PAYLOAD_TYPE_CHUNK_DATA_LOSSLESS_COMPRESSED = 1005, PAYLOAD_TYPE_CHUNK_DATA_LOSSY_COMPRESSED = 1006
}
 
enum  ActionCommandStatus {
  ACTION_COMMAND_STATUS_OK = 0, ACTION_COMMAND_STATUS_NO_REF_TIME, ACTION_COMMAND_STATUS_OVERFLOW = 0x8015, ACTION_COMMAND_STATUS_ACTION_LATE,
  ACTION_COMMAND_STATUS_ERROR
}
 Possible Status Codes Returned from Action Command. More...
 
enum  PixelFormatIntType {
  IntType_UINT8, IntType_INT8, IntType_UINT10, IntType_UINT10p,
  IntType_UINT10P, IntType_UINT12, IntType_UINT12p, IntType_UINT12P,
  IntType_UINT14, IntType_UINT16, IntType_INT16, IntType_FLOAT32,
  IntType_UNKNOWN
}
 Possible integer types and packing used in a pixel format. More...
 
enum  BufferOwnership { BUFFER_OWNERSHIP_SYSTEM, BUFFER_OWNERSHIP_USER }
 
enum  CCMColorTemperature {
  TUNGSTEN_2800K, WARM_FLUORESCENT_3000K, COOL_FLUORESCENT_4000K, SUNNY_5000K,
  CLOUDY_6500K, SHADE_8000K, GENERAL
}
 
enum  CCMType { LINEAR, ADVANCED }
 
enum  CCMSensor { IMX250 }
 
enum  CCMColorSpace { OFF, sRGB }
 
enum  CCMApplication { CCM_APPLICATION_GENERIC, CCM_APPLICATION_MICROSCOPY }
 

Detailed Description

Definitions file for Spinnaker.

Enumeration Type Documentation

enum ActionCommandStatus

Possible Status Codes Returned from Action Command.

Enumerator
ACTION_COMMAND_STATUS_OK 
ACTION_COMMAND_STATUS_NO_REF_TIME 
ACTION_COMMAND_STATUS_OVERFLOW 
ACTION_COMMAND_STATUS_ACTION_LATE 
ACTION_COMMAND_STATUS_ERROR 
enum BufferOwnership
Enumerator
BUFFER_OWNERSHIP_SYSTEM 
BUFFER_OWNERSHIP_USER 
enum CCMApplication
Enumerator
CCM_APPLICATION_GENERIC 
CCM_APPLICATION_MICROSCOPY 
enum CCMColorSpace
Enumerator
OFF 
sRGB 
enum CCMColorTemperature
Enumerator
TUNGSTEN_2800K 
WARM_FLUORESCENT_3000K 
COOL_FLUORESCENT_4000K 
SUNNY_5000K 
CLOUDY_6500K 
SHADE_8000K 
GENERAL 
enum CCMSensor
Enumerator
IMX250 
enum CCMType
Enumerator
LINEAR 
ADVANCED 
enum 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
DEFAULT 

Default method.

NO_COLOR_PROCESSING 

No color processing.

NEAREST_NEIGHBOR 

Fastest but lowest quality.

Equivalent to FLYCAPTURE_NEAREST_NEIGHBOR_FAST in FlyCapture.

NEAREST_NEIGHBOR_AVG 

Nearest Neighbor with averaged green pixels.

Higher quality but slower compared to nearest neighbor without averaging.

BILINEAR 

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

EDGE_SENSING 

Weights surrounding pixels based on localized edge orientation.

HQ_LINEAR 

Well-balanced speed and quality.

IPP 

Multi-threaded with similar results to edge sensing.

DIRECTIONAL_FILTER 

Best quality but much faster than rigorous.

More memory intensive than other color processing algorithms.

RIGOROUS 

Slowest but produces good results.

WEIGHTED_DIRECTIONAL_FILTER 

Weighted pixel average from different directions.

enum Error

Spinnaker enum definitions.

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 
GENICAM_ERR_INVALID_ARGUMENT 
GENICAM_ERR_OUT_OF_RANGE 
GENICAM_ERR_PROPERTY 
GENICAM_ERR_RUN_TIME 
GENICAM_ERR_LOGICAL 
GENICAM_ERR_ACCESS 
GENICAM_ERR_TIMEOUT 
GENICAM_ERR_DYNAMIC_CAST 
GENICAM_ERR_GENERIC 
GENICAM_ERR_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_CUSTOM_ID 
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_LOGGING_EVENT 
SPINNAKER_EVENT_UNKNOWN 
SPINNAKER_EVENT_INTERFACE_ARRIVAL_REMOVAL 
enum ImageFileFormat

File formats to be used for saving images to disk.

Enumerator
FROM_FILE_EXT 

Determine file format from file extension.

PGM 

Portable gray map.

PPM 

Portable pixmap.

BMP 

Bitmap.

JPEG 

JPEG.

JPEG2000 

JPEG 2000.

TIFF 

Tagged image file format.

PNG 

Portable network graphics.

RAW 

Raw data.

JPEG12_C 

12 bit compressed JPEG data.

IMAGE_FILE_FORMAT_FORCE_32BITS 
enum ImageStatus

Status of images returned from GetNextImage() call.

Enumerator
IMAGE_UNKNOWN_ERROR 

Image has an unknown error.

IMAGE_NO_ERROR 

Image is returned from GetNextImage() call without any errors.

IMAGE_CRC_CHECK_FAILED 

Image failed CRC check.

IMAGE_DATA_OVERFLOW 

Received more data than the size of the image.

IMAGE_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/

IMAGE_LEADER_BUFFER_SIZE_INCONSISTENT 

Image leader is incomplete.

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

IMAGE_TRAILER_BUFFER_SIZE_INCONSISTENT 

Image trailer is incomplete.

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

IMAGE_PACKETID_INCONSISTENT 

Image has an inconsistent packet id.

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

IMAGE_MISSING_LEADER 

Image leader is missing.

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

IMAGE_MISSING_TRAILER 

Image trailer is missing.

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

IMAGE_DATA_INCOMPLETE 

Image data is incomplete.

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

IMAGE_INFO_INCONSISTENT 

Image info is corrupted.

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

IMAGE_CHUNK_DATA_INVALID 

Image chunk data is invalid.

IMAGE_NO_SYSTEM_RESOURCES 

Image cannot be processed due to lack of system resources.

enum PayloadTypeInfoIDs
Enumerator
PAYLOAD_TYPE_UNKNOWN 
PAYLOAD_TYPE_IMAGE 
PAYLOAD_TYPE_RAW_DATA 
PAYLOAD_TYPE_FILE 
PAYLOAD_TYPE_CHUNK_DATA 
PAYLOAD_TYPE_JPEG 
PAYLOAD_TYPE_JPEG2000 
PAYLOAD_TYPE_H264 
PAYLOAD_TYPE_CHUNK_ONLY 
PAYLOAD_TYPE_DEVICE_SPECIFIC 
PAYLOAD_TYPE_MULTI_PART 
PAYLOAD_TYPE_CUSTOM_ID 
PAYLOAD_TYPE_EXTENDED_CHUNK 
PAYLOAD_TYPE_LOSSLESS_COMPRESSED 
PAYLOAD_TYPE_LOSSY_COMPRESSED 
PAYLOAD_TYPE_JPEG_LOSSLESS_COMPRESSED 
PAYLOAD_TYPE_CHUNK_DATA_LOSSLESS_COMPRESSED 
PAYLOAD_TYPE_CHUNK_DATA_LOSSY_COMPRESSED 
enum PixelFormatIntType

Possible integer types and packing used in a pixel format.

Enumerator
IntType_UINT8 
IntType_INT8 
IntType_UINT10 
IntType_UINT10p 
IntType_UINT10P 
IntType_UINT12 
IntType_UINT12p 
IntType_UINT12P 
IntType_UINT14 
IntType_UINT16 
IntType_INT16 
IntType_FLOAT32 
IntType_UNKNOWN 
enum PixelFormatNamespaceID

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_PIXELFORMAT_NAMESPACE_UNKNOWN 
SPINNAKER_PIXELFORMAT_NAMESPACE_GEV 
SPINNAKER_PIXELFORMAT_NAMESPACE_IIDC 
SPINNAKER_PIXELFORMAT_NAMESPACE_PFNC_16BIT 
SPINNAKER_PIXELFORMAT_NAMESPACE_PFNC_32BIT 
SPINNAKER_PIXELFORMAT_NAMESPACE_CUSTOM_ID 
enum SpinnakerLogLevel

log levels

Enumerator
LOG_LEVEL_OFF 
LOG_LEVEL_FATAL 
LOG_LEVEL_ALERT 
LOG_LEVEL_CRIT 
LOG_LEVEL_ERROR 
LOG_LEVEL_WARN 
LOG_LEVEL_NOTICE 
LOG_LEVEL_INFO 
LOG_LEVEL_DEBUG 
LOG_LEVEL_NOTSET 
enum StatisticsChannel

Channels that allow statistics to be calculated.

Enumerator
GREY 
RED 
GREEN 
BLUE 
HUE 
SATURATION 
LIGHTNESS 
NUM_STATISTICS_CHANNELS 
Contact Support Spinnaker® SDK Programmer's Guide and API Reference