FLI libflipro API
/home/tom/projects/libflipro/libflipro/libflipro.h
Go to the documentation of this file.
1 
14 #ifdef __cplusplus
15 extern "C" {
16 #endif
17 
18 #ifndef _LIBFLIPRO_H_
19 #define _LIBFLIPRO_H_
21 
23 #ifdef __linux__
24 #include <wchar.h>
25 #include <stdarg.h>
26 #endif
27 #include "stdbool.h"
28 #include "stdint.h"
29 
30 // The following ifdef block is the standard way of creating macros which make exporting
31 // from a DLL simpler. All files within this DLL are compiled with the LIBFLIPRO_EXPORTS
32 // symbol defined on the command line. This symbol should not be defined on any project
33 // that uses this DLL. This way any other project whose source files include this file see
34 // LIBFLIPRO_API functions as being imported from a DLL, whereas this DLL sees symbols
35 // defined with this macro as being exported.
37 #if defined(_WIN32) || defined(_WINDOWS)
38 #ifdef LIBFLIPRO_EXPORTS
39 #define LIBFLIPRO_API __declspec(dllexport) int32_t
40 #define LIBFLIPRO_API_DATA __declspec(dllexport)
41 #define LIBFLIPRO_VOID __declspec(dllexport) void
42 #else
43 #define LIBFLIPRO_API __declspec(dllimport) int32_t
44 #define LIBFLIPRO_API_DATA __declspec(dllimport)
45 #define LIBFLIPRO_VOID __declspec(dllimport) void
46 #endif
47 
48 #endif
49 
50 #ifdef __linux__
51 #define LIBFLIPRO_API int32_t
52 #define LIBFLIPRO_API_DATA
53 #define LIBFLIPRO_VOID void
54 #endif
55 
58 // Typedefs, Defines, Macros
60 // Version information
62 #define FPRO_API_VERSION_MAJOR (1)
63 #define FPRO_API_VERSION_MINOR (12) // Should change if must change the Camera side as well
64 #define FPRO_API_VERSION_BUILD (59) // Minor changes not requiring Camera change
65 
67 //
68 // Some Helpful #defines
74 #define FPRO_IMAGE_FRAMEBYTES_TO_PIXELS(__framebytes) (((__framebytes) << 1) / 3)
75 #define FPRO_IMAGE_PIXELS_TO_FRAMEBYTES(__pixels) (((__pixels) & 0x1) ? ((((__pixels) * 3 ) >> 1) + 1) : (((__pixels) * 3 ) >> 1))
80 #define FPRO_IMAGE_DIMENSIONS_TO_FRAMEBYTES(__width,__height) FPRO_IMAGE_PIXELS_TO_FRAMEBYTES((__width) * (__height))
85 #define FPRO_REFERENCE_ROW_MAX (4094)
90 #define FPRO_THUMBNAIL_ROWS (512)
93 #define FPRO_THUMBNAIL_COLUMNS (512)
96 #define FPRO_GET_MAX_PIXEL_DEPTH(__pCapCam, __uiMax) { \
103  if (__pCapCam) \
104  { \
105  for (int __ix = 0; __ix < 32; ++__ix) \
106  if (__pCapCam->uiAvailablePixelDepths & (1 << __ix)) \
107  __uiMax = __ix + 1; \
108  } \
109  else \
110  { \
111  __uiMax = 12; \
112  } \
113  }
114 
115 
144 
145 typedef enum
146 {
150  FPRO_CAM_DEVICE_TYPE_GSENSE6060 = 0x01006060,
155  FPRO_CAM_DEVICE_TYPE_DC4320 = 0x03004320,
158 
160 
167 #define FPRO_USB_STRING_MAXLEN (256)
168 
175 #define FPRO_DEVICE_MAX_PATH_LENGTH (1024)
176 
190 typedef enum
191 {
195 
213 typedef enum
214 {
218 } FPROUSBSPEED;
219 
250 typedef struct device_info_t
251 {
256  uint32_t uiVendorId;
257  uint32_t uiProdId;
260 
261 
266 #define FPRO_VERSION_STRING_MAXLEN (32)
267 typedef struct device_version_info_t
285 {
291 
327 typedef enum
328 {
338 
339 
372 typedef enum
373 {
379 
399 typedef struct ext_trigger_info_t
400 {
403  bool bEnable;
405 
427 typedef enum
428 {
436 } FPRODBGLEVEL;
437 
438 
470 typedef enum
471 {
475 
476 } FPROGPSSTATE;
477 
500 typedef enum
501 {
508 
509 //
514 #define FPRO_SENSOR_MODE_NAME_LENGTH (32)
515 
532 typedef struct sensor_mode_t
533 {
534  uint32_t uiModeIndex;
536 } FPROSENSMODE;
537 
538 
544 #define FPRO_GAIN_SCALE_FACTOR (1000)
545 
564 typedef enum
565 {
568 
569  FPRO_GAIN_TABLE_CHANNEL_NUM,
570 } FPROGAINTABLE;
571 
584 typedef struct gain_value_t
585 {
586  uint32_t uiValue;
587  uint32_t uiDeviceIndex;
588 } FPROGAINVALUE;
589 
605 typedef enum
606 {
610 
611 // Camera Capabilities
612 #pragma pack(push, 1)
613 typedef struct camera_capabilities_t
647 {
648  uint32_t uiSize;
649  uint32_t uiCapVersion;
650  uint32_t uiDeviceType;
655  uint32_t uiBlackLevelMax;
656  uint32_t uiBlackSunMax;
657  uint32_t uiLowGain;
658  uint32_t uiHighGain;
659  uint32_t uiReserved;
660  uint32_t uiRowScanTime;
661  uint32_t uiDummyPixelNum;
667  uint32_t uiMetaDataSize;
668 
669 } FPROCAP;
670 #pragma pack(pop)
671 
672 
673 // Auxiliary I/O
691 typedef enum
692 {
697 } FPROAUXIO;
698 
712 typedef enum
713 {
716 } FPROAUXIO_DIR;
717 
731 typedef enum
732 {
736 
737 
753 typedef enum
754 {
758  FPRO_AUXIO_EXPTYPE_RESERVED
760 
761 
785 typedef enum
786 {
790 
792 
793 
825 typedef struct fpro_stream_stats_t
826 {
835  uint32_t uiReserved;
837 
851 {
852  uint32_t uiFrameNumber;
854 } FPROPREVIEW;
855 
877 typedef enum
878 {
885 
901 typedef enum
902 {
906 } FPROCMS;
907 
910 typedef struct crop_rect_t
911 {
912  uint32_t uiColumnOffset;
913  uint32_t uiRowOffset;
914  uint32_t uiWidth;
915  uint32_t uiHeight;
916 } FPRO_CROP;
918 
919 
957 typedef struct ref_frames_t
958 {
959  uint32_t uiWidth;
960  uint32_t uiHeight;
961 
967 
980 typedef enum
981 {
982  IFORMAT_NONE = 0,
987 
1004 typedef struct conv_info_t
1005 {
1007  wchar_t* pDSNUFile;
1008  wchar_t* pPRNUFile;
1009 } FPRO_CONV;
1010 
1026 typedef enum
1027 {
1031 
1033 
1034 
1065 typedef struct hw_merge_enables_t
1066 {
1071 
1087 typedef enum
1088 {
1091 } FPRO_MERGEALGO;
1092 
1142 typedef struct unpacked_images_t
1143 {
1144  uint8_t *pMetaData;
1145  uint32_t uiMetaDataSize;
1147 
1148  uint16_t *pLowImage;
1149  uint64_t uiLowImageSize;
1152 
1153  uint16_t *pHighImage;
1157 
1158  uint16_t *pMergedImage;
1162 
1164 
1167  FPRO_CROP cropRect;
1168  bool bRequestCrop;
1170 
1172 
1185 typedef struct int_point_t
1186 {
1187  int32_t X;
1188  int32_t Y;
1189 } FPROPOINT;
1190 
1203 typedef struct pixel_info_t
1204 {
1206  uint32_t uiValue;
1207 } FPROPIXELINFO;
1208 
1235 typedef struct image_plane_stats_t
1236 {
1237  uint32_t uiLCutoff;
1238  uint32_t uiUCutoff;
1240  double *pdblHistogram;
1241  double dblMean;
1242  double dblMedian;
1243  double dblMode;
1245 
1248 
1249 } FPROPLANESTATS;
1250 
1271 typedef struct unpacked_stats_t
1272 {
1275 
1278 
1281 
1283 
1285 // Camera Open, Close
1310 LIBFLIPRO_API FPROCam_GetCameraList(FPRODEVICEINFO *pDeviceInfo, uint32_t *pNumDevices);
1311 
1323 LIBFLIPRO_API FPROCam_GetDeviceInfo(int32_t iHandle, FPRODEVICEINFO* pDeviceInfo);
1324 
1338 LIBFLIPRO_API FPROCam_Open(FPRODEVICEINFO *pDevInfo, int32_t *pHandle);
1339 
1340 
1348 LIBFLIPRO_API FPROCam_Close(int32_t iHandle);
1349 
1362 LIBFLIPRO_API FPROCam_GetAPIVersion(wchar_t *pVersion, uint32_t uiLength);
1363 
1372 LIBFLIPRO_API FPROCam_GetDeviceVersion(int32_t iHandle, FPRODEVICEVERS *pVersion);
1373 
1385 LIBFLIPRO_API FPROCam_GetHostSerialNumbers(int32_t iHandle, wchar_t *pFibre, wchar_t *pPcie, uint32_t uiLength);
1386 
1387 
1390 // Frame Data Functions
1406 LIBFLIPRO_API FPROFrame_CaptureAbort(int32_t iHandle);
1407 
1425 //LIBFLIPRO_API FPROFrame_CaptureEnd(int32_t iHandle);
1427 
1451 LIBFLIPRO_API FPROFrame_CaptureStart(int32_t iHandle, uint32_t uiFrameCount);
1452 
1473 LIBFLIPRO_API FPROFrame_CaptureStop(int32_t iHandle);
1474 
1475 
1488 LIBFLIPRO_API FPROFrame_CaptureThumbnail(int32_t iHandle);
1489 
1511 LIBFLIPRO_API FPROFrame_ComputeFrameSize(int32_t iHandle);
1512 
1529 LIBFLIPRO_API FPROFrame_ComputeFrameSizePixels(int32_t iHandle, uint32_t *pTotalWidth, uint32_t *pTotalHeight);
1530 
1540 LIBFLIPRO_VOID FPROFrame_FreeUnpackedBuffers(FPROUNPACKEDIMAGES *pUPBuffers);
1541 
1551 LIBFLIPRO_VOID FPROFrame_FreeUnpackedStatistics(FPROUNPACKEDSTATS *pStats);
1552 
1565 LIBFLIPRO_API FPROFrame_GetDummyPixelEnable(int32_t iHandle, bool *pEnable);
1566 
1580 LIBFLIPRO_API FPROFrame_GetFrameType(int32_t iHandle, FPRO_FRAME_TYPE *pType);
1581 
1593 LIBFLIPRO_API FPROFrame_GetReferenceRowPostFrameCount(int32_t iHandle, uint32_t *pNumRows);
1594 
1606 LIBFLIPRO_API FPROFrame_GetReferenceRowPreFrameCount(int32_t iHandle, uint32_t *pNumRows);
1607 
1621 LIBFLIPRO_API FPROFrame_GetImageDataEnable(int32_t iHandle, bool *pEnable);
1622 
1636 LIBFLIPRO_API FPROFrame_GetTestImageEnable(int32_t iHandle, bool *pEnable, FPROTESTIMAGETYPE *pFormat);
1637 
1651 LIBFLIPRO_API FPROFrame_GetImageArea(int32_t iHandle, uint32_t *pColOffset, uint32_t *pRowOffset, uint32_t *pWidth, uint32_t *pHeight);
1652 
1662 LIBFLIPRO_API FPROFrame_GetPixelConfig(int32_t iHandle, uint32_t *pPixelDepth, uint32_t *pPixelLSB);
1663 
1664 
1680 LIBFLIPRO_API FPROFrame_GetThumbnailFrame(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize);
1681 
1715 LIBFLIPRO_API FPROFrame_GetVideoFrame(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize, uint32_t uiTimeoutMS);
1716 
1717 
1770 LIBFLIPRO_API FPROFrame_GetVideoFrameUnpacked(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize, uint32_t uiTimeoutMS, FPROUNPACKEDIMAGES *pUPBuffers, FPROUNPACKEDSTATS *pStats);
1771 
1801 LIBFLIPRO_API FPROFrame_GetVideoFrameExt(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize);
1802 
1828 LIBFLIPRO_API FPROFrame_UnpackFile(wchar_t* pFileName, FPROUNPACKEDIMAGES* pUPBuffers, FPROUNPACKEDSTATS* pStats);
1829 
1849 LIBFLIPRO_API FPROFrame_UnpackFileEx(wchar_t* pFileName, FPROUNPACKEDIMAGES* pUPBuffers, FPROUNPACKEDSTATS* pStats, const wchar_t* pDSNUFile, const wchar_t* pPRNUFile);
1850 
1851 
1871 LIBFLIPRO_API FPROFrame_ConvertFile(wchar_t* pInRcdFile, FPRO_CONV* pConvInfo, wchar_t *pOutFile);
1874 LIBFLIPRO_API FPROFrame_ConvertFileEx(wchar_t* pInRcdFile, FPRO_CONV* pConvInfo, FPROUNPACKEDIMAGES* pUPBuffers, FPROUNPACKEDSTATS* pStats);
1876 
1892 LIBFLIPRO_API FPROFrame_MetaDataToString(wchar_t* pFileName, wchar_t *pMetaString, uint32_t uiMaxSize);
1893 
1912 LIBFLIPRO_API FPROFrame_IsAvailable(int32_t iHandle, bool *pAvailable);
1913 
1928 LIBFLIPRO_API FPROFrame_SetDummyPixelEnable(int32_t iHandle, bool bEnable);
1929 
1943 LIBFLIPRO_API FPROFrame_SetFrameType(int32_t iHandle, FPRO_FRAME_TYPE eType);
1944 
1956 LIBFLIPRO_API FPROFrame_SetReferenceRowPostFrameCount(int32_t iHandle, uint32_t uiNumRows);
1957 
1969 LIBFLIPRO_API FPROFrame_SetReferenceRowPreFrameCount(int32_t iHandle, uint32_t uiNumRows);
1970 
1984 LIBFLIPRO_API FPROFrame_SetImageDataEnable(int32_t iHandle, bool bEnable);
1985 
2000 LIBFLIPRO_API FPROFrame_SetTestImageEnable(int32_t iHandle, bool bEnable, FPROTESTIMAGETYPE eFormat);
2001 
2018 LIBFLIPRO_API FPROFrame_SetTrackingArea(int32_t iHandle, uint32_t uiStartRow, uint32_t uiEndRow);
2019 
2034 LIBFLIPRO_API FPROFrame_SetTrackingAreaEnable (int32_t iHandle, uint32_t uiNumTrackingFrames);
2035 
2045 LIBFLIPRO_API FPROFrame_SetPixelConfig(int32_t iHandle, uint32_t uiPixelDepth, uint32_t uiPixelLSB);
2046 
2060 LIBFLIPRO_API FPROFrame_SetImageArea(int32_t iHandle, uint32_t uiColOffset, uint32_t uiRowOffset, uint32_t uiWidth, uint32_t uiHeight);
2061 
2090 LIBFLIPRO_API FPROFrame_SetUnpackingBiasFrames(int32_t iHandle, uint32_t uiWidth, uint32_t uiHeight, uint16_t *pLowFrame, uint16_t *pHighFrame);
2091 
2119 LIBFLIPRO_API FPROFrame_SetUnpackingFlatFieldFrames(int32_t iHandle, uint32_t uiWidth, uint32_t uiHeight, uint16_t *pLowFrame, uint16_t *pHighFrame);
2120 
2121 
2142 LIBFLIPRO_API FPROFrame_StreamInitialize(int32_t iHandle, uint32_t uiFrameSizeBytes, wchar_t *pRootPath, wchar_t *pFilePrefix);
2143 
2154 LIBFLIPRO_API FPROFrame_StreamDeinitialize(int32_t iHandle);
2155 
2179 LIBFLIPRO_API FPROFrame_StreamStart(int32_t iHandle,uint32_t uiFrameCount,uint64_t uiFrameIntervalMS);
2180 
2190 LIBFLIPRO_API FPROFrame_StreamStop(int32_t iHandle);
2191 
2202 LIBFLIPRO_API FPROFrame_StreamGetStatistics(int32_t iHandle, FPROSTREAMSTATS *pStats);
2203 
2227 LIBFLIPRO_API FPROFrame_StreamGetPreviewImage(int32_t iHandle, uint8_t* pImage, uint32_t* pLength, uint32_t uiTimeoutMSecs);
2228 
2229 
2248 LIBFLIPRO_API FPROFrame_StreamGetPreviewImageEx(int32_t iHandle, uint8_t* pImage, uint32_t* pLength, FPROPREVIEW *pInfo, uint32_t uiTimeoutMSecs);
2249 
2250 
2253 // Control Functions
2256 
2267 LIBFLIPRO_API FPROCtrl_GetBurstModeEnable(int32_t iHandle, bool *pEnable);
2268 
2277 LIBFLIPRO_API FPROCtrl_GetCoolerDutyCycle(int32_t iHandle, uint32_t *pDutyCycle);
2278 
2306 LIBFLIPRO_API FPROCtrl_GetCameraBufferBypass(int32_t iHandle, bool* pCameraBypassEnable, bool* pHostBypassEnable);
2307 
2324 LIBFLIPRO_API FPROCtrl_GetElectricallyBlackPixelEnable(int32_t iHandle, bool* pEnable);
2325 
2358 LIBFLIPRO_API FPROCtrl_GetExposure(int32_t iHandle, uint64_t *pExposureTime, uint64_t *pFrameDelay, bool *pImmediate);
2359 
2360 
2369 LIBFLIPRO_API FPROCtrl_GetExternalTriggerEnable(int32_t iHandle, FPROEXTTRIGINFO* pTrigInfo);
2370 
2371 
2380 LIBFLIPRO_API FPROCtrl_GetFanEnable(int32_t iHandle, bool *pOn);
2381 
2391 LIBFLIPRO_API FPROCtrl_GetGPSState(int32_t iHandle, FPROGPSSTATE *pState);
2392 
2401 LIBFLIPRO_API FPROCtrl_GetHeaterPower(int32_t iHandle, uint32_t *pPwrPercentage);
2402 
2413 LIBFLIPRO_API FPROCtrl_GetIlluminationDelay(int32_t iHandle, uint32_t *pOnDelay, uint32_t *pOffDelay);
2414 
2423 LIBFLIPRO_API FPROCtrl_GetIlluminationOn(int32_t iHandle, bool *pOn);
2424 
2436 LIBFLIPRO_API FPROCtrl_GetLED(int32_t iHandle, bool *pOn);
2437 
2458 LIBFLIPRO_API FPROCtrl_GetLEDDuration(int32_t iHandle, uint32_t *pDurationUsec);
2459 
2479 LIBFLIPRO_API FPROCtrl_GetPCIETemperatures(int32_t iHandle, double* pPcieFpga, double *pFibreFpga);
2480 
2495 LIBFLIPRO_API FPROCtrl_GetSensorTemperature(int32_t iHandle, int32_t *pTemp);
2496 
2508 LIBFLIPRO_API FPROCtrl_GetSensorTemperatureReadEnable(int32_t iHandle, bool *pEnable);
2509 
2510 
2524 LIBFLIPRO_API FPROCtrl_GetShutterOpen(int32_t iHandle, bool *pOpen);
2525 
2538 LIBFLIPRO_API FPROCtrl_GetShutterOverride(int32_t iHandle, bool *pOverride);
2539 
2550 LIBFLIPRO_API FPROCtrl_GetTemperatures(int32_t iHandle, double *pAmbientTemp, double *pBaseTemp, double *pCoolerTemp);
2551 
2560 LIBFLIPRO_API FPROCtrl_GetTemperatureSetPoint(int32_t iHandle, double *pSetPoint);
2561 
2580 LIBFLIPRO_API FPROCtrl_SetBurstModeEnable(int32_t iHandle, bool bEnable);
2581 
2600 LIBFLIPRO_API FPROCtrl_SetCameraBufferBypass(int32_t iHandle, bool bCameraBypassEnable, bool bHostBypassEnable);
2601 
2615 LIBFLIPRO_API FPROCtrl_SetElectricallyBlackPixelEnable(int32_t iHandle, bool bEnable);
2616 
2651 LIBFLIPRO_API FPROCtrl_SetExposure(int32_t iHandle, uint64_t uiExposureTime, uint64_t uiFrameDelay, bool bImmediate);
2652 
2693 LIBFLIPRO_API FPROCtrl_SetExposureEx(int32_t iHandle, uint64_t uiExposureTime, uint64_t uiFrameDelay, bool bImmediate, uint64_t* pActualExposureTime, uint64_t* pActualFrameDelay);
2694 
2704 LIBFLIPRO_API FPROCtrl_SetExternalTriggerEnable(int32_t iHandle, uint32_t uiFrameCount, FPROEXTTRIGINFO *pTrigInfo);
2705 
2714 LIBFLIPRO_API FPROCtrl_SetFanEnable(int32_t iHandle, bool bOn);
2715 
2724 LIBFLIPRO_API FPROCtrl_SetHeaterPower(int32_t iHandle,uint32_t uiPwrPercentage);
2725 
2739 LIBFLIPRO_API FPROCtrl_SetIlluminationDelay(int32_t iHandle, uint16_t uiOnDelay, uint16_t uiOffDelay);
2740 
2749 LIBFLIPRO_API FPROCtrl_SetIlluminationOn(int32_t iHandle, bool bOn);
2750 
2765 LIBFLIPRO_API FPROCtrl_SetLED(int32_t iHandle, bool bOn);
2766 
2786 LIBFLIPRO_API FPROCtrl_SetLEDDuration(int32_t iHandle, uint32_t uiDurationUSec);
2787 
2806 LIBFLIPRO_API FPROCtrl_SetSensorTemperatureReadEnable(int32_t iHandle, bool bEnable);
2807 
2808 
2822 LIBFLIPRO_API FPROCtrl_SetShutterOpen(int32_t iHandle, bool bOpen);
2823 
2836 LIBFLIPRO_API FPROCtrl_SetShutterOverride(int32_t iHandle, bool bOverride);
2837 
2846 LIBFLIPRO_API FPROCtrl_SetTemperatureSetPoint(int32_t iHandle, double dblSetPoint);
2847 
2849 // Sensor Functions
2862 LIBFLIPRO_API FPROSensor_GetBinning(int32_t iHandle, uint32_t *pXBin, uint32_t *pYBin);
2863 
2894 LIBFLIPRO_API FPROSensor_GetBinningTable(int32_t iHandle, uint32_t *pBinTable, uint32_t *pTableSizeBytes);
2895 
2914 LIBFLIPRO_API FPROSensor_GetBlackLevelAdjust(int32_t iHandle, uint32_t *pAdjustValue);
2915 
2928 LIBFLIPRO_API FPROSensor_GetBlackLevelAdjustEx(int32_t iHandle, FPROBLACKADJUSTCHAN eChan, uint32_t *pAdjustValue);
2929 
2948 LIBFLIPRO_API FPROSensor_GetBlackSunAdjust(int32_t iHandle, uint32_t *pAdjustValue);
2949 
2962 LIBFLIPRO_API FPROSensor_GetBlackSunAdjustEx(int32_t iHandle, FPROBLACKADJUSTCHAN eChan, uint32_t *pAdjustValue);
2963 
2990 LIBFLIPRO_API FPROSensor_GetCapabilities(int32_t iHandle, FPROCAP *pCap, uint32_t *pCapLength);
2991 
3004 LIBFLIPRO_API FPROSensor_GetGainIndex(int32_t iHandle, FPROGAINTABLE eTable, uint32_t *pGainIndex);
3005 
3023 LIBFLIPRO_API FPROSensor_GetGainTable(int32_t iHandle, FPROGAINTABLE eTable, FPROGAINVALUE *pGainValues, uint32_t *pNumEntries);
3024 
3040 LIBFLIPRO_API FPROSensor_GetHDREnable(int32_t iHandle, bool* pHDREnable);
3041 
3042 
3055 LIBFLIPRO_API FPROSensor_GetHighGainOnlyEnable(int32_t iHandle, bool *pHighGainOnly);
3056 
3068 LIBFLIPRO_API FPROSensor_GetMode(int32_t iHandle, uint32_t uiModeIndex, FPROSENSMODE *pMode);
3069 
3082 LIBFLIPRO_API FPROSensor_GetModeCount(int32_t iHandle, uint32_t *pCount,uint32_t *pCurrentMode);
3083 
3096 LIBFLIPRO_API FPROSensor_GetReadoutConfiguration(int32_t iHandle, FPROSENSREADCFG *pReadCfg);
3097 
3110 LIBFLIPRO_API FPROSensor_GetSamplesPerPixel(int32_t iHandle, FPROCMS *pSamplesPerPixel);
3111 
3121 LIBFLIPRO_API FPROSensor_GetScanDirection(int32_t iHandle, bool *pHInverted,bool *pVInverted);
3122 
3132 LIBFLIPRO_API FPROSensor_GetTrainingEnable(int32_t iHandle, bool *pEnable);
3133 
3147 LIBFLIPRO_API FPROSensor_SetAnalogGain(int32_t iHandle, int32_t iGainValue);
3148 
3158 LIBFLIPRO_API FPROSensor_SetBinning(int32_t iHandle, uint32_t uiXBin, uint32_t uiYBin);
3159 
3178 LIBFLIPRO_API FPROSensor_SetBlackLevelAdjust(int32_t iHandle, uint32_t uiAdjustValue);
3179 
3180 
3192 LIBFLIPRO_API FPROSensor_SetBlackLevelAdjustEx(int32_t iHandle, FPROBLACKADJUSTCHAN eChan, uint32_t uiAdjustValue);
3193 
3211 LIBFLIPRO_API FPROSensor_SetBlackSunAdjust(int32_t iHandle, uint32_t uiAdjustValue);
3212 
3213 
3225 LIBFLIPRO_API FPROSensor_SetBlackSunAdjustEx(int32_t iHandle, FPROBLACKADJUSTCHAN eChan, uint32_t uiAdjustValue);
3226 
3239 LIBFLIPRO_API FPROSensor_SetHighGainOnlyEnable(int32_t iHandle, bool bHighGainOnly);
3240 
3259 LIBFLIPRO_API FPROSensor_SetGainIndex(int32_t iHandle, FPROGAINTABLE eTable, uint32_t uiGainIndex);
3260 
3269 LIBFLIPRO_API FPROSensor_SetMode(int32_t iHandle, uint32_t uiModeIndex);
3270 
3284 LIBFLIPRO_API FPROSensor_SetReadoutConfiguration(int32_t iHandle, FPROSENSREADCFG eReadCfg);
3285 
3298 LIBFLIPRO_API FPROSensor_SetSamplesPerPixel(int32_t iHandle, FPROCMS eSamplesPerPixel);
3299 
3309 LIBFLIPRO_API FPROSensor_SetScanDirection(int32_t iHandle, bool bHInverted, bool bVInverted);
3310 
3320 LIBFLIPRO_API FPROSensor_SetTrainingEnable(int32_t iHandle, bool bEnable);
3321 
3322 
3324 // Auxiliary I/O Support Functions
3340 LIBFLIPRO_API FPROAuxIO_GetPin(int32_t iHandle, FPROAUXIO eAuxIO, FPROAUXIO_DIR *pDirection, FPROAUXIO_STATE *pState);
3341 
3355 LIBFLIPRO_API FPROAuxIO_GetExposureActivePolarity(int32_t iHandle, bool *pActiveHigh);
3356 
3368 LIBFLIPRO_API FPROAuxIO_GetExposureActiveType(int32_t iHandle, FPROAUXIO_EXPACTIVETYPE *pType);
3369 
3383 LIBFLIPRO_API FPROAuxIO_SetPin(int32_t iHandle, FPROAUXIO eAuxIO, FPROAUXIO_DIR eDirection, FPROAUXIO_STATE eState);
3384 
3398 LIBFLIPRO_API FPROAuxIO_SetExposureActivePolarity(int32_t iHandle, bool bActiveHigh);
3399 
3411 LIBFLIPRO_API FPROAuxIO_SetExposureActiveType(int32_t iHandle, FPROAUXIO_EXPACTIVETYPE eType);
3412 
3413 
3415 // Frame Acknowledgment Mode Support Functions
3438 LIBFLIPRO_API FPROFAck_GetEnable(int32_t iHandle, bool *pEnable);
3439 
3452 LIBFLIPRO_API FPROFAck_SetEnable(int32_t iHandle, bool bEnable);
3453 
3464 LIBFLIPRO_API FPROFAck_FrameAcknowledge(int32_t iHandle);
3465 
3466 
3483 LIBFLIPRO_API FPROFAck_FrameResend(int32_t iHandle);
3484 
3497 LIBFLIPRO_API FPROFAck_FlushImageQueue(int32_t iHandle);
3498 
3518 LIBFLIPRO_API FPROAlgo_StackInitialize(int32_t iHandle);
3519 
3540 LIBFLIPRO_API FPROAlgo_StackNextFrame(int32_t iHandle, uint8_t* pFrameData, uint32_t* pSize, uint32_t uiTimeoutMS);
3541 
3570 LIBFLIPRO_API FPROAlgo_StackFinish(int32_t iHandle, uint16_t **ppLowMeanFrame, uint16_t **ppHighMeanFrame, uint32_t* pNumPixels, uint8_t** ppMetaData, uint32_t* puiMetaSize);
3571 
3585 LIBFLIPRO_API FPROAlgo_StackDeinitialize(int32_t iHandle);
3586 
3602 LIBFLIPRO_API FPROAlgo_SetHardwareMergeReferenceFrames(int32_t iHandle, FPRO_REFFRAMES* pRefFrames);
3603 
3629 LIBFLIPRO_API FPROAlgo_SetHardwareMergeReferenceFiles(int32_t iHandle, const wchar_t *pDSNUFile, const wchar_t *pPRNUFile);
3630 
3644 LIBFLIPRO_API FPROAlgo_GetHardwareMergeThresholds(int32_t iHandle, uint16_t *pHighGainThreshold, uint16_t*pMergeDifferenceThreshold);
3645 
3661 LIBFLIPRO_API FPROAlgo_SetHardwareMergeThresholds(int32_t iHandle, uint16_t uiHighGainThreshold, uint16_t uiMergeDifferenceThreshold);
3662 
3675 LIBFLIPRO_API FPROAlgo_GetHardwareMergeEnables(int32_t iHandle, FPRO_HWMERGEENABLE *pMergeEnables);
3676 
3677 
3690 LIBFLIPRO_API FPROAlgo_SetHardwareMergeEnables(int32_t iHandle, FPRO_HWMERGEENABLE mergeEnables);
3691 
3692 
3694 LIBFLIPRO_API FPROAlgo_MergeRcdToFits(wchar_t *pRCDFileName, wchar_t *pDSNURef, wchar_t *pPRNURef);
3696 
3698 // NV Storage Functions
3721 LIBFLIPRO_API FPRONV_WriteNVStorage(int32_t iHandle,uint32_t uiOffset, uint8_t *pData, uint32_t uiLength);
3722 
3737 LIBFLIPRO_API FPRONV_ReadNVStorage(int32_t iHandle, uint32_t uiOffset, uint8_t *pData, uint32_t uiLength);
3738 
3740 // Low level commands and functions
3743 LIBFLIPRO_API FPROCmd_SendRaw(int32_t iHandle, uint8_t *pData, uint32_t uiLength);
3745 LIBFLIPRO_API FPROCmd_SendRecvRaw(int32_t iHandle, uint8_t *pTxData, uint32_t uiTxLength, uint8_t *pRxData, uint32_t *pRxLength);
3747 LIBFLIPRO_API FPROCmd_ReadReg(int32_t iHandle, uint32_t uiReg, uint32_t *pValue);
3749 LIBFLIPRO_API FPROCmd_WriteReg(int32_t iHandle, uint32_t uiReg, uint32_t uiValue, uint32_t uiMask);
3751 LIBFLIPRO_API FPROCmd_PCIEReadReg(int32_t iHandle, uint32_t uiReg, uint32_t* pValue);
3753 LIBFLIPRO_API FPROCmd_PCIEWriteReg(int32_t iHandle, uint32_t uiReg, uint32_t uiValue);
3754 
3755 // Debug Functions
3757 // Conversion strings to aid in debug printing
3758 // The Linux part is different because of the way
3759 // swprintf() works- when %s is used, the argument is
3760 // assumed to be a char pointer. Hence we do not make it wide.
3761 #if defined(WIN32) || defined(_WINDOWS)
3762 #define STRINGIFY(x) L##x
3763 #define MAKEWIDE(x) STRINGIFY(x)
3764 #else
3765 #define MAKEWIDE(x) (x)
3766 #endif
3767 
3777 LIBFLIPRO_API FPRODebug_EnableLevel(bool bEnable, FPRODBGLEVEL eLevel);
3785 LIBFLIPRO_API FPRODebug_SetLogPath(const wchar_t *pPath);
3786 #ifdef WIN32
3787 LIBFLIPRO_VOID _cdecl FPRODebug_Write(FPRODBGLEVEL eLevel, const wchar_t *format, ...);
3798 #else
3799 LIBFLIPRO_VOID FPRODebug_Write(FPRODBGLEVEL eLevel, const wchar_t *format, ...);
3810 #endif
3811 
3812 
3813 
3814 
3815 #endif // _LIBFLIPRO_H_
3816 
3817 #ifdef __cplusplus
3818 }
3819 
3820 #endif
LIBFLIPRO_API FPROFAck_SetEnable(int32_t iHandle, bool bEnable)
Set Frame Acknowledgment Mode Enable.
LIBFLIPRO_API FPROFrame_CaptureStop(int32_t iHandle)
Stops the active image capture.
double dblMedian
The median of the pixel values in the plane.
Definition: libflipro.h:1242
Emulates the hardware merge algorithm found on the FLI PCIE Fibre cards. Reference frames are require...
Definition: libflipro.h:1090
LIBFLIPRO_API FPROFrame_GetDummyPixelEnable(int32_t iHandle, bool *pEnable)
Retrieves the dummy pixel configuration to be appended row data.
LIBFLIPRO_API FPROCtrl_SetLEDDuration(int32_t iHandle, uint32_t uiDurationUSec)
Set LED Duration during exposure.
Read data using the bottom left channel of the sensor.
Definition: libflipro.h:502
int16_t * pAdditiveHighGain
High Gain Additive Reference Frame.
Definition: libflipro.h:963
LIBFLIPRO_API FPROFrame_StreamStart(int32_t iHandle, uint32_t uiFrameCount, uint64_t uiFrameIntervalMS)
Start the streaming operation.
bool bMetaDataRequest
The Meta Data request Flag. Set to &#39;true&#39; to unpack meta data.
Definition: libflipro.h:1146
LIBFLIPRO_API FPROSensor_SetMode(int32_t iHandle, uint32_t uiModeIndex)
Sets the current mode specified by the given index.
Exposure Active High For this setting, the exposure is active the entire time the external trigger s...
Definition: libflipro.h:376
Enum value = 0x04000F1F.
Definition: libflipro.h:157
FPROEXTTRIGTYPE
External Trigger Types.
Definition: libflipro.h:372
Definition: libflipro.h:1142
LIBFLIPRO_API FPROSensor_SetAnalogGain(int32_t iHandle, int32_t iGainValue)
Sets the analog gain for the sensor.
bool bMergedRequest
Set to true to request the statistics for this image plane when unpacking.
Definition: libflipro.h:1280
Definition: libflipro.h:1065
bool bEnable
True= enable the external trigger. False= disable the external trigger.
Definition: libflipro.h:403
LIBFLIPRO_API FPROCtrl_SetIlluminationOn(int32_t iHandle, bool bOn)
Turns External Illumination on or off.
LIBFLIPRO_API FPROCam_GetHostSerialNumbers(int32_t iHandle, wchar_t *pFibre, wchar_t *pPcie, uint32_t uiLength)
Returns the version information from the connected device.
Definition: libflipro.h:584
uint32_t uiLCutoff
The lower pixel value cutoff.
Definition: libflipro.h:1237
struct image_plane_stats_t FPROPLANESTATS
Defines the set of statistics available for unpacked frames.
FPROAUXIO_EXPACTIVETYPE
Exposure Active Auxiliary Output.
Definition: libflipro.h:753
LIBFLIPRO_API FPROCtrl_GetIlluminationDelay(int32_t iHandle, uint32_t *pOnDelay, uint32_t *pOffDelay)
Gets the delay between setting the Illumination on/off via FPROCtrl_SetIlluminationOn() and when the ...
bool bLowImageRequest
The Low Image request Flag. Set to &#39;true&#39; to unpack the low gain image plane.
Definition: libflipro.h:1151
Definition: libflipro.h:825
wchar_t cFriendlyName[FPRO_USB_STRING_MAXLEN]
Human readable friendly name of the USB device. This string along with the cSerialNo field provide a ...
Definition: libflipro.h:252
Definition: libflipro.h:250
Enum value = 0x01004040.
Definition: libflipro.h:149
LIBFLIPRO_API FPROFrame_CaptureThumbnail(int32_t iHandle)
Initiates the capture of a thumbnail image.
Two sensor samples per pixel are read out.
Definition: libflipro.h:904
LIBFLIPRO_API FPROSensor_SetBlackSunAdjustEx(int32_t iHandle, FPROBLACKADJUSTCHAN eChan, uint32_t uiAdjustValue)
Sets the current Black Sun Adjustment value for the given channel.
LIBFLIPRO_API FPROFrame_GetReferenceRowPostFrameCount(int32_t iHandle, uint32_t *pNumRows)
Retrieves the reference row count to be appended to frame data.
uint32_t uiPostFrameReferenceRows
Number of Post-Frame Reference rows available.
Definition: libflipro.h:666
FPROUSBSPEED eUSBSpeed
The USB connection speed of the device. This field is applicable only when the eCOnnType is FPRO_CONN...
Definition: libflipro.h:258
FPROPOINT ptPosition
The x and y coordinate of the pixel within the plane.
Definition: libflipro.h:1205
LIBFLIPRO_API FPROCtrl_GetIlluminationOn(int32_t iHandle, bool *pOn)
Returns the setting of External Illumination- on or off.
uint32_t uiMaxPixelImageHeight
max allowed image height in pixels
Definition: libflipro.h:652
bool bSingleFramePerTrigger
Default behavior of the external trigger gets uiFrameCount images. Setting this ensures only a single...
Definition: libflipro.h:402
IMX183 Sensor Repeating Low High Test Pattern. All pixels are 0x555.
Definition: libflipro.h:335
LIBFLIPRO_API FPROFrame_IsAvailable(int32_t iHandle, bool *pAvailable)
Returns whether or not Image Frame data is ready for retrieval.
double dblOverallFramesPerSec
The overall frames per second received by the streamer. Note this depends on actual frame rate from t...
Definition: libflipro.h:832
LIBFLIPRO_API FPROSensor_SetTrainingEnable(int32_t iHandle, bool bEnable)
Enables/Disables sensor re-training.
INFO, WARNING, and ERROR debug is output.
Definition: libflipro.h:432
LIBFLIPRO_API FPROCtrl_GetShutterOverride(int32_t iHandle, bool *pOverride)
Gets the current shutter override setting.
LIBFLIPRO_API FPROCtrl_SetTemperatureSetPoint(int32_t iHandle, double dblSetPoint)
Sets the Base Temperature Set Point.
LIBFLIPRO_API FPROCtrl_GetSensorTemperatureReadEnable(int32_t iHandle, bool *pEnable)
Returns the &#39;read sensor temperature during exposure&#39; enabled flag.
struct device_info_t FPRODEVICEINFO
Device Information.
uint32_t uiDummyPixelNum
Number of Pre and Post Row Dummy Pixels when enabled. See FPROFrame_SetDummyPixelEnable.
Definition: libflipro.h:661
Only ERROR level debug is output.
Definition: libflipro.h:430
uint32_t uiUCutoff
The Upper pixel value cutoff.
Definition: libflipro.h:1238
LIBFLIPRO_API FPROFrame_GetFrameType(int32_t iHandle, FPRO_FRAME_TYPE *pType)
Retrieves the Frame Type setting.
Specifies the HDR Black adjust channel. NOTE: Not supported on all devices. See your specific device...
Definition: libflipro.h:608
Definition: libflipro.h:1004
LIBFLIPRO_API FPROFrame_SetTestImageEnable(int32_t iHandle, bool bEnable, FPROTESTIMAGETYPE eFormat)
Enables test image data to be generated rather than normal image data.
LIBFLIPRO_API FPROSensor_GetSamplesPerPixel(int32_t iHandle, FPROCMS *pSamplesPerPixel)
Retrieves the Samples Per Pixel settings on the sensor. NOTE: This function is not supported on on...
Definition: libflipro.h:1235
DEBUG, REGRW, INFO, WARNING, and ERROR debug is output.
Definition: libflipro.h:434
LIBFLIPRO_API FPRONV_WriteNVStorage(int32_t iHandle, uint32_t uiOffset, uint8_t *pData, uint32_t uiLength)
Write the given data to the non volatile storage area on the camera.
uint16_t * pMergedImage
The Merged Image Buffer.
Definition: libflipro.h:1158
LIBFLIPRO_API FPROSensor_SetBinning(int32_t iHandle, uint32_t uiXBin, uint32_t uiYBin)
Sets the desired horizontal and vertical binning.
Dark Flash Frame.
Definition: libflipro.h:883
LIBFLIPRO_API FPROFrame_SetFrameType(int32_t iHandle, FPRO_FRAME_TYPE eType)
Sets Frame Type produced by the camera.
wchar_t cFirmwareVersion[FPRO_VERSION_STRING_MAXLEN]
The version of firmware on the internal device processor.
Definition: libflipro.h:286
wchar_t cDevicePath[FPRO_DEVICE_MAX_PATH_LENGTH]
The OS device Path. Used internally by the API for opening requisite file descriptors to connect to t...
Definition: libflipro.h:254
uint16_t * pMultiplicativeHighGain
High Gain Multiply Reference Frame.
Definition: libflipro.h:965
GPS unit has not been detected by the camera.
Definition: libflipro.h:472
#define FPRO_SENSOR_MODE_NAME_LENGTH
Sensor Mode Name Length.
Definition: libflipro.h:514
wchar_t cFPGAVersion[FPRO_VERSION_STRING_MAXLEN]
The version of firmware on the internal FPGA device.
Definition: libflipro.h:287
FPRO_IMAGE_FORMAT eFormat
File format for the converted frame.
Definition: libflipro.h:1006
GPS unit has been detected by the camera and the satellite lock has been made. This is the only value...
Definition: libflipro.h:474
LIBFLIPRO_API FPROAuxIO_GetPin(int32_t iHandle, FPROAUXIO eAuxIO, FPROAUXIO_DIR *pDirection, FPROAUXIO_STATE *pState)
Gets the direction and state for given Auxiliary I/O pin.
LIBFLIPRO_API FPROSensor_SetBlackLevelAdjust(int32_t iHandle, uint32_t uiAdjustValue)
Sets the current Black Level Adjustment values.
TIFF Formatted image.
Definition: libflipro.h:984
Read data using the top right channel of the sensor.
Definition: libflipro.h:505
double dblDiskAvgMBPerSec
The average disk write rate in MBytes/sec on a per frame basis.
Definition: libflipro.h:830
uint32_t uiValue
The actual gain value.
Definition: libflipro.h:586
LIBFLIPRO_API FPROFrame_StreamGetPreviewImage(int32_t iHandle, uint8_t *pImage, uint32_t *pLength, uint32_t uiTimeoutMSecs)
Retrieve the next image available for preview from the image stream.
wchar_t * pDSNUFile
DSNU Reference file (may be NULL).
Definition: libflipro.h:1007
FPROBLACKADJUSTCHAN
Black Adjust Channels.
Definition: libflipro.h:605
uint32_t uiSize
Size of this structure (including uiSize)
Definition: libflipro.h:648
uint32_t uiReserved
Reserved for internal use.
Definition: libflipro.h:835
uint32_t uiBlackSunMax
Max Value Allowed (see FPROSensor_SetBlackSunAdjust())
Definition: libflipro.h:656
LIBFLIPRO_API FPROAlgo_SetHardwareMergeReferenceFiles(int32_t iHandle, const wchar_t *pDSNUFile, const wchar_t *pPRNUFile)
Sets the reference frames used in PCIE Fibre hardware image merging.
IMX183 Sensor Horizontal Test Pattern.
Definition: libflipro.h:332
Pin is in the low state.
Definition: libflipro.h:733
LIBFLIPRO_API FPROCtrl_SetSensorTemperatureReadEnable(int32_t iHandle, bool bEnable)
Enables/disables physical reading of the image sensor temperature during exposures.
Name for AUX I/O Pin 3.
Definition: libflipro.h:695
LIBFLIPRO_API FPROCam_Open(FPRODEVICEINFO *pDevInfo, int32_t *pHandle)
Connects to the camera specified by the pDevInfo parameter.
LIBFLIPRO_API FPROCtrl_GetCameraBufferBypass(int32_t iHandle, bool *pCameraBypassEnable, bool *pHostBypassEnable)
Returns the current Camera Buffer Bypass state of the camera.
uint32_t uiReserved
Reserved.
Definition: libflipro.h:659
FPRO_MERGEALGO
Merging algorithms available in the API.
Definition: libflipro.h:1087
Only the corrected low gain pixels will be sent through to the API. The high gain pixels will be igno...
Definition: libflipro.h:1029
LIBFLIPRO_API FPROCtrl_GetTemperatures(int32_t iHandle, double *pAmbientTemp, double *pBaseTemp, double *pCoolerTemp)
Reads the various temperatures sensors of the camera.
uint32_t uiMetaDataSize
Number of bytes used for the pre-frame image meta data.
Definition: libflipro.h:667
LIBFLIPRO_API FPROFrame_GetThumbnailFrame(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize)
Retrieves the thumbnail image from the camera.
LIBFLIPRO_API FPROAlgo_SetHardwareMergeReferenceFrames(int32_t iHandle, FPRO_REFFRAMES *pRefFrames)
Sets the reference frames used in PCIE Fibre hardware image merging.
Definition: libflipro.h:1185
LIBFLIPRO_API FPROFrame_GetVideoFrameExt(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize)
Retrieves an externally triggered image frame from the camera.
LIBFLIPRO_API FPROFrame_GetTestImageEnable(int32_t iHandle, bool *pEnable, FPROTESTIMAGETYPE *pFormat)
Retrieves the test image data settings.
uint32_t uiModeIndex
The corresponding index of the mode name.
Definition: libflipro.h:534
LIBFLIPRO_API FPROSensor_GetHighGainOnlyEnable(int32_t iHandle, bool *pHighGainOnly)
Retrieves the High Gain Only Mode.
struct device_version_info_t FPRODEVICEVERS
Device Version Information.
uint64_t uiLowImageSize
The Size of the pLowImage image in pixels.
Definition: libflipro.h:1149
FPROGPSSTATE
GPS Connection State.
Definition: libflipro.h:470
LIBFLIPRO_API FPROSensor_GetBlackLevelAdjustEx(int32_t iHandle, FPROBLACKADJUSTCHAN eChan, uint32_t *pAdjustValue)
Retrieves the current Black Level Adjustment values for the given channel.
LIBFLIPRO_API FPROFrame_SetReferenceRowPreFrameCount(int32_t iHandle, uint32_t uiNumRows)
Sets the reference row count to be prepended to frame data.
LIBFLIPRO_API FPROFrame_GetImageArea(int32_t iHandle, uint32_t *pColOffset, uint32_t *pRowOffset, uint32_t *pWidth, uint32_t *pHeight)
Gets the area of the image sensor being used to produce image frame data.
LIBFLIPRO_API FPROCtrl_SetElectricallyBlackPixelEnable(int32_t iHandle, bool bEnable)
Returns the current Electrically Black Pixel Enable state from the camera.
LIBFLIPRO_API FPROFrame_GetImageDataEnable(int32_t iHandle, bool *pEnable)
Enables image data imaging.
Definition: libflipro.h:646
Definition: libflipro.h:850
uint32_t uiNumFramesReceived
The number of frames received from the camera.
Definition: libflipro.h:827
IMX183 Sensor All High Test Pattern. All pixels are 0xFFF.
Definition: libflipro.h:334
Set AUX I/O pin as an output with respect to the camera.
Definition: libflipro.h:715
LIBFLIPRO_API FPROSensor_GetGainTable(int32_t iHandle, FPROGAINTABLE eTable, FPROGAINVALUE *pGainValues, uint32_t *pNumEntries)
Retrieves the specified Gain Table.
double dblMean
The mean of the pixel values in the plane.
Definition: libflipro.h:1241
REGWR, INFO, WARNING, and ERROR debug is output.
Definition: libflipro.h:433
Enum value = 0x02047051.
Definition: libflipro.h:151
If streaming has stopped due to an error, the status will be less than 0. Consult the log file for er...
Definition: libflipro.h:787
Name for AUX I/O Pin 4.
Definition: libflipro.h:696
uint16_t * pMultiplicativeLowGain
Low Gain Multiply Reference Frame.
Definition: libflipro.h:964
LIBFLIPRO_API FPROFAck_FlushImageQueue(int32_t iHandle)
Flush the in memory frame queue in Frame Acknowledgment Mode.
double * pdblHistogram
The pixel value histogram. The index is the pixel value, the value at that index is the number of pix...
Definition: libflipro.h:1240
LIBFLIPRO_API FPROFrame_CaptureStart(int32_t iHandle, uint32_t uiFrameCount)
Initiates the capture of the configured image.
uint32_t uiBlackLevelMax
Max Value Allowed (see FPROSensor_SetBlackLevelAdjust())
Definition: libflipro.h:655
High Gain Channel used for LDR modes NOTE: Different cameras support different gain settings...
Definition: libflipro.h:567
LIBFLIPRO_API FPROAlgo_StackInitialize(int32_t iHandle)
Initialize the stacking process.
FPROPLANESTATS statsLowImage
The statistics for the low image.
Definition: libflipro.h:1273
LIBFLIPRO_API FPROSensor_SetReadoutConfiguration(int32_t iHandle, FPROSENSREADCFG eReadCfg)
Sets the sensor read out configuration on supported models.
uint32_t uiProdId
The USB Product ID. This field is applicable only when the eCOnnType is FPRO_CONNECTION_USB.
Definition: libflipro.h:257
LIBFLIPRO_API FPROAuxIO_SetExposureActivePolarity(int32_t iHandle, bool bActiveHigh)
Exposure Active Signal Polarity.
LIBFLIPRO_API FPROCtrl_SetShutterOpen(int32_t iHandle, bool bOpen)
Opens/Close the shutter.
FPROCONNECTION
Supported Connection Types.
Definition: libflipro.h:190
LIBFLIPRO_API FPROCtrl_GetLEDDuration(int32_t iHandle, uint32_t *pDurationUsec)
Get the LED Duration setting.
LIBFLIPRO_API FPROCtrl_GetElectricallyBlackPixelEnable(int32_t iHandle, bool *pEnable)
Returns the current Electrically Black Pixel Enable state from the camera.
LIBFLIPRO_API FPROAuxIO_SetPin(int32_t iHandle, FPROAUXIO eAuxIO, FPROAUXIO_DIR eDirection, FPROAUXIO_STATE eState)
Sets the direction and state for given Auxiliary I/O pin.
Light Flash Frame.
Definition: libflipro.h:882
bool bLowRequest
Set to true to request the statistics for this image plane when unpacking.
Definition: libflipro.h:1274
LIBFLIPRO_API FPROCtrl_GetPCIETemperatures(int32_t iHandle, double *pPcieFpga, double *pFibreFpga)
Returns the temperatures on the Host PCIE Fibre Interface card.
Read data using all 4 sensor channels.
Definition: libflipro.h:506
struct fpro_stream_stats_t FPROSTREAMSTATS
Streamer Statistics.
LIBFLIPRO_API FPROFAck_FrameAcknowledge(int32_t iHandle)
Acknowledge the last frame sent in Frame Acknowledgment Mode.
LIBFLIPRO_API FPROFrame_ComputeFrameSizePixels(int32_t iHandle, uint32_t *pTotalWidth, uint32_t *pTotalHeight)
Computes the size in pixels of the image frame.
LIBFLIPRO_API FPROAlgo_StackDeinitialize(int32_t iHandle)
Returns all the resources allocated during the stacking process to the system.
FPROTESTIMAGETYPE
Test Image Types.
Definition: libflipro.h:327
FPROUSBSPEED
Known USB Connection Speeds.
Definition: libflipro.h:213
uint32_t uiRowScanTime
Row Scan Time in nano secs (LDR)
Definition: libflipro.h:660
Dark Frame.
Definition: libflipro.h:880
uint32_t uiMaxPixelImageWidth
Max allowed image width in pixels.
Definition: libflipro.h:651
Specifies the LDR Black adjust channel.
Definition: libflipro.h:607
wchar_t wcModeName[FPRO_SENSOR_MODE_NAME_LENGTH]
A descriptive human readable name for the mode suitable for a user interface.
Definition: libflipro.h:535
FPROEXTTRIGTYPE eTriggerType
The trigger behaovior type.
Definition: libflipro.h:401
LIBFLIPRO_API FPROSensor_SetHighGainOnlyEnable(int32_t iHandle, bool bHighGainOnly)
Sets the High Gain Only Mode. Note: The High Gain Only Mode is not applicable to all camera models...
uint32_t uiMetaDataSize
The Size of the pMetaData buffer in bytes.
Definition: libflipro.h:1145
LIBFLIPRO_API FPROFrame_UnpackFile(wchar_t *pFileName, FPROUNPACKEDIMAGES *pUPBuffers, FPROUNPACKEDSTATS *pStats)
Unpack and merge the given file.
IMX183 Sensor Repeating High Low Test Pattern. All pixels are 0xAAA.
Definition: libflipro.h:336
LIBFLIPRO_API FPROCtrl_SetCameraBufferBypass(int32_t iHandle, bool bCameraBypassEnable, bool bHostBypassEnable)
Set Camera Buffer Bypass state of the camera.
FITS formatted image.
Definition: libflipro.h:985
LIBFLIPRO_API FPROFrame_SetImageDataEnable(int32_t iHandle, bool bEnable)
Enables image data imaging.
uint32_t uiFrameNumber
The frame number returned in the preview.
Definition: libflipro.h:852
uint64_t uiDiskFramesWritten
The total number of frames written to disk.
Definition: libflipro.h:829
Pin is in the high state.
Definition: libflipro.h:734
uint16_t * pHighImage
The High Image Buffer.
Definition: libflipro.h:1153
LIBFLIPRO_API FPROFrame_SetReferenceRowPostFrameCount(int32_t iHandle, uint32_t uiNumRows)
Sets the reference row count to be appended to frame data.
struct ref_frames_t FPRO_REFFRAMES
Reference Frames for Hardware Image Merging.
uint32_t uiCapVersion
Version of this structure.
Definition: libflipro.h:649
uint16_t * pLowImage
The Low Image Buffer.
Definition: libflipro.h:1148
LIBFLIPRO_API FPROSensor_SetScanDirection(int32_t iHandle, bool bHInverted, bool bVInverted)
Retrieves the current pixel scan direction settings on the sensor.
LIBFLIPRO_API FPROFrame_StreamGetStatistics(int32_t iHandle, FPROSTREAMSTATS *pStats)
Stop the streaming operation.
FPRODBGLEVEL
Debug Capability.
Definition: libflipro.h:427
LIBFLIPRO_API FPROFrame_StreamGetPreviewImageEx(int32_t iHandle, uint8_t *pImage, uint32_t *pLength, FPROPREVIEW *pInfo, uint32_t uiTimeoutMSecs)
Retrieve the next image available for preview from the image stream.
uint32_t uiHighGain
Number Of Gain Values (High Gain channel for LDR Modes)
Definition: libflipro.h:658
LIBFLIPRO_API FPRONV_ReadNVStorage(int32_t iHandle, uint32_t uiOffset, uint8_t *pData, uint32_t uiLength)
Read the non volatile storage area on the camera.
struct sensor_mode_t FPROSENSMODE
Sensor Modes.
LIBFLIPRO_API FPROFrame_SetUnpackingBiasFrames(int32_t iHandle, uint32_t uiWidth, uint32_t uiHeight, uint16_t *pLowFrame, uint16_t *pHighFrame)
Sets Bias frame correction to be used during unpacking.
LIBFLIPRO_API FPROCtrl_GetExposure(int32_t iHandle, uint64_t *pExposureTime, uint64_t *pFrameDelay, bool *pImmediate)
Reads the exposure time of the image sensor.
FPROSENSREADCFG
Sensor Read Out Configuration.
Definition: libflipro.h:500
WARNING and ERROR debug is output.
Definition: libflipro.h:431
Enum value = 0x04000183.
Definition: libflipro.h:156
struct unpacked_images_t FPROUNPACKEDIMAGES
Unpacked Image Buffers.
LIBFLIPRO_API FPROSensor_GetBinningTable(int32_t iHandle, uint32_t *pBinTable, uint32_t *pTableSizeBytes)
Retrieves the Binning table capability from the camera.
wchar_t cSerialNo[FPRO_USB_STRING_MAXLEN]
The manufacturing serial number of the device.
Definition: libflipro.h:253
double dblMode
The mode of the pixel values in the plane.
Definition: libflipro.h:1243
uint32_t uiHeight
Height of the frames in pixels.
Definition: libflipro.h:960
LIBFLIPRO_API FPROCtrl_SetFanEnable(int32_t iHandle, bool bOn)
Turns the Fan on or off.
LIBFLIPRO_API FPROFrame_GetReferenceRowPreFrameCount(int32_t iHandle, uint32_t *pNumRows)
Retrieves the reference row count to be prepended to frame data.
LIBFLIPRO_API FPROSensor_GetBlackSunAdjust(int32_t iHandle, uint32_t *pAdjustValue)
Retrieves the current Black Sun Adjustment values.
bool bMergedImageRequest
The Merged Image request Flag. Set to &#39;true&#39; to merge the low and high gain image planes...
Definition: libflipro.h:1161
Row order format. The first &#39;width&#39; number of pixels will be 0, the second &#39;width&#39; number of pixels ...
Definition: libflipro.h:329
wchar_t cHostHardwareVersion[FPRO_VERSION_STRING_MAXLEN]
The version of firmware on the host interface card if any. For example, it returns the hardware versi...
Definition: libflipro.h:289
LIBFLIPRO_API FPROSensor_GetGainIndex(int32_t iHandle, FPROGAINTABLE eTable, uint32_t *pGainIndex)
Retrieves the current setting for the Gain for the specified table.
FPROPLANESTATS statsMergedImage
The statistics for the merged image.
Definition: libflipro.h:1279
TRACE, DEBUG, REGRW, INFO, WARNING, and ERROR debug is output.
Definition: libflipro.h:435
LIBFLIPRO_API FPROSensor_GetModeCount(int32_t iHandle, uint32_t *pCount, uint32_t *pCurrentMode)
Retrieves the current mode count and current mode index setting.
LIBFLIPRO_API FPROCtrl_GetTemperatureSetPoint(int32_t iHandle, double *pSetPoint)
Returns the Base Temperature Set Point.
FLI native RCD Frame.
Definition: libflipro.h:983
uint32_t uiVendorId
The USB vendor ID. This field is applicable only when the eCOnnType is FPRO_CONNECTION_USB.
Definition: libflipro.h:256
LIBFLIPRO_API FPROFAck_GetEnable(int32_t iHandle, bool *pEnable)
Get Frame Acknowledgment Mode Enable.
LIBFLIPRO_API FPROAuxIO_GetExposureActiveType(int32_t iHandle, FPROAUXIO_EXPACTIVETYPE *pType)
Get Exposure Active Type Signal.
LIBFLIPRO_API FPROAlgo_StackNextFrame(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize, uint32_t uiTimeoutMS)
Capture and retrieve the next frame to stack from the camera.
LIBFLIPRO_API FPROCtrl_SetIlluminationDelay(int32_t iHandle, uint16_t uiOnDelay, uint16_t uiOffDelay)
Sets the illumination delay.
LIBFLIPRO_API FPROCtrl_SetHeaterPower(int32_t iHandle, uint32_t uiPwrPercentage)
Turns the Heater on or off at the specified power level.
FPROGAINTABLE
Gain Tables.
Definition: libflipro.h:564
LIBFLIPRO_API FPROCam_GetAPIVersion(wchar_t *pVersion, uint32_t uiLength)
Returns the version of this API Library.
struct unpacked_stats_t FPROUNPACKEDSTATS
Statistics for unpacked image planes.
LIBFLIPRO_API FPROCtrl_SetLED(int32_t iHandle, bool bOn)
Turn the LED on or off.
Only the corrected high gain pixels will be sent through to the API. The low gain pixels will be igno...
Definition: libflipro.h:1030
LIBFLIPRO_API FPROFrame_StreamInitialize(int32_t iHandle, uint32_t uiFrameSizeBytes, wchar_t *pRootPath, wchar_t *pFilePrefix)
Initializes the Streamer interfaces.
Read data using the bottom left channel of the sensor.
Definition: libflipro.h:503
Definition: libflipro.h:532
All debug disabled.
Definition: libflipro.h:429
Definition: libflipro.h:957
FPROSTREAMSTATS streamStats
The stream statistics. See FPROSTREAMSTATS.
Definition: libflipro.h:853
FPRO_HWMERGEFRAMES
Enables for Hardware Image Merging.
Definition: libflipro.h:1026
LIBFLIPRO_API FPROCtrl_GetLED(int32_t iHandle, bool *pOn)
Returns the state of the LED on or off setting.
Global Exposure Active- consult your camera documentation for timing details.
Definition: libflipro.h:756
LIBFLIPRO_VOID FPRODebug_Write(FPRODBGLEVEL eLevel, const wchar_t *format,...)
FPROAUXIO
Auxiliary I/O Pins.
Definition: libflipro.h:691
uint32_t uiAvailablePixelDepths
Bit is set if pixel depth allowed (lsb= pixel depth 1)
Definition: libflipro.h:653
wchar_t * pPRNUFile
PRNU Reference file (may be NULL).
Definition: libflipro.h:1008
LIBFLIPRO_API FPROSensor_SetBlackLevelAdjustEx(int32_t iHandle, FPROBLACKADJUSTCHAN eChan, uint32_t uiAdjustValue)
Sets the current Black Level Adjustment value for the given channel.
LIBFLIPRO_API FPROSensor_GetReadoutConfiguration(int32_t iHandle, FPROSENSREADCFG *pReadCfg)
Retrieves the current sensor read out configuration on supported models.
LIBFLIPRO_VOID FPROFrame_FreeUnpackedStatistics(FPROUNPACKEDSTATS *pStats)
Frees the Unpacked Statistics Buffers within the given structure.
double dblOverallMBPerSec
The overall MB per second received by the streamer. Note this depends on actual frame rate from the c...
Definition: libflipro.h:833
FPRO_IMAGE_FORMAT eMergeFormat
The image file format for the merged image. The Actual PCIE card only supports RCD and TIFF...
Definition: libflipro.h:1068
LIBFLIPRO_API FPROFrame_StreamStop(int32_t iHandle)
Stop the streaming operation.
FPRO_IMAGE_FORMAT
Output Frame Formats for image merging and conversion.
Definition: libflipro.h:980
Exposure Active High For this setting, the exposure is active the entire time the external trigger s...
Definition: libflipro.h:377
Column order format. The first pixel of the first row will be 0, the second pixel will be 1...
Definition: libflipro.h:330
LIBFLIPRO_API FPROCam_GetDeviceVersion(int32_t iHandle, FPRODEVICEVERS *pVersion)
Returns the version information from the connected device.
#define FPRO_DEVICE_MAX_PATH_LENGTH
Maximum path length for low level OS device path.
Definition: libflipro.h:175
LIBFLIPRO_API FPROAlgo_GetHardwareMergeEnables(int32_t iHandle, FPRO_HWMERGEENABLE *pMergeEnables)
Retrieve the hardware merge enable settings.
LIBFLIPRO_API FPROSensor_GetBinning(int32_t iHandle, uint32_t *pXBin, uint32_t *pYBin)
Retrieves the current pixel bin settings.
uint64_t uiTotalBytesReceived
The total number of bytes received from the camera.
Definition: libflipro.h:828
LIBFLIPRO_API FPROSensor_GetBlackLevelAdjust(int32_t iHandle, uint32_t *pAdjustValue)
Retrieves the current Black Level Adjustment values.
Trigger Exposure on Falling Edge For this setting, when the external trigger line goes from high to ...
Definition: libflipro.h:374
LIBFLIPRO_API FPROCtrl_GetGPSState(int32_t iHandle, FPROGPSSTATE *pState)
Returns the current state of an optionally attached GPS unit.
uint64_t uiMergedBufferSize
The Size of the pMergedImage buffer in bytes. This will be different than uiMergedImageSize * sizeof(...
Definition: libflipro.h:1160
double dblDiskPeakMBPerSec
The peak write rate in MBytes/sec; the fastest a given frame was written.
Definition: libflipro.h:831
bool bVerticalScanInvertable
False= Normal scan direction only, True= Inverse Scan Available.
Definition: libflipro.h:663
LIBFLIPRO_API FPROSensor_GetHDREnable(int32_t iHandle, bool *pHDREnable)
Retrieves the current setting for HDR enable.
bool bMergeEnable
True if merging enabled. This must be true for the other enables to have any effect. False turns merging off and the unprocessed frame data is passed through to the host directly from the camera.
Definition: libflipro.h:1067
int32_t X
The x coordinate.
Definition: libflipro.h:1187
First Row Sync- consult your camera documentation for timing details.
Definition: libflipro.h:757
LIBFLIPRO_API FPROSensor_GetTrainingEnable(int32_t iHandle, bool *pEnable)
Returns the sensor re-training setting.
Enum value = 0x03023084.
Definition: libflipro.h:154
wchar_t cControllerVersion[FPRO_VERSION_STRING_MAXLEN]
The version of firmware on the internal sensor controller device.
Definition: libflipro.h:288
Camera is connected with a Fibre Optic link.
Definition: libflipro.h:193
uint64_t uiHighBufferSize
The Size of the pHighImage buffer in bytes. This may be different than uiHighImageSize * sizeof(uint1...
Definition: libflipro.h:1155
FPRODEVICETYPE
Known Device Types.
Definition: libflipro.h:145
LIBFLIPRO_API FPROFrame_StreamDeinitialize(int32_t iHandle)
Deinitializes the Streamer interfaces.
Definition: libflipro.h:1271
Definition: libflipro.h:1203
Streaming Stopped. This is the default state. It also enters this state when the requested number of ...
Definition: libflipro.h:788
uint32_t uiLowGain
Number of Gain Values (Low Gain channel for low gain frame in HDR Modes)
Definition: libflipro.h:657
uint32_t uiValue
The pixel value.
Definition: libflipro.h:1206
uint32_t uiNVStorageAvailable
Number of bytes of Non-Volatile Storage available on the camera.
Definition: libflipro.h:664
LIBFLIPRO_API FPROSensor_SetSamplesPerPixel(int32_t iHandle, FPROCMS eSamplesPerPixel)
Sets the Samples Per Pixel settings on the sensor. NOTE: This function is not supported on on all ...
LIBFLIPRO_API FPROFrame_SetDummyPixelEnable(int32_t iHandle, bool bEnable)
Sets the dummy pixel configuration to be appended row data.
LIBFLIPRO_API FPROSensor_GetMode(int32_t iHandle, uint32_t uiModeIndex, FPROSENSMODE *pMode)
Retrieves the current mode name for the specified index.
int32_t Y
The y coordinate.
Definition: libflipro.h:1188
uint32_t uiWidth
Width of the frames in pixels.
Definition: libflipro.h:959
LIBFLIPRO_API FPROCtrl_GetShutterOpen(int32_t iHandle, bool *pOpen)
Gets the current shutter setting.
bool bHighImageRequest
The High Image request Flag. Set to &#39;true&#39; to unpack the high gain image plane.
Definition: libflipro.h:1156
Super Speed Connection.
Definition: libflipro.h:217
Normal Frame (default).
Definition: libflipro.h:879
LIBFLIPRO_API FPROSensor_GetBlackSunAdjustEx(int32_t iHandle, FPROBLACKADJUSTCHAN eChan, uint32_t *pAdjustValue)
Retrieves the current Black Sun Adjustment values for the given channel.
FPROSTREAMERSTATUS
Streamer Status.
Definition: libflipro.h:785
struct hw_merge_enables_t FPRO_HWMERGEENABLE
Enables for Hardware Image Merging.
LIBFLIPRO_API FPROSensor_SetGainIndex(int32_t iHandle, FPROGAINTABLE eTable, uint32_t uiGainIndex)
Sets the current setting for the Gain for the specified table.
Low Gain Channel used for Low Gain images in HDR modes.
Definition: libflipro.h:566
uint32_t uiHistogramSize
The number of elements in the array pointed to by pdblHistogram.
Definition: libflipro.h:1239
LIBFLIPRO_API FPROFrame_ComputeFrameSize(int32_t iHandle)
Computes the size in bytes of the image frame.
Normal merge, both low and high gain planes are corrected and merged.
Definition: libflipro.h:1028
FPRO_FRAME_TYPE
Image Frame Type.
Definition: libflipro.h:877
LIBFLIPRO_VOID FPROFrame_FreeUnpackedBuffers(FPROUNPACKEDIMAGES *pUPBuffers)
Frees the Unpacked Buffers within the given structure.
Read data using the top left channel of the sensor.
Definition: libflipro.h:504
Bias Frame.
Definition: libflipro.h:881
uint64_t uiMergedImageSize
The Size of the pMergedImage image in pixels.
Definition: libflipro.h:1159
Single Sample Per Pixel. This is the default for all cameras.
Definition: libflipro.h:903
uint64_t uiLowBufferSize
The Size of the pLowImage buffer in bytes. This may be different than uiLowImageSize * sizeof(uint16_...
Definition: libflipro.h:1150
uint64_t uiHighImageSize
The Size of the pHighImage image in pixels.
Definition: libflipro.h:1154
LIBFLIPRO_API FPROAlgo_SetHardwareMergeEnables(int32_t iHandle, FPRO_HWMERGEENABLE mergeEnables)
Enable/disable hardware merging options.
Camera is connected with a USB link.
Definition: libflipro.h:192
LIBFLIPRO_API FPROCtrl_SetBurstModeEnable(int32_t iHandle, bool bEnable)
Set Camera Burst Mode enable.
FPROPIXELINFO pixBrightest
The location and value of the brightest pixel in the plane.
Definition: libflipro.h:1246
LIBFLIPRO_API FPROFrame_GetPixelConfig(int32_t iHandle, uint32_t *pPixelDepth, uint32_t *pPixelLSB)
Retrieves the current pixel configuration.
LIBFLIPRO_API FPROCtrl_GetSensorTemperature(int32_t iHandle, int32_t *pTemp)
Reads the internal sensor temperature of the camera.
Enum value = 0x01000400.
Definition: libflipro.h:147
FPROPIXELINFO pixDimmest
The location and value of the dimmest pixel in the plane.
Definition: libflipro.h:1247
LIBFLIPRO_API FPROCam_GetCameraList(FPRODEVICEINFO *pDeviceInfo, uint32_t *pNumDevices)
FPROCam_GetCameraList.
LIBFLIPRO_API FPRODebug_SetLogPath(const wchar_t *pPath)
struct pixel_info_t FPROPIXELINFO
Defines a location and value of a pixel within an image plane.
LIBFLIPRO_API FPROCtrl_GetExternalTriggerEnable(int32_t iHandle, FPROEXTTRIGINFO *pTrigInfo)
Returns the external trigger settings of the camera.
LIBFLIPRO_API FPROSensor_SetBlackSunAdjust(int32_t iHandle, uint32_t uiAdjustValue)
Sets the current Black Sun Adjustment value.
Streaming is running. This state is entered when streaming is started via the FPROFrame_StreamStart()...
Definition: libflipro.h:789
struct camera_capabilities_t FPROCAP
Camera Capabilities.
IMX183 Sensor Vertical Test Pattern.
Definition: libflipro.h:331
uint32_t uiBinningsTableSize
0= 1:1 binning only
Definition: libflipro.h:654
LIBFLIPRO_API FPROCtrl_SetExposure(int32_t iHandle, uint64_t uiExposureTime, uint64_t uiFrameDelay, bool bImmediate)
Sets the exposure time of the image sensor.
FPROCMS
Correlated Multiple Samples (Samples Per Pixel)
Definition: libflipro.h:901
struct conv_info_t FPRO_CONV
Conversion info structure supplied to conversion functions.
LIBFLIPRO_API FPROFrame_CaptureAbort(int32_t iHandle)
Aborts the active image capture.
Full Speed Connection.
Definition: libflipro.h:215
LIBFLIPRO_API FPROCtrl_GetBurstModeEnable(int32_t iHandle, bool *pEnable)
Get Camera Burst Mode enable.
Definition: libflipro.h:284
LIBFLIPRO_API FPROAlgo_GetHardwareMergeThresholds(int32_t iHandle, uint16_t *pHighGainThreshold, uint16_t *pMergeDifferenceThreshold)
Retrieve the current Hardware Merge Threshold values.
LIBFLIPRO_API FPROAlgo_SetHardwareMergeThresholds(int32_t iHandle, uint16_t uiHighGainThreshold, uint16_t uiMergeDifferenceThreshold)
Retrieve the current Hardware Merge Threshold values.
Enum value = 0x03023042.
Definition: libflipro.h:153
LIBFLIPRO_API FPROAlgo_StackFinish(int32_t iHandle, uint16_t **ppLowMeanFrame, uint16_t **ppHighMeanFrame, uint32_t *pNumPixels, uint8_t **ppMetaData, uint32_t *puiMetaSize)
Finish the stacking process and retrieve the mean frames.
LIBFLIPRO_API FPROFAck_FrameResend(int32_t iHandle)
Re-send the last frame in Frame Acknowledgment Mode.
FPRO_HWMERGEFRAMES eMergeFrames
Specifies the frames to merge.
Definition: libflipro.h:1069
LIBFLIPRO_API FPROCtrl_GetFanEnable(int32_t iHandle, bool *pOn)
Returns the current Fan status, on or off.
LIBFLIPRO_API FPROFrame_SetUnpackingFlatFieldFrames(int32_t iHandle, uint32_t uiWidth, uint32_t uiHeight, uint16_t *pLowFrame, uint16_t *pHighFrame)
Sets Flat Field correction to be used during unpacking.
Name for AUX I/O Pin 1.
Definition: libflipro.h:693
LIBFLIPRO_API FPROCtrl_GetHeaterPower(int32_t iHandle, uint32_t *pPwrPercentage)
Reads the current heater configuration.
GPS unit has been detected by the camera but the satellite lock has not been made.
Definition: libflipro.h:473
FPROPLANESTATS statsHighImage
The statistics for the high image.
Definition: libflipro.h:1276
IMX183 Sensor All Low Test Pattern. All pixels are 0x000.
Definition: libflipro.h:333
LIBFLIPRO_API FPROFrame_GetVideoFrame(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize, uint32_t uiTimeoutMS)
Retrieves an image frame from the camera.
LIBFLIPRO_API FPROFrame_SetTrackingAreaEnable(int32_t iHandle, uint32_t uiNumTrackingFrames)
Enables the production of Tracking Frames by the camera.
Original merge algorithm based on camera settings.
Definition: libflipro.h:1089
struct int_point_t FPROPOINT
Point Coordinates.
LIBFLIPRO_API FPROAuxIO_SetExposureActiveType(int32_t iHandle, FPROAUXIO_EXPACTIVETYPE eType)
Exposure Active Type Signal.
LIBFLIPRO_API FPROFrame_UnpackFileEx(wchar_t *pFileName, FPROUNPACKEDIMAGES *pUPBuffers, FPROUNPACKEDSTATS *pStats, const wchar_t *pDSNUFile, const wchar_t *pPRNUFile)
Unpack and merge the given file.
LIBFLIPRO_API FPROSensor_GetScanDirection(int32_t iHandle, bool *pHInverted, bool *pVInverted)
Retrieves the current pixel scan direction settings on the sensor.
LIBFLIPRO_API FPROCam_Close(int32_t iHandle)
Disconnects from the camera an releases the handle.
uint8_t * pMetaData
The raw Meta Data Buffer.
Definition: libflipro.h:1144
struct ext_trigger_info_t FPROEXTTRIGINFO
External Trigger Setup Details.
uint32_t uiDeviceType
General device type- see documentation.
Definition: libflipro.h:650
uint32_t uiPreFrameReferenceRows
Number of Pre-Frame Reference rows available.
Definition: libflipro.h:665
LIBFLIPRO_API FPROFrame_ConvertFile(wchar_t *pInRcdFile, FPRO_CONV *pConvInfo, wchar_t *pOutFile)
Convert (and possibly) merge the given RCD file.
FPROAUXIO_STATE
Auxiliary Output State.
Definition: libflipro.h:731
Four sensor samples per pixel are read out.
Definition: libflipro.h:905
Definition: libflipro.h:399
LIBFLIPRO_API FPRODebug_EnableLevel(bool bEnable, FPRODBGLEVEL eLevel)
LIBFLIPRO_API FPROFrame_GetVideoFrameUnpacked(int32_t iHandle, uint8_t *pFrameData, uint32_t *pSize, uint32_t uiTimeoutMS, FPROUNPACKEDIMAGES *pUPBuffers, FPROUNPACKEDSTATS *pStats)
Retrieves an image frame from the camera and optionally unpacks and merges the image planes...
LIBFLIPRO_API FPROCtrl_SetShutterOverride(int32_t iHandle, bool bOverride)
Sets the shutter control override.
FPRO_MERGEALGO eMergAlgo
Specifies which merging algorithm to use when merging the image data. See FPRO_MERGEALGO.
Definition: libflipro.h:1163
int16_t * pAdditiveLowGain
Low Gain Additive Reference Frame.
Definition: libflipro.h:962
Enum value = 0x02029050.
Definition: libflipro.h:152
LIBFLIPRO_API FPROCtrl_GetCoolerDutyCycle(int32_t iHandle, uint32_t *pDutyCycle)
Reads the current duty cycle of the cooler.
Set AUX I/O pin as an input with respect to the camera.
Definition: libflipro.h:714
LIBFLIPRO_API FPROFrame_MetaDataToString(wchar_t *pFileName, wchar_t *pMetaString, uint32_t uiMaxSize)
Convert the meta data in the given file to string.
LIBFLIPRO_API FPROCtrl_SetExternalTriggerEnable(int32_t iHandle, uint32_t uiFrameCount, FPROEXTTRIGINFO *pTrigInfo)
Enables or disables the external trigger of the camera.
Enum value = 0x01002020.
Definition: libflipro.h:148
Exposure Active- consult your camera documentation for timing details.
Definition: libflipro.h:755
LIBFLIPRO_API FPROSensor_GetCapabilities(int32_t iHandle, FPROCAP *pCap, uint32_t *pCapLength)
Retrieves the sensor capabilities structure from the camera.
#define FPRO_VERSION_STRING_MAXLEN
Version String Lengths.
Definition: libflipro.h:266
LIBFLIPRO_API FPROCtrl_SetExposureEx(int32_t iHandle, uint64_t uiExposureTime, uint64_t uiFrameDelay, bool bImmediate, uint64_t *pActualExposureTime, uint64_t *pActualFrameDelay)
Sets the exposure time of the image sensor.
FPROSTREAMERSTATUS iStatus
The status of the streamer. See FPROSTREAMERSTATUS.
Definition: libflipro.h:834
Name for AUX I/O Pin 2.
Definition: libflipro.h:694
LIBFLIPRO_API FPROAuxIO_GetExposureActivePolarity(int32_t iHandle, bool *pActiveHigh)
Get the Exposure Active Signal Polarity.
#define FPRO_USB_STRING_MAXLEN
Maximum String Length.
Definition: libflipro.h:167
Trigger Exposure on Rising Edge For this setting, when the external trigger line goes from low to hi...
Definition: libflipro.h:375
struct gain_value_t FPROGAINVALUE
Gain Value.
LIBFLIPRO_API FPROFrame_SetTrackingArea(int32_t iHandle, uint32_t uiStartRow, uint32_t uiEndRow)
Sets the area of the image sensor to be used for Tracking Frames during image capture.
High Speed Connection.
Definition: libflipro.h:216
LIBFLIPRO_API FPROFrame_SetPixelConfig(int32_t iHandle, uint32_t uiPixelDepth, uint32_t uiPixelLSB)
Sets the current pixel configuration to the specified values.
struct fpro_stream_preview_info_t FPROPREVIEW
Streamer Statistics For Preview Images When obtaining a preview image while streaming, this structure will contain the stream statistics for the image returned. See FPROFrame_StreamGetPreviewImageEx().
double dblStandardDeviation
The standard deviation of the pixels in the plane.
Definition: libflipro.h:1244
LIBFLIPRO_API FPROFrame_SetImageArea(int32_t iHandle, uint32_t uiColOffset, uint32_t uiRowOffset, uint32_t uiWidth, uint32_t uiHeight)
Sets the area of the image sensor to be used to produce image frame data.
FPROAUXIO_DIR
Auxiliary I/O Pin Direction.
Definition: libflipro.h:712
LIBFLIPRO_API FPROCam_GetDeviceInfo(int32_t iHandle, FPRODEVICEINFO *pDeviceInfo)
FPROCam_GetDeviceInfo.
uint32_t uiDeviceIndex
The device index to use to set the gain value on the camera.
Definition: libflipro.h:587
FPROCONNECTION eConnType
The physical connection type. If the connection type is FPRO_CONNECTION_USB, then the uiVendorId...
Definition: libflipro.h:255
bool bHighRequest
Set to true to request the statistics for this image plane when unpacking.
Definition: libflipro.h:1277
bool bHorizontalScanInvertable
False= Normal scan direction only, True= Inverse Scan Available.
Definition: libflipro.h:662