Spinnaker C
4.3.0.189
 
Enumerations
Spinnaker C Enumerations
Spinnaker C API » Spinnaker C Definitions

Spinnaker C enumumeration definitions. More...

Enumerations

enum  _spinError {
  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_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_CUSTOM_ID = -10000
}
 The error codes used in Spinnaker C. More...
 
enum  _spinColorProcessingAlgorithm {
  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  _spinStatisticsChannel {
  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  _spinImageFileFormat {
  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_FORCE_32BITS = 0x7FFFFFFF
}
 File formats to be used for saving images to disk. More...
 
enum  _spinTLPixelFormatNamespace {
  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_PIXELFORMAT_NAMESPACE_CUSTOM_ID = 1000
}
 This enum represents the namespace in which the TL specific pixel format resides. More...
 
enum  _spinImageStatus {
  SPINNAKER_IMAGE_STATUS_UNKNOWN_ERROR = -1, SPINNAKER_IMAGE_STATUS_NO_ERROR = 0, 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, SPINNAKER_IMAGE_STATUS_INFO_INCONSISTENT,
  SPINNAKER_IMAGE_STATUS_CHUNK_DATA_INVALID = 11, SPINNAKER_IMAGE_STATUS_NO_SYSTEM_RESOURCES = 12
}
 Status of images returned from spinImageGetStatus() call. More...
 
enum  _spinLogLevel {
  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 = 500, SPINNAKER_LOG_LEVEL_INFO = 600,
  SPINNAKER_LOG_LEVEL_DEBUG = 700, SPINNAKER_LOG_LEVEL_NOTSET = 800
}
 log levels More...
 
enum  _spinTLPayloadType {
  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  _spinTIFFCompressionMethod {
  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_JPG
}
 Compression method to use for encoding TIFF images. More...
 
enum  _spinActionCommandStatus {
  SPINNAKER_ACTION_COMMAND_STATUS_OK = 0, SPINNAKER_ACTION_COMMAND_STATUS_NO_REF_TIME = 0x8013, SPINNAKER_ACTION_COMMAND_STATUS_OVERFLOW = 0x8015, SPINNAKER_ACTION_COMMAND_STATUS_ACTION_LATE = 0x8016,
  SPINNAKER_ACTION_COMMAND_STATUS_ERROR = 0x8FFF
}
 Possible Status Codes Returned from Action Command. More...
 

Detailed Description

Spinnaker C enumumeration definitions.

Enumeration Type Documentation

◆ _spinActionCommandStatus

enum _spinActionCommandStatus

Possible Status Codes Returned from Action Command.

Enumerator
SPINNAKER_ACTION_COMMAND_STATUS_OK 

The device acknowledged the command.

SPINNAKER_ACTION_COMMAND_STATUS_NO_REF_TIME 
SPINNAKER_ACTION_COMMAND_STATUS_OVERFLOW 
SPINNAKER_ACTION_COMMAND_STATUS_ACTION_LATE 
SPINNAKER_ACTION_COMMAND_STATUS_ERROR 

◆ _spinColorProcessingAlgorithm

enum _spinColorProcessingAlgorithm

Color processing algorithms.

Please refer to our knowledge base at article at https://www.teledynevisionsolutions.com/support/support-center/technical-guidance/iis/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.

SPINNAKER_COLOR_PROCESSING_ALGORITHM_RIGOROUS 

Slowest but produces good results.

SPINNAKER_COLOR_PROCESSING_ALGORITHM_WEIGHTED_DIRECTIONAL_FILTER 

Weighted pixel average from different directions.

◆ _spinError

enum _spinError

The error codes used in Spinnaker C.

These codes are returned from every function in Spinnaker C. 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 

An error code of 0 means that the function has run without error.

SPINNAKER_ERR_ERROR 

The error codes in the range of -1000 to -1999 are reserved for Spinnaker exceptions.

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_GENICAM_INVALID_ARGUMENT 

The error codes in the range of -2000 to -2999 are reserved for Gen API related errors.

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 

The error codes in the range of -3000 to -3999 are reserved for image processing related errors.

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_CUSTOM_ID 

Error codes less than -10000 are reserved for user-defined custom errors.

◆ _spinImageFileFormat

enum _spinImageFileFormat

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_FORCE_32BITS 

◆ _spinImageStatus

enum _spinImageStatus

Status of images returned from spinImageGetStatus() call.

Enumerator
SPINNAKER_IMAGE_STATUS_UNKNOWN_ERROR 

Image has an unknown error.

SPINNAKER_IMAGE_STATUS_NO_ERROR 

Image is returned from GetNextImage() call 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.teledynevisionsolutions.com/support/support-center/troubleshooting/iis/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). 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.

◆ _spinLogLevel

enum _spinLogLevel

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 

◆ _spinStatisticsChannel

enum _spinStatisticsChannel

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 

◆ _spinTIFFCompressionMethod

enum _spinTIFFCompressionMethod

Compression method to use for encoding TIFF images.

Enumerator
SPINNAKER_TIFF_COMPRESS_METHOD_NONE 
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_JPG 

◆ _spinTLPayloadType

enum _spinTLPayloadType
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 

◆ _spinTLPixelFormatNamespace

enum _spinTLPixelFormatNamespace

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

This enum is returned from a captured image when calling spinImageGetTLPixelFormatNamespace(). It can be used to interpret the raw pixel format returned from spinImageGetTLPixelFormat().

See also
spinImageGetTLPixelFormat()
spinImageGetTLPixelFormatNamespace()
Enumerator
SPINNAKER_TLPIXELFORMAT_NAMESPACE_UNKNOWN 
SPINNAKER_TLPIXELFORMAT_NAMESPACE_GEV 
SPINNAKER_TLPIXELFORMAT_NAMESPACE_IIDC 
SPINNAKER_TLPIXELFORMAT_NAMESPACE_PFNC_16BIT 
SPINNAKER_TLPIXELFORMAT_NAMESPACE_PFNC_32BIT 
SPINNAKER_PIXELFORMAT_NAMESPACE_CUSTOM_ID