Namespace SpinnakerNET¶

Namespaces¶

Type	Name
namespace	Base
namespace	GUI
namespace	GenApi

Classes¶

Type	Name
struct	ActionCommandResult
struct	AviOption
struct	BmpOption
struct	CCMSettings
class	DeviceEventRedirector
struct	H264Option
interface	IManagedCamera The managed camera interface object class.
interface	IManagedCameraBase
interface	IManagedCameraList
interface	IManagedImage
interface	IManagedInterface
interface	IManagedInterfaceList
interface	IManagedSystem
class	ImageEventRedirector
struct	ImagePixel
class	InterfaceEventRedirector
struct	JpegOption
struct	Jpg2Option
struct	LibraryVersion
class	LoggingEventRedirector
struct	MJPGOption
class	ManagedCamera The managed camera object class.
class	ManagedCameraBase
class	ManagedCameraList
class	ManagedChunkData The managed chunk data which contains additional information about an image.
class	ManagedImage The managed image object class.
class	ManagedImageStatistics
class	ManagedImageUtility Helper functions for managed image objects.
class	ManagedImageUtilityHeatmap Helper functions for managed image objects of pixel format Mono8 and Mono16.
class	ManagedImageUtilityPolarization Helper functions for managed image objects of pixel format Polarized8 and BayerRGPolarized8.
class	ManagedImageUtilityStereo Helper functions for managed image objects.
struct	ManagedInferenceBoundingBox A single managed inference bounding box.
class	ManagedInferenceBoundingBoxResult The managed inference bounding box result.
class	ManagedInterface
class	ManagedInterfaceList
class	ManagedLogger
class	ManagedLoggingEventData
class	ManagedPointCloud
class	ManagedSystem
class	ManagedTransportLayerDevice Part of the Managed QuickSpin API to provide access to camera information without having to first initialize the camera.
class	ManagedTransportLayerInterface Part of the Managed QuickSpin API to provide access to camera information without having to first initialize the camera.
class	ManagedTransportLayerStream Part of the Managed QuickSpin API to provide access to camera information without having to first initialize the camera.
class	ManagedTransportLayerSystem Part of the Managed QuickSpin API to provide access to camera information without having to first initialize the camera.
struct	PgmOption
struct	PngOption
struct	PointCloudParameters
struct	PpmOption
class	SpinnakerException
struct	Stereo3DPoint
struct	StereoCameraParameters
class	SystemEventRedirector
struct	TiffOption
class	abstract

Public Types¶

Type	Name
enum	ActionCommandStatus
enum	BufferOwnership
enum	CCMApplication
enum	CCMColorSpace
enum	CCMColorTemperature
enum	CCMSensor
enum	CCMType
enum	ColorProcessingAlgorithm
enum	DisparityProcessingMethod
enum	Error
enum	HeatmapColor
enum	ImageFileFormat
enum	ImagePayloadType
enum	ImageStatus
enum	InferenceBoundingBoxType
enum	ManagedLogType
enum	ManagedLoggingLevel
typedef void(__stdcall *	OnDeviceArrivalNative
typedef void(__stdcall *	OnDeviceEventNative
typedef void(__stdcall *	OnDeviceRemovalNative
typedef void(__stdcall *	OnImageEventNative
typedef void(__stdcall *	OnInterfaceArrivalNative
typedef void(__stdcall *	OnInterfaceRemovalNative
typedef void(__stdcall *	OnLoggingEventNative
enum	PolarizationQuadrant
enum	StatisticsChannel
enum	TIFFCompressionMethod
enum	TLPayloadType
enum	TLPixelFormatNamespace

Public Functions¶

Type	Name
delegate void	ManagedLogEventCallback (SpinnakerNET::ManagedLoggingEventData^ logEvent)
delegate void	OnDeviceArrivalDelegate (Spinnaker::CameraPtr)
delegate void	OnDeviceEventDelegate (Spinnaker::GenICam::gcstring eventName)
delegate void	OnDeviceRemovalDelegate (Spinnaker::CameraPtr)
delegate void	OnImageEventDelegate (Spinnaker::ImagePtr image)
delegate void	OnInterfaceArrivalDelegate (Spinnaker::InterfacePtr)
delegate void	OnInterfaceRemovalDelegate (Spinnaker::InterfacePtr)
delegate void	OnLoggingEventDelegate (Spinnaker::LoggingEventDataPtr loggingEvent)
inline ::System::String	ToManaged (const char * str)
inline ::System::String	ToManaged (const char * str, size_t len)
inline ::System::String	ToManaged (const Spinnaker::GenICam::gcstring & str)
Spinnaker::GenICam::gcstring	ToNative (::System::String ^ str)
bool	is_node (void * pType)
bool	is_node (IntPtr type)
T *	node_cast (void * pType)
T *	node_cast (IntPtr type)
T *	type_cast (void * pType)
T *	type_cast (IntPtr type)

Public Types Documentation¶

enum ActionCommandStatus¶

enum SpinnakerNET::ActionCommandStatus {
    ACTION_COMMAND_STATUS_OK = 0,
    ACTION_COMMAND_STATUS_NO_REF_TIME = 0x8013,
    ACTION_COMMAND_STATUS_OVERFLOW = 0x8015,
    ACTION_COMMAND_STATUS_ACTION_LATE = 0x8016,
    ACTION_COMMAND_STATUS_ERROR = 0x8FFF
};

Possible Status Codes Returned from Action Command

enum BufferOwnership¶

enum SpinnakerNET::BufferOwnership {
    BUFFER_OWNERSHIP_SYSTEM,
    BUFFER_OWNERSHIP_USER
};

enum CCMApplication¶

enum SpinnakerNET::CCMApplication {
    GENERIC,
    MICROSCOPY,
    NUM_CCM_APPLICATION
};

enum CCMColorSpace¶

enum SpinnakerNET::CCMColorSpace {
    OFF,
    SRGB,
    NUM_CCM_COLOR_SPACE
};

enum CCMColorTemperature¶

enum SpinnakerNET::CCMColorTemperature {
    INCANDESCENT_2765K,
    TUNGSTEN_2800K,
    WARM_FLUORESCENT_3000K,
    HALOGEN_3188K,
    COOL_FLUORESCENT_4000K,
    LED_4649K,
    LED_H_AND_E_4649K,
    FLUORESCENT_4665K,
    SUNNY_5000K,
    DAYLIGHT_5034K,
    DAYLIGHT_H_AND_E_5034K,
    CLOUDY_6500K,
    SHADE_8000K,
    GENERAL,
    NUM_CCM_COLOR_TEMPERATURE
};

enum CCMSensor¶

enum SpinnakerNET::CCMSensor {
    IMX226,
    IMX249,
    IMX250,
    IMX252,
    IMX253,
    IMX255,
    IMX264,
    IMX265,
    IMX267,
    IMX273,
    IMX287,
    IMX296,
    IMX297,
    IMX304,
    IMX327,
    IMX334,
    IMX342,
    IMX367,
    IMX387,
    IMX392,
    IMX420,
    IMX421,
    IMX422,
    IMX425,
    IMX428,
    IMX429,
    IMX430,
    AR0521,
    NUM_CCM_SENSOR
};

enum CCMType¶

enum SpinnakerNET::CCMType {
    LINEAR,
    ADVANCED,
    NUM_CCM_TYPE
};

enum ColorProcessingAlgorithm¶

enum SpinnakerNET::ColorProcessingAlgorithm {
    NONE,
    NEAREST_NEIGHBOR,
    NEAREST_NEIGHBOR_AVG,
    BILINEAR,
    EDGE_SENSING,
    HQ_LINEAR,
    IPP,
    DIRECTIONAL_FILTER,
    RIGOROUS,
    WEIGHTED_DIRECTIONAL_FILTER
};

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.

enum DisparityProcessingMethod¶

enum SpinnakerNET::DisparityProcessingMethod {
    NONE,
    HIGH_DENSITY,
    BALANCED,
    HIGH_PERFORMANCE
};

Strategies for post-processing disparity maps to fill missing or invalid regions using weighted interpolation, joint bilateral filtering, domain transfer, and speckle filtering. Each strategy balances accuracy, density, and computational cost differently.

enum Error¶

enum SpinnakerNET::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_INVALID_CAMERA = -1024,
    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_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_IM_INVALID_IMAGE_TYPE = -3010,
    SPINNAKER_ERR_GPU_DECOMPRESSION = -3100,
    SPINNAKER_ERR_GPU_NOT_SUPPORTED = -3101,
    SPINNAKER_ERR_STEREO_INVALID_PIXEL_FORMAT = -3200,
    SPINNAKER_ERR_STEREO_RESOLUTION_MISMATCH = -3201,
    SPINNAKER_ERR_STEREO_INVALID_FILENAME = -3202,
    SPINNAKER_ERR_STEREO_INVALID_PLY_FILE = -3203,
    SPINNAKER_ERR_STEREO_MALLOC = -3204,
    SPINNAKER_ERR_STEREO_SPECKLE_FILTER = -3205,
    SPINNAKER_ERR_CUSTOM_ID = -10000
};

The error codes used in SpinnakerNet. These codes are returned as part of SpinnakerNet::ManagedException. 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.

enum HeatmapColor¶

enum SpinnakerNET::HeatmapColor {
    HEATMAP_BLACK = 1,
    HEATMAP_BLUE = 2,
    HEATMAP_CYAN = 3,
    HEATMAP_GREEN = 4,
    HEATMAP_YELLOW = 5,
    HEATMAP_RED = 6,
    HEATMAP_WHITE = 7
};

enum ImageFileFormat¶

enum SpinnakerNET::ImageFileFormat {
    FromFileExtension = -1,
    Pgm,
    Ppm,
    Bmp,
    Jpeg,
    Jpeg2000,
    Tiff,
    Png,
    Raw
};

File formats to be used for saving images to disk.

enum ImagePayloadType¶

enum SpinnakerNET::ImagePayloadType {
    IMAGE_PAYLOAD_TYPE_UNKNOWN = -1,
    IMAGE_PAYLOAD_TYPE_IMAGE,
    IMAGE_PAYLOAD_TYPE_EXTENDED_CHUNK,
    IMAGE_PAYLOAD_TYPE_JPEG,
    IMAGE_PAYLOAD_TYPE_LOSSLESS_COMPRESSED,
    IMAGE_PAYLOAD_TYPE_LOSSY_COMPRESSED,
    IMAGE_PAYLOAD_TYPE_JPEG_LOSSLESS_COMPRESSED,
    IMAGE_PAYLOAD_TYPE_RAW_SENSOR1,
    IMAGE_PAYLOAD_TYPE_RAW_SENSOR2,
    IMAGE_PAYLOAD_TYPE_RECTIFIED_SENSOR1,
    IMAGE_PAYLOAD_TYPE_RECTIFIED_SENSOR2,
    IMAGE_PAYLOAD_TYPE_DISPARITY_SENSOR1,
    IMAGE_PAYLOAD_TYPE_GENDC_GENERIC,
    IMAGE_PAYLOAD_TYPE_RANGE_SENSOR1,
    IMAGE_PAYLOAD_TYPE_RANGE_SENSOR2
};

enum ImageStatus¶

enum SpinnakerNET::ImageStatus {
    IMAGE_UNKNOWN_ERROR = -1,
    IMAGE_NO_ERROR = 0,
    IMAGE_CRC_CHECK_FAILED = 1,
    IMAGE_DATA_OVERFLOW = 2,
    IMAGE_MISSING_PACKETS = 3,
    IMAGE_LEADER_BUFFER_SIZE_INCONSISTENT = 4,
    IMAGE_TRAILER_BUFFER_SIZE_INCONSISTENT = 5,
    IMAGE_PACKETID_INCONSISTENT = 6,
    IMAGE_MISSING_LEADER = 7,
    IMAGE_MISSING_TRAILER = 8,
    IMAGE_DATA_INCOMPLETE = 9,
    IMAGE_INFO_INCONSISTENT = 10,
    IMAGE_CHUNK_DATA_INVALID = 11,
    IMAGE_NO_SYSTEM_RESOURCES = 12,
    IMAGE_GENDC_DATA_INVALID = 13,
    IMAGE_GENDC_PART_DATA_INVALID = 14
};

Status of images returned from GetNextImage() call.

enum InferenceBoundingBoxType¶

enum SpinnakerNET::InferenceBoundingBoxType {
    RECTANGLE = 0,
    CIRCLE = 1,
    ROTATED_RECTANGLE = 2
};

Inference Bounding Box Type

enum ManagedLogType¶

enum SpinnakerNET::ManagedLogType {
    GENTL = 0,
    SPINNAKER,
    SPINNAKERNET,
    NONE
};

enum ManagedLoggingLevel¶

enum SpinnakerNET::ManagedLoggingLevel {
    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
};

typedef OnDeviceArrivalNative¶

typedef void(__stdcall * SpinnakerNET::OnDeviceArrivalNative) (Spinnaker::CameraPtr);

typedef OnDeviceEventNative¶

typedef void(__stdcall * SpinnakerNET::OnDeviceEventNative) (Spinnaker::GenICam::gcstring eventName);

typedef OnDeviceRemovalNative¶

typedef void(__stdcall * SpinnakerNET::OnDeviceRemovalNative) (Spinnaker::CameraPtr);

typedef OnImageEventNative¶

typedef void(__stdcall * SpinnakerNET::OnImageEventNative) (Spinnaker::ImagePtr image);

typedef OnInterfaceArrivalNative¶

typedef void(__stdcall * SpinnakerNET::OnInterfaceArrivalNative) (Spinnaker::InterfacePtr);

typedef OnInterfaceRemovalNative¶

typedef void(__stdcall * SpinnakerNET::OnInterfaceRemovalNative) (Spinnaker::InterfacePtr);

typedef OnLoggingEventNative¶

typedef void(__stdcall * SpinnakerNET::OnLoggingEventNative) (Spinnaker::LoggingEventDataPtr loggingEvent);

enum PolarizationQuadrant¶

enum SpinnakerNET::PolarizationQuadrant {
    QUADRANT_I0,
    QUADRANT_I45,
    QUADRANT_I90,
    QUADRANT_I135
};

enum StatisticsChannel¶

enum SpinnakerNET::StatisticsChannel {
    Grey,
    Red,
    Green,
    Blue,
    Hue,
    Saturation,
    Lightness,
    NumberOfStatisticsChannels
};

Channels that allow statistics to be calculated.

enum TIFFCompressionMethod¶

enum SpinnakerNET::TIFFCompressionMethod {
    None = 1,
    PackBits,
    Deflate,
    AdobeDeflate,
    CcittFax3,
    CcittFax4,
    Lzw,
    Jpeg
};

Compression method to use for encoding TIFF images.

enum TLPayloadType¶

enum SpinnakerNET::TLPayloadType {
    TLPAYLOAD_TYPE_UNKNOWN = 0,
    TLPAYLOAD_TYPE_IMAGE = 1,
    TLPAYLOAD_TYPE_RAW_DATA = 2,
    TLPAYLOAD_TYPE_FILE = 3,
    TLPAYLOAD_TYPE_CHUNK_DATA = 4,
    TLPAYLOAD_TYPE_JPEG = 5,
    TLPAYLOAD_TYPE_JPEG2000 = 6,
    TLPAYLOAD_TYPE_H264 = 7,
    TLPAYLOAD_TYPE_CHUNK_ONLY = 8,
    TLPAYLOAD_TYPE_DEVICE_SPECIFIC = 9,
    TLPAYLOAD_TYPE_MULTI_PART = 10,
    TLPAYLOAD_TYPE_CUSTOM_ID = 1000,
    TLPAYLOAD_TYPE_LOSSLESS_COMPRESSED = TLPAYLOAD_TYPE_CUSTOM_ID + 1,
    TLPAYLOAD_TYPE_LOSSY_COMPRESSED = TLPAYLOAD_TYPE_CUSTOM_ID + 2,
    TLPAYLOAD_TYPE_JPEG_LOSSLESS_COMPRESSED = TLPAYLOAD_TYPE_CUSTOM_ID + 3
};

Enumeration of TLType dependent payload types. Introduced in GenTL v1.2

enum TLPixelFormatNamespace¶

enum SpinnakerNET::TLPixelFormatNamespace {
    TLPIXELFORMAT_NAMESPACE_UNKNOWN = 0,
    TLPIXELFORMAT_NAMESPACE_GEV = 1,
    TLPIXELFORMAT_NAMESPACE_IIDC = 2,
    TLPIXELFORMAT_NAMESPACE_PFNC_16BIT = 3,
    TLPIXELFORMAT_NAMESPACE_PFNC_32BIT = 4,
    TLPIXELFORMAT_NAMESPACE_CUSTOM_ID = 1000
};

Public Functions Documentation¶

function ManagedLogEventCallback¶

delegate  void SpinnakerNET::ManagedLogEventCallback (
    SpinnakerNET::ManagedLoggingEventData ^ logEvent
)

function OnDeviceArrivalDelegate¶

delegate  void SpinnakerNET::OnDeviceArrivalDelegate (
    Spinnaker::CameraPtr
)

function OnDeviceEventDelegate¶

delegate  void SpinnakerNET::OnDeviceEventDelegate (
    Spinnaker::GenICam::gcstring eventName
)

function OnDeviceRemovalDelegate¶

delegate  void SpinnakerNET::OnDeviceRemovalDelegate (
    Spinnaker::CameraPtr
)

function OnImageEventDelegate¶

delegate  void SpinnakerNET::OnImageEventDelegate (
    Spinnaker::ImagePtr image
)

function OnInterfaceArrivalDelegate¶

delegate  void SpinnakerNET::OnInterfaceArrivalDelegate (
    Spinnaker::InterfacePtr
)

function OnInterfaceRemovalDelegate¶

delegate  void SpinnakerNET::OnInterfaceRemovalDelegate (
    Spinnaker::InterfacePtr
)

function OnLoggingEventDelegate¶

delegate  void SpinnakerNET::OnLoggingEventDelegate (
    Spinnaker::LoggingEventDataPtr loggingEvent
)

function ToManaged¶

inline ::System::String SpinnakerNET::ToManaged (
    const  char * str
)

function ToManaged¶

inline ::System::String SpinnakerNET::ToManaged (
    const  char * str,
    size_t len
)

function ToManaged¶

inline ::System::String SpinnakerNET::ToManaged (
    const Spinnaker::GenICam::gcstring & str
)

function ToNative¶

Spinnaker::GenICam::gcstring SpinnakerNET::ToNative (
    ::System::String ^ str
)

function is_node¶

template<typename T>
inline bool SpinnakerNET::is_node (
    void * pType
)

function is_node¶

template<typename T>
inline bool SpinnakerNET::is_node (
    IntPtr type
)

function node_cast¶

template<typename T>
inline T * SpinnakerNET::node_cast (
    void * pType
)

function node_cast¶

template<typename T>
inline T * SpinnakerNET::node_cast (
    IntPtr type
)

function type_cast¶

template<typename T>
inline T * SpinnakerNET::type_cast (
    void * pType
)

function type_cast¶

template<typename T>
inline T * SpinnakerNET::type_cast (
    IntPtr type
)

The documentation for this class was generated from the following file C:/workspace/src/SpinnakerNET/IManagedCamera.h