FLImaging 7.8.25.3
DeviceCameraSpinnaker.h
1#pragma once
2
11
12#include "DeviceGenICamTypeBase.h"
13
14
16namespace FLImaging
17{
19 namespace Devices
20 {
21 class CInternalDeviceCameraSpinnaker;
22
32 {
33 SupportToDuplicateObject(CDeviceCameraSpinnaker);
34
35 public:
36
46 {
51
56
61
66
71
76
81
86
91
96
101
106
111
116
121
126
131
136 };
137
147 {
152
157
162 };
163
173 {
178
183 };
184
194 {
199
204 };
205
206 public:
215
224
225 virtual const CResult Initialize() override;
226 virtual const CResult Terminate() override;
227
228 virtual const CResult Grab() override;
229 virtual const CResult Live() override;
230 virtual const CResult Stop() override;
231
232 virtual const CResult TriggerWithSoftware() override;
233
236
239
242
243 virtual const CResult GetSupportedDeviceTypes(std::vector<EDeviceType>& vctTypes) const override;
244
245 virtual const Base::CFLImage* GetIntrinsicImage() const override;
246
247 virtual const CResult GetAcquiredImage(Base::CFLImage& fliImage) const override;
248 virtual const CResult GetAcquiredImage(Base::CFLImage* pFliImage) const override;
249
265 virtual const CResult GetAcquiredRenderImage(Base::CFLImage& fliImage) const;
266
282 virtual const CResult GetAcquiredRenderImage(Base::CFLImage* pFliImage) const;
283
284
298 virtual const CResult EnableRender(bool bEnable);
299
309 virtual bool IsRenderEnabled() const;
310
327
340
341
354
372 virtual const CResult GetMeasuredTemperature(int64_t i64X, int64_t i64Y, double& f64Value) const;
373
391 virtual const CResult GetMeasuredTemperature(int64_t i64X, int64_t i64Y, double* pF64Value) const;
392
414 virtual const CResult GetMeasuredTemperature(const Foundation::CFLFigure& flfSource, double& f64Min, double& f64Max, double& f64Mean) const;
415
437 virtual const CResult GetMeasuredTemperature(const Foundation::CFLFigure& flfSource, double* pF64Min, double* pF64Max, double* pF64Mean) const;
438
460 virtual const CResult GetMeasuredTemperature(const Foundation::CFLFigure* pFlfSource, double& f64Min, double& f64Max, double& f64Mean) const;
461
483 virtual const CResult GetMeasuredTemperature(const Foundation::CFLFigure* pFlfSource, double* pF64Min, double* pF64Max, double* pF64Mean) const;
484
485
486 virtual const CResult SetTriggerMode(bool bOn) override;
487 virtual const CResult GetTriggerMode(bool* pOn) const override;
488 virtual const CResult GetTriggerMode(bool& bOn) const override;
489
490 virtual const CResult SetTriggerSource(ETriggerSource eSource) override;
491 virtual const CResult GetTriggerSource(ETriggerSource* pSource) const override;
492 virtual const CResult GetTriggerSource(ETriggerSource& eSource) const override;
493
507 virtual const CResult SetFocusPosition(int64_t i64Position);
508
522 virtual const CResult GetFocusPosition(int64_t* pI64Position) const;
523
537 virtual const CResult GetFocusPosition(int64_t& i64Position) const;
538
552 virtual const CResult SetFocusSpeed(int64_t i64Speed);
553
567 virtual const CResult GetFocusSpeed(int64_t* pI64Speed) const;
568
582 virtual const CResult GetFocusSpeed(int64_t& i64Speed) const;
583
584
600 virtual const CResult SetFocusDirection(EFocusDirection eDirection);
601
617 virtual const CResult GetFocusDirection(EFocusDirection* pEDirection) const;
618
634 virtual const CResult GetFocusDirection(EFocusDirection& eDirection) const;
635
652
668 virtual const CResult GetAutoFocusMethod(EAutoFocusMethod* pEMethod) const;
669
685 virtual const CResult GetAutoFocusMethod(EAutoFocusMethod& eMethod) const;
686
698 virtual const CResult ExecuteAutoFocus() const;
699
700
714 virtual const CResult SetFocusDistance(double f64Distance);
715
729 virtual const CResult GetFocusDistance(double* pF64Distance) const;
730
744 virtual const CResult GetFocusDistance(double& f64Distance) const;
745
759 virtual const CResult SetFocusStep(int64_t i64Step);
760
774 virtual const CResult GetFocusStep(int64_t* pI64Step) const;
775
789 virtual const CResult GetFocusStep(int64_t& i64Step) const;
790
802 virtual const CResult ExecuteFocusIncrement() const;
803
815 virtual const CResult ExecuteFocusDecrement() const;
816
828 virtual const CResult ExecuteNUCAction() const;
829
845 virtual const CResult SetNUCMode(ENUCMode eMode);
846
862 virtual const CResult GetNUCMode(ENUCMode* pEMode) const;
863
879 virtual const CResult GetNUCMode(ENUCMode& eMode) const;
880
881
895 virtual const CResult ExecuteCommand(const char* pszCommand) const;
896
910 virtual const CResult ExecuteCommand(const wchar_t* pWcsCommand) const;
911
912
914 virtual const CResult SetBoolValue(const char* pszKey, const bool* pBValue) override;
915
917 virtual const CResult GetBoolValue(const char* pszKey, bool* pBValue) const override;
918
920 virtual const CResult SetInt32Value(const char* pszKey, const int32_t* pI32Value) override;
921
923 virtual const CResult GetInt32Value(const char* pszKey, int32_t* pI32Value) const override;
924
926 virtual const CResult SetInt64Value(const char* pszKey, const int64_t* pI64Value) override;
927
929 virtual const CResult GetInt64Value(const char* pszKey, int64_t* pI64Value) const override;
930
932 virtual const CResult SetFloatValue(const char* pszKey, const float* pF32Value) override;
933
935 virtual const CResult GetFloatValue(const char* pszKey, float* pF32Value) const override;
936
938 virtual const CResult SetDoubleValue(const char* pszKey, const double* pF64Value) override;
939
941 virtual const CResult GetDoubleValue(const char* pszKey, double* pF64Value) const override;
942
944 virtual const CResult SetStringValue(const char* pszKey, const Base::CFLString<char>* pFlsValue) override;
945
947 virtual const CResult GetStringValue(const char* pszKey, Base::CFLString<char>* pFlsValue) const override;
948
950 virtual const CResult SetEnumValue(const char* pszKey, const int32_t* pI32Value) override;
951 virtual const CResult SetEnumValue(const char* pszKey, const Base::CFLString<char>* pFlsValue) override;
952
954 virtual const CResult GetEnumValue(const char* pszKey, int32_t* pI32Value) const override;
955 virtual const CResult GetEnumValue(const char* pszKey, Base::CFLString<char>* pFlsValue) const override;
956
958 virtual const CResult GetEnumFeatureEntries(const Base::CFLString<wchar_t>& flsFeature, std::vector<std::pair<int32_t, Base::CFLString<wchar_t>>>* pVctEntries) const override;
959
960 DeclareGetClassType();
961
962 private:
963 virtual const CResult SetExposureTime(double f64Exposure) override;
964 virtual const CResult GetExposureTime(double* pF64Exposure) const override;
965 virtual const CResult GetExposureTime(double& f64Exposure) const override;
966
967 virtual const CResult SetGain(double f64Gain) override;
968 virtual const CResult GetGain(double* pF64Gain) const override;
969 virtual const CResult GetGain(double& f64Gain) const override;
970
971 virtual const CResult GetAutoDetectIEEE1394CameraSerialNumbers(Base::CFLArray<Base::CFLString<wchar_t>>& flarrSerialNumbers) override;
972 virtual const CResult GetAutoDetectIEEE1394CameraSerialNumbers(Base::CFLArray<Base::CFLString<wchar_t>>* pFlarrSerialNumbers) override;
973
974 protected:
975
976 virtual bool CheckDeviceLibraries() const override;
977
978 CInternalDeviceCameraSpinnaker* m_pInternal;
979
980 friend class CInternalDeviceCameraSpinnaker;
981 };
982 }
983}
984
985
Template type array class.
Definition FLArray.h:71
FLIMaging's image class.
Definition FLImage.h:35
Template type string class.
Definition FLString.h:34
FLImaging module execution result object.
Definition ResultsDef.h:1704
virtual const CResult GetBoolValue(const char *pszKey, bool &bValue) const
Retrieves a boolean value from the device using a key (UTF-8 string).
virtual const CResult SetFloatValue(const char *pszKey, const float &f32Value)
Sets a single-precision floating point value on the device using a UTF-8 key.
virtual const CResult SetDoubleValue(const char *pszKey, const double &f64Value)
Sets a double-precision floating point value on the device using a UTF-8 key.
virtual const CResult GetInt64Value(const char *pszKey, int64_t &i64Value) const
Retrieves a 64-bit integer (Int64) value from the device using a UTF-8 key.
virtual const CResult GetStringValue(const char *pszKey, Base::CFLString< char > &strValue) const
Retrieves a string value from the device using a UTF-8 key.
virtual const CResult SetEnumValue(const char *pszKey, const int32_t &i32Value)
Sets an enum value on the device using a UTF-8 key.
virtual const CResult SetStringValue(const char *pszKey, const Base::CFLString< char > &strValue)
Sets a string value on the device using a UTF-8 key and narrow string.
virtual const CResult GetEnumValue(const char *pszKey, int32_t &i32Value) const
Retrieves an enum value from the device using a UTF-8 key.
virtual const CResult SetInt32Value(const char *pszKey, const int32_t &i32Value)
Sets a 32-bit integer (Int32) value on the device using a UTF-8 key.
virtual const CResult SetBoolValue(const char *pszKey, const bool &bValue)
Sets a boolean value on the device using a key (UTF-8 string).
virtual const CResult SetInt64Value(const char *pszKey, const int64_t &i64Value)
Sets a 64-bit integer (Int64) value on the device using a UTF-8 key.
virtual const CResult GetFloatValue(const char *pszKey, float &f32Value) const
Retrieves a single-precision floating point value from the device using a UTF-8 key.
virtual const CResult GetDoubleValue(const char *pszKey, double &f64Value) const
Retrieves a double-precision floating point value from the device using a UTF-8 key.
virtual const CResult GetEnumFeatureEntries(const Base::CFLString< wchar_t > &flsFeature, std::vector< std::pair< int32_t, Base::CFLString< wchar_t > > > &vctEntries) const
Retrieves the enumeration entries of the specified feature.
virtual const CResult GetInt32Value(const char *pszKey, int32_t &i32Value) const
Retrieves a 32-bit integer (Int32) value from the device using a UTF-8 key.
virtual const CResult GetBoolValue(const char *pszKey, bool *pBValue) const override
Retrieves a boolean value from the device using a key (UTF-8 string).
virtual const CResult GetAutoDetectGigECameraSerialNumbers(Base::CFLArray< Base::CFLString< wchar_t > > *pFlarrSerialNumbers) override
Retrieves the serial numbers of detected GigE cameras.
virtual const CResult SetAutoFocusMethod(EAutoFocusMethod eMethod)
Set the method to be used for auto focus.
virtual const CResult GetFocusPosition(int64_t &i64Position) const
Get the current focus motor position.
virtual const CResult SetEnumValue(const char *pszKey, const int32_t *pI32Value) override
Sets an enum value on the device using a UTF-8 key.
virtual const CResult GetAcquiredRenderImage(Base::CFLImage *pFliImage) const
Obtain the acquired render image.
virtual const CResult SetEnumValue(const char *pszKey, const Base::CFLString< char > *pFlsValue) override
Sets an enum-type value on the device using a UTF-8 key and pointer to narrow string value.
virtual const CResult GetSupportedDeviceTypes(std::vector< EDeviceType > &vctTypes) const override
Retrieves the supported device types.
virtual const CResult ExecuteCommand(const char *pszCommand) const
Execute a command.
virtual const CResult SetInt64Value(const char *pszKey, const int64_t *pI64Value) override
Sets a 64-bit integer (Int64) value on the device using a UTF-8 key.
virtual const CResult Stop() override
Stops image acquisition.
virtual const CResult SetNUCMode(ENUCMode eMode)
Set the non-uniformity correction (NUC) mode.
virtual const CResult GetAutoDetectGigECameraSerialNumbers(Base::CFLArray< Base::CFLString< wchar_t > > &flarrSerialNumbers) override
Retrieves the serial numbers of detected GigE cameras.
virtual const CResult GetEnumValue(const char *pszKey, Base::CFLString< char > *pFlsValue) const override
Gets an enum-type value from the device using a UTF-8 key.
virtual const CResult GetTriggerSource(ETriggerSource &eSource) const override
Retrieves the trigger source of the camera.
virtual const CResult TriggerWithSoftware() override
Executes a software trigger on the device.
virtual const CResult GetInt64Value(const char *pszKey, int64_t *pI64Value) const override
Retrieves a 64-bit integer (Int64) value from the device using a UTF-8 key.
virtual const CResult GetNUCMode(ENUCMode *pEMode) const
Get the currently set non-uniformity correction (NUC) mode.
virtual const CResult GetFocusPosition(int64_t *pI64Position) const
Get the current focus motor position.
virtual const CResult GetMeasuredTemperature(const Foundation::CFLFigure *pFlfSource, double *pF64Min, double *pF64Max, double *pF64Mean) const
Get minimum, maximum, and average temperature within the specified region.
virtual const CResult GetEnumValue(const char *pszKey, int32_t *pI32Value) const override
Retrieves an enum value from the device using a UTF-8 key.
virtual const CResult GetTriggerSource(ETriggerSource *pSource) const override
Retrieves the trigger source of the camera.
virtual const CResult SetFocusSpeed(int64_t i64Speed)
Set the speed of focus movement.
virtual const CResult SetFloatValue(const char *pszKey, const float *pF32Value) override
Sets a single-precision floating point value on the device using a UTF-8 key.
virtual const CResult GetAcquiredImage(Base::CFLImage &fliImage) const override
Retrieves the acquired image.
ENUCMode
Non-uniformity correction (NUC) mode.
Definition DeviceCameraSpinnaker.h:194
@ ENUCMode_Off
NUC off.
Definition DeviceCameraSpinnaker.h:198
@ ENUCMode_Automatic
NUC automatic.
Definition DeviceCameraSpinnaker.h:203
virtual const CResult Initialize() override
Initialize the device.
virtual const CResult GetAutoFocusMethod(EAutoFocusMethod &eMethod) const
Get the currently set auto focus method.
virtual const CResult UpdateMeasurementParameter()
Update internal parameters for temperature measurement.
virtual const CResult GetTriggerMode(bool &bOn) const override
Retrieves the trigger mode of the camera.
virtual const CResult GetFocusStep(int64_t &i64Step) const
Get the current number of focus steps.
virtual const CResult SetFocusDirection(EFocusDirection eDirection)
Set the direction of focus movement.
virtual const CResult GetMeasuredTemperature(int64_t i64X, int64_t i64Y, double &f64Value) const
Get the measured temperature at the specified pixel coordinates.
virtual const CResult GetMeasuredTemperature(const Foundation::CFLFigure *pFlfSource, double &f64Min, double &f64Max, double &f64Mean) const
Get minimum, maximum, and average temperature within the specified region.
virtual const CResult ExecuteFocusIncrement() const
Increment the focus by the set step size.
virtual const Base::CFLImage * GetIntrinsicImage() const override
Retrieves the intrinsic image pointer of the device.
virtual const CResult Grab() override
Acquires a single image from the device.
virtual const CResult SetTriggerMode(bool bOn) override
Sets the trigger mode of the camera.
virtual const CResult SetBoolValue(const char *pszKey, const bool *pBValue) override
Sets a boolean value on the device using a key (UTF-8 string).
virtual const CResult GetFocusSpeed(int64_t *pI64Speed) const
Get the current speed of focus movement.
virtual const CResult GetInt32Value(const char *pszKey, int32_t *pI32Value) const override
Retrieves a 32-bit integer (Int32) value from the device using a UTF-8 key.
virtual const CResult SetFocusStep(int64_t i64Step)
Set the number of steps for focus adjustment.
virtual const CResult GetAutoFocusMethod(EAutoFocusMethod *pEMethod) const
Get the currently set auto focus method.
virtual const CResult GetFocusSpeed(int64_t &i64Speed) const
Get the current speed of focus movement.
virtual const CResult SetDoubleValue(const char *pszKey, const double *pF64Value) override
Sets a double-precision floating point value on the device using a UTF-8 key.
virtual const CResult GetStringValue(const char *pszKey, Base::CFLString< char > *pFlsValue) const override
Retrieves a string value from the device using a UTF-8 key.
virtual const CResult GetFocusStep(int64_t *pI64Step) const
Get the current number of focus steps.
virtual const CResult GetFocusDirection(EFocusDirection &eDirection) const
Get the current direction of focus movement.
virtual const CResult GetAutoDetectCameraLinkCameraSerialNumbers(Base::CFLArray< Base::CFLString< wchar_t > > *pFlarrSerialNumbers) override
Retrieves the serial numbers of detected Camera Link cameras.
virtual const CResult SetFocusPosition(int64_t i64Position)
Set the focus motor position.
virtual const CResult SetRenderPaletteType(EPaletteType eType)
Set the palette type used for rendering.
virtual const CResult SetFocusDistance(double f64Distance)
Set the focus distance.
virtual const CResult Terminate() override
Terminate the device.
EPaletteType
Palette type.
Definition DeviceCameraSpinnaker.h:46
@ EPaletteType_HighContrastJet
High Contrast Jet.
Definition DeviceCameraSpinnaker.h:125
@ EPaletteType_Infer
Infer.
Definition DeviceCameraSpinnaker.h:85
@ EPaletteType_Magma
Magma.
Definition DeviceCameraSpinnaker.h:105
@ EPaletteType_Arctic
Arctic.
Definition DeviceCameraSpinnaker.h:75
@ EPaletteType_Jet
Jet.
Definition DeviceCameraSpinnaker.h:80
@ EPaletteType_CoolDepth
Cool Depth.
Definition DeviceCameraSpinnaker.h:120
@ EPaletteType_Coolwarm
Coolwarm.
Definition DeviceCameraSpinnaker.h:115
@ EPaletteTypeCount
Palette type count.
Definition DeviceCameraSpinnaker.h:135
@ EPaletteType_RedGray
Red Gray.
Definition DeviceCameraSpinnaker.h:95
@ EPaletteType_MDS
MDS.
Definition DeviceCameraSpinnaker.h:65
@ EPaletteType_AutumnFire
Autumn Fire.
Definition DeviceCameraSpinnaker.h:130
@ EPaletteType_Gray
Gray.
Definition DeviceCameraSpinnaker.h:55
@ EPaletteType_Viridis
Viridis.
Definition DeviceCameraSpinnaker.h:100
@ EPaletteType_BoardDetection
Board Detection.
Definition DeviceCameraSpinnaker.h:60
@ EPaletteType_Cividis
Cividis.
Definition DeviceCameraSpinnaker.h:110
@ EPaletteType_Rainbow
Rainbow.
Definition DeviceCameraSpinnaker.h:70
@ EPaletteType_Plasma
Plasma.
Definition DeviceCameraSpinnaker.h:90
@ EPaletteType_Iron
Iron.
Definition DeviceCameraSpinnaker.h:50
virtual bool IsRenderEnabled() const
Check whether rendering is enabled.
virtual const CResult GetFocusDistance(double &f64Distance) const
Get the current focus distance.
virtual const CResult Live() override
Starts live image acquisition.
virtual const CResult SetTriggerSource(ETriggerSource eSource) override
Sets the trigger source of the camera.
virtual const CResult GetTriggerMode(bool *pOn) const override
Retrieves the trigger mode of the camera.
virtual const CResult ExecuteFocusDecrement() const
Decrement the focus by the set step size.
virtual const CResult GetAutoDetectUSBCameraSerialNumbers(Base::CFLArray< Base::CFLString< wchar_t > > &flarrSerialNumbers) override
Retrieves the serial numbers of detected USB cameras.
virtual const CResult GetMeasuredTemperature(int64_t i64X, int64_t i64Y, double *pF64Value) const
Get the measured temperature at the specified pixel coordinates.
virtual const CResult GetAcquiredRenderImage(Base::CFLImage &fliImage) const
Obtain the acquired render image.
virtual const CResult GetNUCMode(ENUCMode &eMode) const
Get the currently set non-uniformity correction (NUC) mode.
virtual const CResult GetEnumFeatureEntries(const Base::CFLString< wchar_t > &flsFeature, std::vector< std::pair< int32_t, Base::CFLString< wchar_t > > > *pVctEntries) const override
Retrieves the enumeration entries of the specified feature.
virtual const CResult GetFocusDirection(EFocusDirection *pEDirection) const
Get the current direction of focus movement.
virtual const CResult SetInt32Value(const char *pszKey, const int32_t *pI32Value) override
Sets a 32-bit integer (Int32) value on the device using a UTF-8 key.
EFocusDirection
Focus movement direction.
Definition DeviceCameraSpinnaker.h:147
@ EFocusDirection_Stop
Stop focus movement.
Definition DeviceCameraSpinnaker.h:151
@ EFocusDirection_Near
Move focus nearer.
Definition DeviceCameraSpinnaker.h:161
@ EFocusDirection_Far
Move focus farther.
Definition DeviceCameraSpinnaker.h:156
virtual const CResult SetStringValue(const char *pszKey, const Base::CFLString< char > *pFlsValue) override
Sets a string value on the device using a UTF-8 key and pointer to narrow string.
virtual const CResult GetMeasuredTemperature(const Foundation::CFLFigure &flfSource, double *pF64Min, double *pF64Max, double *pF64Mean) const
Get minimum, maximum, and average temperature within the specified region.
virtual const CResult ExecuteCommand(const wchar_t *pWcsCommand) const
Execute a command.
virtual const CResult GetAutoDetectCameraLinkCameraSerialNumbers(Base::CFLArray< Base::CFLString< wchar_t > > &flarrSerialNumbers) override
Retrieves the serial numbers of detected Camera Link cameras.
virtual const CResult ExecuteAutoFocus() const
Execute the auto focus operation based on the current method.
virtual const CResult GetAcquiredImage(Base::CFLImage *pFliImage) const override
Retrieves the acquired image.
virtual EPaletteType GetRenderPaletteType() const
Get the current palette type used for rendering.
EAutoFocusMethod
Auto focus method.
Definition DeviceCameraSpinnaker.h:173
@ EAutoFocusMethod_Coarse
Coarse (fast, less accurate).
Definition DeviceCameraSpinnaker.h:177
@ EAutoFocusMethod_Fine
Fine (slow, more accurate).
Definition DeviceCameraSpinnaker.h:182
CDeviceCameraSpinnaker()
Default constructor.
virtual const CResult GetFloatValue(const char *pszKey, float *pF32Value) const override
Retrieves a single-precision floating point value from the device using a UTF-8 key.
virtual const CResult GetMeasuredTemperature(const Foundation::CFLFigure &flfSource, double &f64Min, double &f64Max, double &f64Mean) const
Get minimum, maximum, and average temperature within the specified region.
virtual const CResult ExecuteNUCAction() const
Execute a non-uniformity correction (NUC) action.
virtual const CResult GetFocusDistance(double *pF64Distance) const
Get the current focus distance.
virtual const CResult GetAutoDetectUSBCameraSerialNumbers(Base::CFLArray< Base::CFLString< wchar_t > > *pFlarrSerialNumbers) override
Retrieves the serial numbers of detected USB cameras.
virtual const CResult EnableRender(bool bEnable)
Enable or disable rendering.
virtual ~CDeviceCameraSpinnaker()
Default destructor.
virtual const CResult GetDoubleValue(const char *pszKey, double *pF64Value) const override
Retrieves a double-precision floating point value from the device using a UTF-8 key.
ETriggerSource
Trigger source.
Definition DeviceGenICamBase.h:80
CDeviceGenICamTypeBase()
Default constructor.
A base class of classes representing figures.
Definition FLFigure.h:27
Definition AutoFileCleaner.h:19