PySpin Module Overview¶
The PySpin module is the top-level Python package for Spinnaker SDK camera
control. All classes, enumerations, and constants are accessible directly from
this namespace after a standard import PySpin.
Quick start¶
import PySpin
system = PySpin.System.GetInstance()
cam_list = system.GetCameras()
for cam in cam_list:
cam.Init()
cam.BeginAcquisition()
image = cam.GetNextImage()
image.Release()
cam.EndAcquisition()
cam.DeInit()
cam_list.Clear()
system.ReleaseInstance()
Class summary¶
The table below lists every public class exported by PySpin. Follow the
links for full method and property documentation.
- class AVIOption¶
Bases:
objectOptions for saving AVI files.
- property frameRate¶
- property height¶
- property reserved¶
- property width¶
- class ActionCommandResult¶
Bases:
objectAction Command Result
- property DeviceAddress¶
- property Status¶
- class BMPOption¶
Bases:
objectOptions for saving Bitmap image.
- property indexedColor_8bit¶
- property reserved¶
- class BooleanNode(*args, **kwargs)¶
-
Interface for string properties.
- GetValue(self, Verify=False, IgnoreCache=False) bool¶
Parameters¶
Verify: bool IgnoreCache: bool
Get node value
- param Verify:
Enables Range verification (default = false). The AccessMode is always checked.
- param IgnoreCache:
If true the value is read ignoring any caches (default = false).
The value read.
- IsValueUpdated(self) bool¶
Checks if the content of the node has changed since the value was last cached by IsValueUpdated() or GetValue().
true if the node value has changed, false otherwise.
- class CBasePtr(*args)¶
Bases:
objectEncapsulates a GenApi pointer dealing with the dynamic_cast automatically.
- GetAccessMode(self) Spinnaker::GenApi::EAccessMode¶
- class CBooleanPtr(*args)¶
Bases:
objectEncapsulates a GenApi pointer dealing with the dynamic_cast automatically.
- DeregisterCallback(self, hCallback) bool¶
Parameters¶
hCallback: Spinnaker::GenApi::CallbackHandleType
- FromString(self, ValueStr, Verify=True)¶
Parameters¶
ValueStr: Spinnaker::GenICam::gcstring const & Verify: bool
- GetAccessMode(self) Spinnaker::GenApi::EAccessMode¶
- GetCachingMode(self) Spinnaker::GenApi::ECachingMode¶
- GetChildren(self, LinkType=ctReadingChildren)¶
Parameters¶
LinkType: enum Spinnaker::GenApi::ELinkType
- GetLockNodes(self)¶
- GetNameSpace(self) Spinnaker::GenApi::ENameSpace¶
- GetParents(self)¶
- GetPollingTime(self) int64_t¶
- GetPrincipalInterfaceType(self) Spinnaker::GenApi::EInterfaceType¶
- GetProperty(self, PropertyName, ValueStr, AttributeStr) bool¶
Parameters¶
PropertyName: Spinnaker::GenICam::gcstring const & ValueStr: Spinnaker::GenICam::gcstring & AttributeStr: Spinnaker::GenICam::gcstring &
- GetPropertyNames(self)¶
- GetSelectedFeatures(self)¶
- GetSelectingFeatures(self)¶
- GetVisibility(self) Spinnaker::GenApi::EVisibility¶
- ImposeAccessMode(self, ImposedAccessMode)¶
Parameters¶
ImposedAccessMode: enum Spinnaker::GenApi::EAccessMode
- ImposeVisibility(self, ImposedVisibility)¶
Parameters¶
ImposedVisibility: enum Spinnaker::GenApi::EVisibility
- InvalidateNode(self)¶
- IsAccessModeCacheable(self) Spinnaker::GenApi::EYesNo¶
- class CCMSettings¶
Bases:
object- property Application¶
- property ColorSpace¶
- property ColorTemperature¶
- property CustomCCMCode¶
- property Sensor¶
- property Type¶
- class CCategoryPtr(*args)¶
Bases:
objectEncapsulates a GenApi pointer dealing with the dynamic_cast automatically.
- DeregisterCallback(self, hCallback) bool¶
Parameters¶
hCallback: Spinnaker::GenApi::CallbackHandleType
- FromString(self, ValueStr, Verify=True)¶
Parameters¶
ValueStr: Spinnaker::GenICam::gcstring const & Verify: bool
- GetAccessMode(self) Spinnaker::GenApi::EAccessMode¶
- GetCachingMode(self) Spinnaker::GenApi::ECachingMode¶
- GetChildren(self, LinkType=ctReadingChildren)¶
Parameters¶
LinkType: enum Spinnaker::GenApi::ELinkType
- GetFeatures(self)¶
- GetLockNodes(self)¶
- GetNameSpace(self) Spinnaker::GenApi::ENameSpace¶
- GetParents(self)¶
- GetPollingTime(self) int64_t¶
- GetPrincipalInterfaceType(self) Spinnaker::GenApi::EInterfaceType¶
- GetProperty(self, PropertyName, ValueStr, AttributeStr) bool¶
Parameters¶
PropertyName: Spinnaker::GenICam::gcstring const & ValueStr: Spinnaker::GenICam::gcstring & AttributeStr: Spinnaker::GenICam::gcstring &
- GetPropertyNames(self)¶
- GetSelectedFeatures(self)¶
- GetSelectingFeatures(self)¶
- GetVisibility(self) Spinnaker::GenApi::EVisibility¶
- ImposeAccessMode(self, ImposedAccessMode)¶
Parameters¶
ImposedAccessMode: enum Spinnaker::GenApi::EAccessMode
- ImposeVisibility(self, ImposedVisibility)¶
Parameters¶
ImposedVisibility: enum Spinnaker::GenApi::EVisibility
- InvalidateNode(self)¶
- IsAccessModeCacheable(self) Spinnaker::GenApi::EYesNo¶
- class CCommandPtr(*args)¶
Bases:
objectEncapsulates a GenApi pointer dealing with the dynamic_cast automatically.
- DeregisterCallback(self, hCallback) bool¶
Parameters¶
hCallback: Spinnaker::GenApi::CallbackHandleType
- FromString(self, ValueStr, Verify=True)¶
Parameters¶
ValueStr: Spinnaker::GenICam::gcstring const & Verify: bool
- GetAccessMode(self) Spinnaker::GenApi::EAccessMode¶
- GetCachingMode(self) Spinnaker::GenApi::ECachingMode¶
- GetChildren(self, LinkType=ctReadingChildren)¶
Parameters¶
LinkType: enum Spinnaker::GenApi::ELinkType
- GetLockNodes(self)¶
- GetNameSpace(self) Spinnaker::GenApi::ENameSpace¶
- GetParents(self)¶
- GetPollingTime(self) int64_t¶
- GetPrincipalInterfaceType(self) Spinnaker::GenApi::EInterfaceType¶
- GetProperty(self, PropertyName, ValueStr, AttributeStr) bool¶
Parameters¶
PropertyName: Spinnaker::GenICam::gcstring const & ValueStr: Spinnaker::GenICam::gcstring & AttributeStr: Spinnaker::GenICam::gcstring &
- GetPropertyNames(self)¶
- GetSelectedFeatures(self)¶
- GetSelectingFeatures(self)¶
- GetVisibility(self) Spinnaker::GenApi::EVisibility¶
- ImposeAccessMode(self, ImposedAccessMode)¶
Parameters¶
ImposedAccessMode: enum Spinnaker::GenApi::EAccessMode
- ImposeVisibility(self, ImposedVisibility)¶
Parameters¶
ImposedVisibility: enum Spinnaker::GenApi::EVisibility
- InvalidateNode(self)¶
- IsAccessModeCacheable(self) Spinnaker::GenApi::EYesNo¶
- class CDeviceInfoPtr(*args)¶
Bases:
objectEncapsulates a GenApi pointer dealing with the dynamic_cast automatically.
- class CEnumEntryPtr(*args)¶
Bases:
objectEncapsulates a GenApi pointer dealing with the dynamic_cast automatically.
- DeregisterCallback(self, hCallback) bool¶
Parameters¶
hCallback: Spinnaker::GenApi::CallbackHandleType
- FromString(self, ValueStr, Verify=True)¶
Parameters¶
ValueStr: Spinnaker::GenICam::gcstring const & Verify: bool
- GetAccessMode(self) Spinnaker::GenApi::EAccessMode¶
- GetCachingMode(self) Spinnaker::GenApi::ECachingMode¶
- GetChildren(self, LinkType=ctReadingChildren)¶
Parameters¶
LinkType: enum Spinnaker::GenApi::ELinkType
- GetLockNodes(self)¶
- GetNameSpace(self) Spinnaker::GenApi::ENameSpace¶
- GetNumericValue(self) double¶
- GetParents(self)¶
- GetPollingTime(self) int64_t¶
- GetPrincipalInterfaceType(self) Spinnaker::GenApi::EInterfaceType¶
- GetProperty(self, PropertyName, ValueStr, AttributeStr) bool¶
Parameters¶
PropertyName: Spinnaker::GenICam::gcstring const & ValueStr: Spinnaker::GenICam::gcstring & AttributeStr: Spinnaker::GenICam::gcstring &
- GetPropertyNames(self)¶
- GetSelectedFeatures(self)¶
- GetSelectingFeatures(self)¶
- GetValue(self) int64_t¶
- GetVisibility(self) Spinnaker::GenApi::EVisibility¶
- ImposeAccessMode(self, ImposedAccessMode)¶
Parameters¶
ImposedAccessMode: enum Spinnaker::GenApi::EAccessMode
- ImposeVisibility(self, ImposedVisibility)¶
Parameters¶
ImposedVisibility: enum Spinnaker::GenApi::EVisibility
- InvalidateNode(self)¶
- IsAccessModeCacheable(self) Spinnaker::GenApi::EYesNo¶
- class CEnumerationPtr(*args)¶
Bases:
objectEncapsulates a GenApi pointer dealing with the dynamic_cast automatically.
- DeregisterCallback(self, hCallback) bool¶
Parameters¶
hCallback: Spinnaker::GenApi::CallbackHandleType
- FromString(self, ValueStr, Verify=True)¶
Parameters¶
ValueStr: Spinnaker::GenICam::gcstring const & Verify: bool
- GetAccessMode(self) Spinnaker::GenApi::EAccessMode¶
- GetCachingMode(self) Spinnaker::GenApi::ECachingMode¶
- GetChildren(self, LinkType=ctReadingChildren)¶
Parameters¶
LinkType: enum Spinnaker::GenApi::ELinkType
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntries(self)¶
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
- GetEntryByName(self, Symbolic) IEnumEntry¶
Parameters¶
Symbolic: Spinnaker::GenICam::gcstring const &
- GetIntValue(self, Verify=False, IgnoreCache=False) int64_t¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetLockNodes(self)¶
- GetNameSpace(self) Spinnaker::GenApi::ENameSpace¶
- GetParents(self)¶
- GetPollingTime(self) int64_t¶
- GetPrincipalInterfaceType(self) Spinnaker::GenApi::EInterfaceType¶
- GetProperty(self, PropertyName, ValueStr, AttributeStr) bool¶
Parameters¶
PropertyName: Spinnaker::GenICam::gcstring const & ValueStr: Spinnaker::GenICam::gcstring & AttributeStr: Spinnaker::GenICam::gcstring &
- GetPropertyNames(self)¶
- GetSelectedFeatures(self)¶
- GetSelectingFeatures(self)¶
- GetVisibility(self) Spinnaker::GenApi::EVisibility¶
- ImposeAccessMode(self, ImposedAccessMode)¶
Parameters¶
ImposedAccessMode: enum Spinnaker::GenApi::EAccessMode
- ImposeVisibility(self, ImposedVisibility)¶
Parameters¶
ImposedVisibility: enum Spinnaker::GenApi::EVisibility
- InvalidateNode(self)¶
- IsAccessModeCacheable(self) Spinnaker::GenApi::EYesNo¶
- class CFeatureBag¶
Bases:
IPersistScriptBag holding streamable features of a nodetree.
- GetFeatureBagHandle(self) void *¶
- LoadFromBag(self, pNodeMap, Verify=True, pErrorList=None) bool¶
Parameters¶
pNodeMap: Spinnaker::GenApi::INodeMap * Verify: bool pErrorList: Spinnaker::GenICam::gcstring_vector *
Loads the features from the bag to the node tree
- param pNodeMap:
The node map
- param Verify:
If true, all streamable features are read back
- param pErrorList:
If an error occurs during loading the error message is stored in the list and the loading continues For Verify=true the list of names in the feature bag is replayed
again. If a node is a selector it’s value is set to the value from the feature bag If not the value is read from the camera and compared with the value from the feature bag.
- SetInfo(self, Info)¶
Parameters¶
Info: Spinnaker::GenICam::gcstring &
sets information about the node map
- StoreToBag(self, pNodeMap, MaxNumPersistSkriptEntries=-1) int64_t¶
Parameters¶
pNodeMap: Spinnaker::GenApi::INodeMap * MaxNumPersistSkriptEntries: int const
Stores the streamable nodes to this feature bag.
- param pNodeMap:
The node map to persist
- param MaxNumPersistSkriptEntries:
The max number of entries in the container; -1 means unlimited
number of entries in the bag
- class CFloatPtr(*args)¶
Bases:
_SWIG_CFltPtrSmartPointer for IFloat interface pointer
- GetEnumAlias(self) IEnumeration¶
gets the interface of an enum alias node.
- class CIntegerPtr(*args)¶
Bases:
objectEncapsulates a GenApi pointer dealing with the dynamic_cast automatically.
- DeregisterCallback(self, hCallback) bool¶
Parameters¶
hCallback: Spinnaker::GenApi::CallbackHandleType
- FromString(self, ValueStr, Verify=True)¶
Parameters¶
ValueStr: Spinnaker::GenICam::gcstring const & Verify: bool
- GetAccessMode(self) Spinnaker::GenApi::EAccessMode¶
- GetCachingMode(self) Spinnaker::GenApi::ECachingMode¶
- GetChildren(self, LinkType=ctReadingChildren)¶
Parameters¶
LinkType: enum Spinnaker::GenApi::ELinkType
- GetInc(self) int64_t¶
- GetIncMode(self) Spinnaker::GenApi::EIncMode¶
- GetListOfValidValues(self, bounded=True) int64_autovector_t¶
Parameters¶
bounded: bool
- GetLockNodes(self)¶
- GetMax(self) int64_t¶
- GetMin(self) int64_t¶
- GetNameSpace(self) Spinnaker::GenApi::ENameSpace¶
- GetParents(self)¶
- GetPollingTime(self) int64_t¶
- GetPrincipalInterfaceType(self) Spinnaker::GenApi::EInterfaceType¶
- GetProperty(self, PropertyName, ValueStr, AttributeStr) bool¶
Parameters¶
PropertyName: Spinnaker::GenICam::gcstring const & ValueStr: Spinnaker::GenICam::gcstring & AttributeStr: Spinnaker::GenICam::gcstring &
- GetPropertyNames(self)¶
- GetRepresentation(self) Spinnaker::GenApi::ERepresentation¶
- GetSelectedFeatures(self)¶
- GetSelectingFeatures(self)¶
- GetVisibility(self) Spinnaker::GenApi::EVisibility¶
- ImposeAccessMode(self, ImposedAccessMode)¶
Parameters¶
ImposedAccessMode: enum Spinnaker::GenApi::EAccessMode
- ImposeVisibility(self, ImposedVisibility)¶
Parameters¶
ImposedVisibility: enum Spinnaker::GenApi::EVisibility
- InvalidateNode(self)¶
- IsAccessModeCacheable(self) Spinnaker::GenApi::EYesNo¶
- class CNodeMapDynPtr(*args)¶
Bases:
objectEncapsulates a GenApi pointer dealing with the dynamic_cast automatically.
- ClearAllNodes(self)¶
- Connect(self, pPort, PortName) bool¶
Parameters¶
pPort: IPort * PortName: Spinnaker::GenICam::gcstring const &
Connect(self, pPort) -> bool
Parameters¶
pPort: IPort *
- DisableAutoPoll(self)¶
- ExtractIndependentSubtree(self, XMLData, InjectXMLData, SubTreeRootNodeName, ExtractedSubtree)¶
Parameters¶
XMLData: Spinnaker::GenICam::gcstring const & InjectXMLData: Spinnaker::GenICam::gcstring const & SubTreeRootNodeName: Spinnaker::GenICam::gcstring const & ExtractedSubtree: Spinnaker::GenICam::gcstring &
- GetNodes(self)¶
- GetNumNodes(self) uint64_t¶
- GetSupportedSchemaVersions(self)¶
- InvalidateNodes(self)¶
- LoadXMLFromFileInject(self, TargetFileName, InjectFileName)¶
Parameters¶
TargetFileName: Spinnaker::GenICam::gcstring const & InjectFileName: Spinnaker::GenICam::gcstring const &
- LoadXMLFromStringInject(self, TargetXMLData, InjectXMLData)¶
Parameters¶
TargetXMLData: Spinnaker::GenICam::gcstring const & InjectXMLData: Spinnaker::GenICam::gcstring const &
- LoadXMLFromZIPFile(self, ZipFileName)¶
Parameters¶
ZipFileName: Spinnaker::GenICam::gcstring const &
- MergeXMLFiles(self, TargetFileName, InjectedFileName, OutputFileName)¶
Parameters¶
TargetFileName: Spinnaker::GenICam::gcstring const & InjectedFileName: Spinnaker::GenICam::gcstring const & OutputFileName: Spinnaker::GenICam::gcstring const &
- PreprocessXMLFromFile(self, XMLFileName, StyleSheetFileName, OutputFileName, XMLValidation=xvDefault)¶
Parameters¶
XMLFileName: Spinnaker::GenICam::gcstring const & StyleSheetFileName: Spinnaker::GenICam::gcstring const & OutputFileName: Spinnaker::GenICam::gcstring const & XMLValidation: uint32_t const
- PreprocessXMLFromZIPFile(self, XMLFileName, StyleSheetFileName, OutputFileName, XMLValidation=xvDefault)¶
Parameters¶
XMLFileName: Spinnaker::GenICam::gcstring const & StyleSheetFileName: Spinnaker::GenICam::gcstring const & OutputFileName: Spinnaker::GenICam::gcstring const & XMLValidation: uint32_t const
- class CNodeMapPtr(*args)¶
Bases:
objectEncapsulates a GenApi pointer dealing with the dynamic_cast automatically.
- Connect(self, pPort, PortName) bool¶
Parameters¶
pPort: IPort * PortName: Spinnaker::GenICam::gcstring const &
Connect(self, pPort) -> bool
Parameters¶
pPort: IPort *
- DisableAutoPoll(self)¶
- GetNodes(self)¶
- GetNumNodes(self) uint64_t¶
- InvalidateNodes(self)¶
- class CNodePtr(*args)¶
Bases:
objectEncapsulates a GenApi pointer dealing with the dynamic_cast automatically.
- DeregisterCallback(self, hCallback) bool¶
Parameters¶
hCallback: Spinnaker::GenApi::CallbackHandleType
- GetAccessMode(self) Spinnaker::GenApi::EAccessMode¶
- GetCachingMode(self) Spinnaker::GenApi::ECachingMode¶
- GetChildren(self, LinkType=ctReadingChildren)¶
Parameters¶
LinkType: enum Spinnaker::GenApi::ELinkType
- GetLockNodes(self)¶
- GetNameSpace(self) Spinnaker::GenApi::ENameSpace¶
- GetParents(self)¶
- GetPollingTime(self) int64_t¶
- GetPrincipalInterfaceType(self) Spinnaker::GenApi::EInterfaceType¶
- GetProperty(self, PropertyName, ValueStr, AttributeStr) bool¶
Parameters¶
PropertyName: Spinnaker::GenICam::gcstring const & ValueStr: Spinnaker::GenICam::gcstring & AttributeStr: Spinnaker::GenICam::gcstring &
- GetPropertyNames(self)¶
- GetSelectedFeatures(self)¶
- GetSelectingFeatures(self)¶
- GetVisibility(self) Spinnaker::GenApi::EVisibility¶
- ImposeAccessMode(self, ImposedAccessMode)¶
Parameters¶
ImposedAccessMode: enum Spinnaker::GenApi::EAccessMode
- ImposeVisibility(self, ImposedVisibility)¶
Parameters¶
ImposedVisibility: enum Spinnaker::GenApi::EVisibility
- InvalidateNode(self)¶
- IsAccessModeCacheable(self) Spinnaker::GenApi::EYesNo¶
- class CRegisterPtr(*args)¶
Bases:
objectEncapsulates a GenApi pointer dealing with the dynamic_cast automatically.
- DeregisterCallback(self, hCallback) bool¶
Parameters¶
hCallback: Spinnaker::GenApi::CallbackHandleType
- FromString(self, ValueStr, Verify=True)¶
Parameters¶
ValueStr: Spinnaker::GenICam::gcstring const & Verify: bool
- Get(self, pBuffer, Length, Verify=False, IgnoreCache=False)¶
Parameters¶
pBuffer: uint8_t * Length: int64_t Verify: bool IgnoreCache: bool
Get(self, size_read) -> std::vector< uint8_t >
Parameters¶
size_read: int64_t
Get(self, size_read, verify_range) -> std::vector< uint8_t >
Parameters¶
size_read: int64_t verify_range: bool
Get(self, size_read, verify_range, ignore_cache) -> std::vector< uint8_t >
Parameters¶
size_read: int64_t verify_range: bool ignore_cache: bool
Gets a NumPy array representing the contents of the register, as 8-bit unsigned ints.
Parameters:¶
pBuffer: The number of bytes to retrieve
Verify: Enables Range verification (default = false). The AccessMode is always checked
IgnoreCache: If true the value is read ignoring any caches (default = false)
- GetAccessMode(self) Spinnaker::GenApi::EAccessMode¶
- GetAddress(self) int64_t¶
- GetCachingMode(self) Spinnaker::GenApi::ECachingMode¶
- GetChildren(self, LinkType=ctReadingChildren)¶
Parameters¶
LinkType: enum Spinnaker::GenApi::ELinkType
- GetLength(self) int64_t¶
- GetLockNodes(self)¶
- GetNameSpace(self) Spinnaker::GenApi::ENameSpace¶
- GetParents(self)¶
- GetPollingTime(self) int64_t¶
- GetPrincipalInterfaceType(self) Spinnaker::GenApi::EInterfaceType¶
- GetProperty(self, PropertyName, ValueStr, AttributeStr) bool¶
Parameters¶
PropertyName: Spinnaker::GenICam::gcstring const & ValueStr: Spinnaker::GenICam::gcstring & AttributeStr: Spinnaker::GenICam::gcstring &
- GetPropertyNames(self)¶
- GetSelectedFeatures(self)¶
- GetSelectingFeatures(self)¶
- GetVisibility(self) Spinnaker::GenApi::EVisibility¶
- ImposeAccessMode(self, ImposedAccessMode)¶
Parameters¶
ImposedAccessMode: enum Spinnaker::GenApi::EAccessMode
- ImposeVisibility(self, ImposedVisibility)¶
Parameters¶
ImposedVisibility: enum Spinnaker::GenApi::EVisibility
- InvalidateNode(self)¶
- IsAccessModeCacheable(self) Spinnaker::GenApi::EYesNo¶
- RegisterCallback(self, pCallback) Spinnaker::GenApi::CallbackHandleType¶
Parameters¶
pCallback: Spinnaker::GenApi::CNodeCallback *
- Set(self, pBuffer, Verify=True)¶
Parameters¶
pBuffer: uint8_t const * Verify: bool
Set the register’s contents with the contents (as 8-bit unsigned ints) of the given array.
Parameters:¶
pBuffer: The NumPy array containing the data to set
Verify: Enables AccessMode and Range verification (default = true)
- class CSelectorPtr(*args)¶
Bases:
objectEncapsulates a GenApi pointer dealing with the dynamic_cast automatically.
- GetAccessMode(self) Spinnaker::GenApi::EAccessMode¶
- GetSelectedFeatures(self)¶
- GetSelectingFeatures(self)¶
- class CSelectorSet(*args, **kwargs)¶
Bases:
NodeThe set of selectors selecting a given node
- Restore(self)¶
- class CStringPtr(*args)¶
Bases:
objectEncapsulates a GenApi pointer dealing with the dynamic_cast automatically.
- DeregisterCallback(self, hCallback) bool¶
Parameters¶
hCallback: Spinnaker::GenApi::CallbackHandleType
- FromString(self, ValueStr, Verify=True)¶
Parameters¶
ValueStr: Spinnaker::GenICam::gcstring const & Verify: bool
- GetAccessMode(self) Spinnaker::GenApi::EAccessMode¶
- GetCachingMode(self) Spinnaker::GenApi::ECachingMode¶
- GetChildren(self, LinkType=ctReadingChildren)¶
Parameters¶
LinkType: enum Spinnaker::GenApi::ELinkType
- GetLockNodes(self)¶
- GetMaxLength(self) int64_t¶
- GetNameSpace(self) Spinnaker::GenApi::ENameSpace¶
- GetParents(self)¶
- GetPollingTime(self) int64_t¶
- GetPrincipalInterfaceType(self) Spinnaker::GenApi::EInterfaceType¶
- GetProperty(self, PropertyName, ValueStr, AttributeStr) bool¶
Parameters¶
PropertyName: Spinnaker::GenICam::gcstring const & ValueStr: Spinnaker::GenICam::gcstring & AttributeStr: Spinnaker::GenICam::gcstring &
- GetPropertyNames(self)¶
- GetSelectedFeatures(self)¶
- GetSelectingFeatures(self)¶
- GetValue(self, Verify=False, IgnoreCache=False) gcstring¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetVisibility(self) Spinnaker::GenApi::EVisibility¶
- ImposeAccessMode(self, ImposedAccessMode)¶
Parameters¶
ImposedAccessMode: enum Spinnaker::GenApi::EAccessMode
- ImposeVisibility(self, ImposedVisibility)¶
Parameters¶
ImposedVisibility: enum Spinnaker::GenApi::EVisibility
- InvalidateNode(self)¶
- IsAccessModeCacheable(self) Spinnaker::GenApi::EYesNo¶
- RegisterCallback(self, pCallback) Spinnaker::GenApi::CallbackHandleType¶
Parameters¶
pCallback: Spinnaker::GenApi::CNodeCallback *
- class CValuePtr(*args)¶
Bases:
objectEncapsulates a GenApi pointer dealing with the dynamic_cast automatically.
- DeregisterCallback(self, hCallback) bool¶
Parameters¶
hCallback: Spinnaker::GenApi::CallbackHandleType
- FromString(self, ValueStr, Verify=True)¶
Parameters¶
ValueStr: Spinnaker::GenICam::gcstring const & Verify: bool
- GetAccessMode(self) Spinnaker::GenApi::EAccessMode¶
- GetCachingMode(self) Spinnaker::GenApi::ECachingMode¶
- GetChildren(self, LinkType=ctReadingChildren)¶
Parameters¶
LinkType: enum Spinnaker::GenApi::ELinkType
- GetLockNodes(self)¶
- GetNameSpace(self) Spinnaker::GenApi::ENameSpace¶
- GetParents(self)¶
- GetPollingTime(self) int64_t¶
- GetPrincipalInterfaceType(self) Spinnaker::GenApi::EInterfaceType¶
- GetProperty(self, PropertyName, ValueStr, AttributeStr) bool¶
Parameters¶
PropertyName: Spinnaker::GenICam::gcstring const & ValueStr: Spinnaker::GenICam::gcstring & AttributeStr: Spinnaker::GenICam::gcstring &
- GetPropertyNames(self)¶
- GetSelectedFeatures(self)¶
- GetSelectingFeatures(self)¶
- GetVisibility(self) Spinnaker::GenApi::EVisibility¶
- ImposeAccessMode(self, ImposedAccessMode)¶
Parameters¶
ImposedAccessMode: enum Spinnaker::GenApi::EAccessMode
- ImposeVisibility(self, ImposedVisibility)¶
Parameters¶
ImposedVisibility: enum Spinnaker::GenApi::EVisibility
- InvalidateNode(self)¶
- IsAccessModeCacheable(self) Spinnaker::GenApi::EYesNo¶
- class Camera(*args, **kwargs)¶
Bases:
CameraBaseThe camera object class.
- Init(self)¶
- property AasRoiEnable¶
- property AasRoiHeight¶
- property AasRoiOffsetX¶
- property AasRoiOffsetY¶
- property AasRoiWidth¶
- property AcquisitionAbort¶
- property AcquisitionArm¶
- property AcquisitionBurstFrameCount¶
- property AcquisitionFrameCount¶
- property AcquisitionFramePeriod¶
- property AcquisitionFramePeriodRaw¶
- property AcquisitionFrameRate¶
- property AcquisitionFrameRateEnable¶
- property AcquisitionFrameRatePersistence¶
- property AcquisitionLineRate¶
- property AcquisitionMaxFrameRate¶
- property AcquisitionMode¶
- property AcquisitionModeAddress¶
- property AcquisitionResultingFrameRate¶
- property AcquisitionStart¶
- property AcquisitionStartAddress¶
- property AcquisitionStatus¶
- property AcquisitionStatusSelector¶
- property AcquisitionStop¶
- property AcquisitionStopAddress¶
- property AcquisitionTransferFrameRate¶
- property ActionDeviceKey¶
- property ActionGroupKey¶
- property ActionGroupMask¶
- property ActionQueueEmpty¶
- property ActionQueueSize¶
- property ActionSelector¶
- property ActionSignalSize¶
- property ActionUnconditionalMode¶
- property AdaptiveCompressionEnable¶
- property AdcBitDepth¶
- property AdvancedParameter¶
- property AdvancedParameterSave¶
- property AdvancedParameterSelector¶
- property AutoAlgorithmSelector¶
- property AutoExposureControlLoopDamping¶
- property AutoExposureControlPriority¶
- property AutoExposureEVCompensation¶
- property AutoExposureExposureTimeLowerLimit¶
- property AutoExposureExposureTimeUpperLimit¶
- property AutoExposureGainLowerLimit¶
- property AutoExposureGainUpperLimit¶
- property AutoExposureGreyValueLowerLimit¶
- property AutoExposureGreyValueUpperLimit¶
- property AutoExposureLightingMode¶
- property AutoExposureMeteringMode¶
- property AutoExposureTargetGreyValue¶
- property AutoExposureTargetGreyValueAuto¶
- property BalanceRatio¶
- property BalanceRatioSelector¶
- property BalanceWhiteAuto¶
- property BalanceWhiteAutoDamping¶
- property BalanceWhiteAutoLowerLimit¶
- property BalanceWhiteAutoProfile¶
- property BalanceWhiteAutoUpperLimit¶
- property BinningHorizontal¶
- property BinningHorizontalMode¶
- property BinningSelector¶
- property BinningVertical¶
- property BinningVerticalMode¶
- property BlackLevel¶
- property BlackLevelAuto¶
- property BlackLevelAutoBalance¶
- property BlackLevelClampingEnable¶
- property BlackLevelRaw¶
- property BlackLevelSelector¶
- property BsiFlatFieldCorrectionAuto¶
- property BsiFlatFieldCorrectionAutoDamping¶
- property BsiFlatFieldCorrectionEnable¶
- property BsiFlatFieldCorrectionGain¶
- property BsiFlatFieldCorrectionGainSelector¶
- property BufferedBurstFrameCountMax¶
- property BufferedBurstMode¶
- property BuiltInTest¶
- property CFG_COLOR¶
- property CFG_FACTORY¶
- property CFG_GAMMA¶
- property CFG_LF_FFC¶
- property ChunkBlackLevel¶
- property ChunkBlackLevelSelector¶
- property ChunkCRC¶
- property ChunkCompressionMode¶
- property ChunkCompressionRatio¶
- property ChunkCounterSelector¶
- property ChunkCounterValue¶
- property ChunkCurrentDatarate¶
- property ChunkEnable¶
- property ChunkEncoderSelector¶
- property ChunkEncoderStatus¶
- property ChunkEncoderValue¶
- property ChunkExposureEndLineStatusAll¶
- property ChunkExposureTime¶
- property ChunkExposureTimeSelector¶
- property ChunkFrameID¶
- property ChunkGain¶
- property ChunkGainSelector¶
- property ChunkHeight¶
- property ChunkImage¶
- property ChunkImageComponent¶
- property ChunkInferenceBoundingBoxResult¶
- property ChunkInferenceConfidence¶
- property ChunkInferenceFrameId¶
- property ChunkInferenceResult¶
- property ChunkLargePenalty¶
- property ChunkLinePitch¶
- property ChunkLineStatusAll¶
- property ChunkMaxZ¶
- property ChunkMinZ¶
- property ChunkModeActive¶
- property ChunkOffsetX¶
- property ChunkOffsetY¶
- property ChunkPartSelector¶
- property ChunkPixelDynamicRangeMax¶
- property ChunkPixelDynamicRangeMin¶
- property ChunkPixelFormat¶
- property ChunkRegionID¶
- property ChunkScan3dAxisMax¶
- property ChunkScan3dAxisMin¶
- property ChunkScan3dBaseline¶
- property ChunkScan3dCoordinateOffset¶
- property ChunkScan3dCoordinateReferenceSelector¶
- property ChunkScan3dCoordinateReferenceValue¶
- property ChunkScan3dCoordinateScale¶
- property ChunkScan3dCoordinateSelector¶
- property ChunkScan3dCoordinateSystem¶
- property ChunkScan3dCoordinateSystemReference¶
- property ChunkScan3dCoordinateTransformSelector¶
- property ChunkScan3dDistanceUnit¶
- property ChunkScan3dFocalLength¶
- property ChunkScan3dInvalidDataFlag¶
- property ChunkScan3dInvalidDataValue¶
- property ChunkScan3dOutputMode¶
- property ChunkScan3dPrincipalPointU¶
- property ChunkScan3dPrincipalPointV¶
- property ChunkScan3dTransformValue¶
- property ChunkScanLineSelector¶
- property ChunkSelector¶
- property ChunkSequencerSetActive¶
- property ChunkSerialData¶
- property ChunkSerialDataLength¶
- property ChunkSerialReceiveOverflow¶
- property ChunkSmallPenalty¶
- property ChunkSourceID¶
- property ChunkStereoHeight¶
- property ChunkStereoWidth¶
- property ChunkStreamChannelID¶
- property ChunkTimerSelector¶
- property ChunkTimerValue¶
- property ChunkTimestamp¶
- property ChunkTimestampLatchValue¶
- property ChunkTransferBlockID¶
- property ChunkTransferQueueCurrentBlockCount¶
- property ChunkTransferStreamID¶
- property ChunkUniquenessRatio¶
- property ChunkWidth¶
- property ClConfiguration¶
- property ClTimeSlotsCount¶
- property ColorTransformationEnable¶
- property ColorTransformationSelector¶
- property ColorTransformationValue¶
- property ColorTransformationValueSelector¶
- property ComponentActiveCount¶
- property ComponentDestination¶
- property ComponentEnable¶
- property ComponentSelector¶
- property CompressedFrameDropCount¶
- property CompressionSaturationPriority¶
- property ConfigurationFactoryInfo¶
- property ConfigurationInfo¶
- property ConnectionConfig¶
- property ConnectionConfigDefault¶
- property ConnectionReset¶
- property ControlPacketSizeMax¶
- property ControlPacketsReservedBandwidth¶
- property CounterDelay¶
- property CounterDuration¶
- property CounterEventActivation¶
- property CounterEventSource¶
- property CounterReset¶
- property CounterResetActivation¶
- property CounterResetSource¶
- property CounterSelector¶
- property CounterStatus¶
- property CounterTriggerActivation¶
- property CounterTriggerSource¶
- property CounterValue¶
- property CounterValueAtReset¶
- property CrosshairOverlay¶
- property CxpConnectionSelector¶
- property CxpConnectionTestErrorCount¶
- property CxpConnectionTestMode¶
- property CxpConnectionTestPacketCount¶
- property CxpLinkConfiguration¶
- property CxpLinkConfigurationPreferred¶
- property CxpLinkConfigurationStatus¶
- property CxpPoCxpAuto¶
- property CxpPoCxpStatus¶
- property CxpPoCxpTripReset¶
- property CxpPoCxpTurnOff¶
- property DecimationHorizontal¶
- property DecimationHorizontalMode¶
- property DecimationSelector¶
- property DecimationVertical¶
- property DecimationVerticalMode¶
- property DefectCorrectStaticEnable¶
- property DefectCorrectionMode¶
- property DefectPixelAdd¶
- property DefectPixelClearAll¶
- property DefectPixelCorrectionEnable¶
- property DefectPixelReadX¶
- property DefectPixelReadY¶
- property DefectPixelRemove¶
- property DefectPixelRestore¶
- property DefectPixelRestoreFactory¶
- property DefectPixelSave¶
- property DefectPixelSaveAsFactoryDefault¶
- property DefectPixelSelect¶
- property DefectPixelStatus¶
- property DefectPixelTestMode¶
- property DefectPixelTotal¶
- property DefectPixelWriteX¶
- property DefectPixelWriteY¶
- property DefectTableApply¶
- property DefectTableCoordinateX¶
- property DefectTableCoordinateY¶
- property DefectTableFactoryRestore¶
- property DefectTableIndex¶
- property DefectTablePixelCount¶
- property DefectTableSave¶
- property DefectTableSensor¶
- property Deinterlacing¶
- property DeviceCharacterSet¶
- property DeviceClockFrequency¶
- property DeviceClockSelector¶
- property DeviceConnectionID¶
- property DeviceConnectionSelector¶
- property DeviceConnectionSpeed¶
- property DeviceConnectionStatus¶
- property DeviceData¶
- property DeviceDataFinalWrite¶
- property DeviceDataIndex¶
- property DeviceDataRW_Select¶
- property DeviceDataRestart¶
- property DeviceDataStatus¶
- property DeviceEventChannelCount¶
- property DeviceFamilyName¶
- property DeviceFeaturePersistenceEnd¶
- property DeviceFeaturePersistenceStart¶
- property DeviceFirmwareVersion¶
- property DeviceGenCPVersionMajor¶
- property DeviceGenCPVersionMinor¶
- property DeviceID¶
- property DeviceIndicatorMode¶
- property DeviceLinkBandwidthReserve¶
- property DeviceLinkCommandTimeout¶
- property DeviceLinkConnectionCount¶
- property DeviceLinkCurrentThroughput¶
- property DeviceLinkHeartbeatMode¶
- property DeviceLinkHeartbeatTimeout¶
- property DeviceLinkSelector¶
- property DeviceLinkSpeed¶
- property DeviceLinkThroughputLimit¶
- property DeviceLinkThroughputLimitMode¶
- property DeviceManifestEntrySelector¶
- property DeviceManifestPrimaryURL¶
- property DeviceManifestSchemaMajorVersion¶
- property DeviceManifestSchemaMinorVersion¶
- property DeviceManifestSecondaryURL¶
- property DeviceManifestXMLMajorVersion¶
- property DeviceManifestXMLMinorVersion¶
- property DeviceManifestXMLSubMinorVersion¶
- property DeviceManufacturerInfo¶
- property DeviceMaxThroughput¶
- property DeviceModelName¶
- property DevicePowerSupplySelector¶
- property DeviceRegistersCheck¶
- property DeviceRegistersEndianness¶
- property DeviceRegistersStreamingEnd¶
- property DeviceRegistersStreamingStart¶
- property DeviceRegistersValid¶
- property DeviceReset¶
- property DeviceSFNCVersionMajor¶
- property DeviceSFNCVersionMinor¶
- property DeviceSFNCVersionSubMinor¶
- property DeviceScanType¶
- property DeviceSensorChroma¶
- property DeviceSerialNumber¶
- property DeviceSerialPortBaudRate¶
- property DeviceSerialPortSelector¶
- property DeviceStreamChannelCount¶
- property DeviceStreamChannelEndianness¶
- property DeviceStreamChannelLink¶
- property DeviceStreamChannelPacketSize¶
- property DeviceStreamChannelSelector¶
- property DeviceStreamChannelType¶
- property DeviceTLType¶
- property DeviceTLVersionMajor¶
- property DeviceTLVersionMinor¶
- property DeviceTLVersionSubMinor¶
- property DeviceTapGeometry¶
- property DeviceTapGeometryAddress¶
- property DeviceTemperature¶
- property DeviceTemperatureSelector¶
- property DeviceType¶
- property DeviceUptime¶
- property DeviceUserID¶
- property DeviceVendorName¶
- property DeviceVersion¶
- property ElectricalCompliancyTest¶
- property EncoderDivider¶
- property EncoderMode¶
- property EncoderOutputMode¶
- property EncoderReset¶
- property EncoderResetActivation¶
- property EncoderResetSource¶
- property EncoderSelector¶
- property EncoderSourceA¶
- property EncoderSourceB¶
- property EncoderStatus¶
- property EncoderTimeout¶
- property EncoderValue¶
- property EncoderValueAtReset¶
- property EnumerationCount¶
- property EventAcquisitionEnd¶
- property EventAcquisitionEndFrameID¶
- property EventAcquisitionEndTimestamp¶
- property EventAcquisitionError¶
- property EventAcquisitionErrorFrameID¶
- property EventAcquisitionErrorTimestamp¶
- property EventAcquisitionStart¶
- property EventAcquisitionStartFrameID¶
- property EventAcquisitionStartTimestamp¶
- property EventAcquisitionTransferEnd¶
- property EventAcquisitionTransferEndFrameID¶
- property EventAcquisitionTransferEndTimestamp¶
- property EventAcquisitionTransferStart¶
- property EventAcquisitionTransferStartFrameID¶
- property EventAcquisitionTransferStartTimestamp¶
- property EventAcquisitionTrigger¶
- property EventAcquisitionTriggerFrameID¶
- property EventAcquisitionTriggerTimestamp¶
- property EventActionLate¶
- property EventActionLateFrameID¶
- property EventActionLateTimestamp¶
- property EventCounter0End¶
- property EventCounter0EndFrameID¶
- property EventCounter0EndTimestamp¶
- property EventCounter0Start¶
- property EventCounter0StartFrameID¶
- property EventCounter0StartTimestamp¶
- property EventCounter1End¶
- property EventCounter1EndFrameID¶
- property EventCounter1EndTimestamp¶
- property EventCounter1Start¶
- property EventCounter1StartFrameID¶
- property EventCounter1StartTimestamp¶
- property EventEncoder0Restarted¶
- property EventEncoder0RestartedFrameID¶
- property EventEncoder0RestartedTimestamp¶
- property EventEncoder0Stopped¶
- property EventEncoder0StoppedFrameID¶
- property EventEncoder0StoppedTimestamp¶
- property EventEncoder1Restarted¶
- property EventEncoder1RestartedFrameID¶
- property EventEncoder1RestartedTimestamp¶
- property EventEncoder1Stopped¶
- property EventEncoder1StoppedFrameID¶
- property EventEncoder1StoppedTimestamp¶
- property EventError¶
- property EventErrorCode¶
- property EventErrorFrameID¶
- property EventErrorTimestamp¶
- property EventExposureEnd¶
- property EventExposureEndFrameID¶
- property EventExposureEndTimestamp¶
- property EventExposureStart¶
- property EventExposureStartFrameID¶
- property EventExposureStartTimestamp¶
- property EventFrameBurstEnd¶
- property EventFrameBurstEndFrameID¶
- property EventFrameBurstEndTimestamp¶
- property EventFrameBurstStart¶
- property EventFrameBurstStartFrameID¶
- property EventFrameBurstStartTimestamp¶
- property EventFrameEnd¶
- property EventFrameEndFrameID¶
- property EventFrameEndTimestamp¶
- property EventFrameStart¶
- property EventFrameStartFrameID¶
- property EventFrameStartTimestamp¶
- property EventFrameTransferEnd¶
- property EventFrameTransferEndFrameID¶
- property EventFrameTransferEndTimestamp¶
- property EventFrameTransferStart¶
- property EventFrameTransferStartFrameID¶
- property EventFrameTransferStartTimestamp¶
- property EventFrameTrigger¶
- property EventFrameTriggerFrameID¶
- property EventFrameTriggerTimestamp¶
- property EventLine0AnyEdge¶
- property EventLine0AnyEdgeFrameID¶
- property EventLine0AnyEdgeTimestamp¶
- property EventLine0FallingEdge¶
- property EventLine0FallingEdgeFrameID¶
- property EventLine0FallingEdgeTimestamp¶
- property EventLine0RisingEdge¶
- property EventLine0RisingEdgeFrameID¶
- property EventLine0RisingEdgeTimestamp¶
- property EventLine1AnyEdge¶
- property EventLine1AnyEdgeFrameID¶
- property EventLine1AnyEdgeTimestamp¶
- property EventLine1FallingEdge¶
- property EventLine1FallingEdgeFrameID¶
- property EventLine1FallingEdgeTimestamp¶
- property EventLine1RisingEdge¶
- property EventLine1RisingEdgeFrameID¶
- property EventLine1RisingEdgeTimestamp¶
- property EventLinkSpeedChange¶
- property EventLinkSpeedChangeFrameID¶
- property EventLinkSpeedChangeTimestamp¶
- property EventLinkTrigger0¶
- property EventLinkTrigger0FrameID¶
- property EventLinkTrigger0Timestamp¶
- property EventLinkTrigger1¶
- property EventLinkTrigger1FrameID¶
- property EventLinkTrigger1Timestamp¶
- property EventNotification¶
- property EventSelector¶
- property EventSequencerSetChange¶
- property EventSequencerSetChangeFrameID¶
- property EventSequencerSetChangeTimestamp¶
- property EventSerialData¶
- property EventSerialDataLength¶
- property EventSerialPortReceive¶
- property EventSerialPortReceiveTimestamp¶
- property EventSerialReceiveOverflow¶
- property EventStream0TransferBlockEnd¶
- property EventStream0TransferBlockEndFrameID¶
- property EventStream0TransferBlockEndTimestamp¶
- property EventStream0TransferBlockStart¶
- property EventStream0TransferBlockStartFrameID¶
- property EventStream0TransferBlockStartTimestamp¶
- property EventStream0TransferBlockTrigger¶
- property EventStream0TransferBlockTriggerFrameID¶
- property EventStream0TransferBlockTriggerTimestamp¶
- property EventStream0TransferBurstEnd¶
- property EventStream0TransferBurstEndFrameID¶
- property EventStream0TransferBurstEndTimestamp¶
- property EventStream0TransferBurstStart¶
- property EventStream0TransferBurstStartFrameID¶
- property EventStream0TransferBurstStartTimestamp¶
- property EventStream0TransferEnd¶
- property EventStream0TransferEndFrameID¶
- property EventStream0TransferEndTimestamp¶
- property EventStream0TransferOverflow¶
- property EventStream0TransferOverflowFrameID¶
- property EventStream0TransferOverflowTimestamp¶
- property EventStream0TransferPause¶
- property EventStream0TransferPauseFrameID¶
- property EventStream0TransferPauseTimestamp¶
- property EventStream0TransferResume¶
- property EventStream0TransferResumeFrameID¶
- property EventStream0TransferResumeTimestamp¶
- property EventStream0TransferStart¶
- property EventStream0TransferStartFrameID¶
- property EventStream0TransferStartTimestamp¶
- property EventTest¶
- property EventTestTimestamp¶
- property EventTimer0End¶
- property EventTimer0EndFrameID¶
- property EventTimer0EndTimestamp¶
- property EventTimer0Start¶
- property EventTimer0StartFrameID¶
- property EventTimer0StartTimestamp¶
- property EventTimer1End¶
- property EventTimer1EndFrameID¶
- property EventTimer1EndTimestamp¶
- property EventTimer1Start¶
- property EventTimer1StartFrameID¶
- property EventTimer1StartTimestamp¶
- property ExposureActiveMode¶
- property ExposureAuto¶
- property ExposureMode¶
- property ExposureTime¶
- property ExposureTimeMode¶
- property ExposureTimeRaw¶
- property ExposureTimeSelector¶
- property ExternalVoltageEnable¶
- property ExternalVoltageSelector¶
- property ExternalVoltageValue¶
- property FPGATemperature¶
- property FPGATemperatureRaw¶
- property FPGA_RegisterAddress¶
- property FPGA_RegisterData¶
- property FPGA_RegisterRead¶
- property FPGA_RegisterSize¶
- property FPGA_RegisterWrite¶
- property FactoryReset¶
- property FanEnabled¶
- property FanPercentage¶
- property FanSpeed¶
- property FanType¶
- property FfcEnable¶
- property FfcMode¶
- property FfcUserGain¶
- property FfcUserOffset¶
- property FfcUserTableReset¶
- property FfcUserTableSave¶
- property FfcUserTableXCoordinate¶
- property FileAccessBuffer¶
- property FileAccessLength¶
- property FileAccessOffset¶
- property FileOpenMode¶
- property FileOperationExecute¶
- property FileOperationResult¶
- property FileOperationSelector¶
- property FileOperationStatus¶
- property FileSelector¶
- property FileSize¶
- property FlashStrobeActiveState¶
- property FlashStrobeDelay¶
- property FlashStrobeDelayRaw¶
- property FlashStrobeDuration¶
- property FlashStrobeDurationRaw¶
- property FlashStrobeMode¶
- property FrameCounterOverlay¶
- property FrameCounterReset¶
- property Gain¶
- property GainAuto¶
- property GainAutoBalance¶
- property GainConversion¶
- property GainMode¶
- property GainRaw¶
- property GainSelector¶
- property Gamma¶
- property GammaEnable¶
- property GammaFactor¶
- property GammaFactorRaw¶
- property GevActiveLinkCount¶
- property GevCCP¶
- property GevCurrentDefaultGateway¶
- property GevCurrentIPAddress¶
- property GevCurrentIPConfigurationDHCP¶
- property GevCurrentIPConfigurationLLA¶
- property GevCurrentIPConfigurationPersistentIP¶
- property GevCurrentPhysicalLinkConfiguration¶
- property GevCurrentSubnetMask¶
- property GevDiscoveryAckDelay¶
- property GevFirstURL¶
- property GevGVCPExtendedStatusCodes¶
- property GevGVCPExtendedStatusCodesSelector¶
- property GevGVCPHeartbeatDisable¶
- property GevGVCPPendingAck¶
- property GevGVCPPendingTimeout¶
- property GevGVSPExtendedIDMode¶
- property GevHeartbeatTimeout¶
- property GevIEEE1588¶
- property GevIEEE1588ClockAccuracy¶
- property GevIEEE1588ClockId¶
- property GevIEEE1588DataSetLatch¶
- property GevIEEE1588Mode¶
- property GevIEEE1588OffsetFromMasterLatched¶
- property GevIEEE1588ParentClockIdLatched¶
- property GevIEEE1588Status¶
- property GevIEEE1588StatusLatched¶
- property GevIPConfigurationStatus¶
- property GevInterfaceSelector¶
- property GevMACAddress¶
- property GevMCDA¶
- property GevMCPHostPort¶
- property GevMCRC¶
- property GevMCSP¶
- property GevMCTT¶
- property GevNumberOfActiveLinks¶
- property GevNumberOfInterfaces¶
- property GevPAUSEFrameReception¶
- property GevPAUSEFrameTransmission¶
- property GevPersistentDefaultGateway¶
- property GevPersistentIPAddress¶
- property GevPersistentSubnetMask¶
- property GevPhysicalLinkConfiguration¶
- property GevPhysicalLinkConfigurationCapability¶
- property GevPrimaryApplicationIPAddress¶
- property GevPrimaryApplicationSocket¶
- property GevPrimaryApplicationSwitchoverKey¶
- property GevSCCFGAllInTransmission¶
- property GevSCCFGExtendedChunkData¶
- property GevSCCFGPacketResendDestination¶
- property GevSCCFGUnconditionalStreaming¶
- property GevSCDA¶
- property GevSCPD¶
- property GevSCPDirection¶
- property GevSCPHostPort¶
- property GevSCPInterfaceIndex¶
- property GevSCPSBigEndian¶
- property GevSCPSDoNotFragment¶
- property GevSCPSFireTestPacket¶
- property GevSCPSPacketSize¶
- property GevSCSP¶
- property GevSCZoneConfigurationLock¶
- property GevSCZoneCount¶
- property GevSCZoneDirectionAll¶
- property GevSecondURL¶
- property GevStreamChannelSelector¶
- property GevSupportedOption¶
- property GevSupportedOptionSelector¶
- property GevTimestampTickFrequency¶
- property GuiXmlManifestAddress¶
- property Height¶
- property HeightAddress¶
- property HeightMax¶
- property HsUpconnection¶
- property Iidc2Address¶
- property Image1StreamID¶
- property Image1StreamIDAddress¶
- property Image2StreamID¶
- property Image2StreamIDAddress¶
- property ImageComponentEnable¶
- property ImageComponentSelector¶
- property ImageCompressionBitrate¶
- property ImageCompressionJPEGFormatOption¶
- property ImageCompressionMode¶
- property ImageCompressionQuality¶
- property ImageCompressionRateOption¶
- property InterfaceUtilization¶
- property IspEnable¶
- property LF_FF_Calibrate¶
- property LF_FF_CalibrationROI¶
- property LF_FF_CalibrationStatus¶
- property LF_FF_Correction¶
- property LF_FF_ManualSetSelector¶
- property LF_FF_RawSetData¶
- property LF_FF_RawSetDataEnd¶
- property LF_FF_RawSetDataReadStart¶
- property LF_FF_RawSetDataStatus¶
- property LF_FF_RawSetDataTransferSize¶
- property LF_FF_RawSetDataWriteStart¶
- property LF_FF_ReferencePoint¶
- property LF_FF_ResetCurrentSet¶
- property LF_FF_SequenceIndexSelector¶
- property LF_FF_SequenceLoad¶
- property LF_FF_SequenceReadCurrentSet¶
- property LF_FF_SequenceReadSelectedIndex¶
- property LF_FF_SequenceRepeat¶
- property LF_FF_SequenceReset¶
- property LF_FF_SequenceSave¶
- property LF_FF_SequenceSet¶
- property LF_FF_SequenceStartProgram¶
- property LF_FF_SequenceStatus¶
- property LF_FF_SequenceStopProgram¶
- property LF_FF_SequenceTotal¶
- property LF_FF_SetSelectionMode¶
- property LF_FF_ViewCorrection¶
- property LF_FF_ViewMetaData¶
- property LUTEnable¶
- property LUTEnd¶
- property LUTIndex¶
- property LUTSelection¶
- property LUTSelector¶
- property LUTStart¶
- property LUTStatus¶
- property LUTValue¶
- property LUTValueAll¶
- property LargePenalty¶
- property LensShadingCoefficientActiveSet¶
- property LensShadingCorrectionCalibration¶
- property LensShadingCorrectionCalibrationGainLimit¶
- property LensShadingCorrectionCalibrationSetup¶
- property LensShadingCorrectionCalibrationStatus¶
- property LensShadingCorrectionMode¶
- property LensShadingCorrectionStepSize¶
- property LensShadingCorrectionVersion¶
- property LineFilterWidth¶
- property LineFormat¶
- property LineInputFilterSelector¶
- property LineInverter¶
- property LineMode¶
- property LinePitch¶
- property LineSelector¶
- property LineSource¶
- property LineStatus¶
- property LineStatusAll¶
- property LinkErrorCount¶
- property LinkRecoveryCount¶
- property LinkUptime¶
- property LogicBlockLUTInputActivation¶
- property LogicBlockLUTInputSelector¶
- property LogicBlockLUTInputSource¶
- property LogicBlockLUTOutputValue¶
- property LogicBlockLUTOutputValueAll¶
- property LogicBlockLUTRowIndex¶
- property LogicBlockLUTSelector¶
- property LogicBlockSelector¶
- property MasterHostConnectionID¶
- property MaxDatarateThreshold¶
- property MaxDeviceResetTime¶
- property MaxNumberOfDefects¶
- property MaxZ¶
- property MinZ¶
- property MultiRoiConfigurationInvalidReason¶
- property MultiRoiConfigurationInvalidReasonAll¶
- property MultiRoiEnable¶
- property MultiRoiFeatureEnable¶
- property MultiRoiHeight¶
- property MultiRoiOffsetX¶
- property MultiRoiOffsetY¶
- property MultiRoiSelector¶
- property MultiRoiWidth¶
- property MultiRoiWindows¶
- property NumDirections¶
- property OffsetX¶
- property OffsetY¶
- property PacketResendRequestCount¶
- property PacketResendRequestsDroppedCount¶
- property PauseFrameCount¶
- property PayloadSize¶
- property PixelColorFilter¶
- property PixelDynamicRangeMax¶
- property PixelDynamicRangeMin¶
- property PixelFormat¶
- property PixelFormatAddress¶
- property PixelFormatInfoID¶
- property PixelFormatInfoSelector¶
- property PixelSize¶
- property PowerSupplyCurrent¶
- property PowerSupplyVoltage¶
- property RegionDestination¶
- property RegionMode¶
- property RegionSelector¶
- property ReverseX¶
- property ReverseY¶
- property Revision¶
- property RgbTransformLightSource¶
- property Saturation¶
- property SaturationEnable¶
- property Scan3dAxisMax¶
- property Scan3dAxisMin¶
- property Scan3dBaseline¶
- property Scan3dCoordinateOffset¶
- property Scan3dCoordinateReferenceSelector¶
- property Scan3dCoordinateReferenceValue¶
- property Scan3dCoordinateScale¶
- property Scan3dCoordinateSelector¶
- property Scan3dCoordinateSystem¶
- property Scan3dCoordinateSystemReference¶
- property Scan3dCoordinateTransformSelector¶
- property Scan3dDistanceUnit¶
- property Scan3dFocalLength¶
- property Scan3dInvalidDataFlag¶
- property Scan3dInvalidDataValue¶
- property Scan3dOutputMode¶
- property Scan3dPrincipalPointU¶
- property Scan3dPrincipalPointV¶
- property Scan3dTransformValue¶
- property SensitivityMatching¶
- property SensorBitDepth¶
- property SensorDescription¶
- property SensorDigitizationTaps¶
- property SensorHeight¶
- property SensorRegisterAddress¶
- property SensorRegisterData¶
- property SensorRegisterNonVolatileListSize¶
- property SensorRegisterNonVolatileReadSelector¶
- property SensorRegisterRead¶
- property SensorRegisterReadWriteMode¶
- property SensorRegisterRemove¶
- property SensorRegisterRemoveAll¶
- property SensorRegisterSize¶
- property SensorRegisterWrite¶
- property SensorShutterMode¶
- property SensorTaps¶
- property SensorTemperature¶
- property SensorTemperatureRaw¶
- property SensorWidth¶
- property SequencerConfigurationMode¶
- property SequencerConfigurationReset¶
- property SequencerConfigurationValid¶
- property SequencerFeatureEnable¶
- property SequencerMode¶
- property SequencerPathSelector¶
- property SequencerSetActive¶
- property SequencerSetLoad¶
- property SequencerSetNext¶
- property SequencerSetSave¶
- property SequencerSetSelector¶
- property SequencerSetStart¶
- property SequencerSetValid¶
- property SequencerTriggerActivation¶
- property SequencerTriggerSource¶
- property SerialPortBaudRate¶
- property SerialPortDataBits¶
- property SerialPortParity¶
- property SerialPortSelector¶
- property SerialPortSource¶
- property SerialPortStopBits¶
- property SerialReceiveFramingErrorCount¶
- property SerialReceiveParityErrorCount¶
- property SerialReceiveQueueClear¶
- property SerialReceiveQueueCurrentCharacterCount¶
- property SerialReceiveQueueMaxCharacterCount¶
- property SerialTransmitQueueCurrentCharacterCount¶
- property SerialTransmitQueueMaxCharacterCount¶
- property Sharpening¶
- property SharpeningAuto¶
- property SharpeningEnable¶
- property SharpeningThreshold¶
- property SmallPenalty¶
- property SoftwareSignalPulse¶
- property SoftwareSignalSelector¶
- property SoftwareUpdateStatus¶
- property SourceCount¶
- property SourceSelector¶
- property Standard¶
- property StereoHeight¶
- property StereoResolution¶
- property StereoWidth¶
- property StreamPacketSizeMax¶
- property TLParamsLocked¶
- property Test0001¶
- property TestErrorCount¶
- property TestErrorCountSelector¶
- property TestEventGenerate¶
- property TestImageSelector¶
- property TestImageVideoLevel¶
- property TestMode¶
- property TestPacketCountRx¶
- property TestPacketCountTx¶
- property TestPattern¶
- property TestPatternGeneratorSelector¶
- property TestPendingAck¶
- property TimerDelay¶
- property TimerDuration¶
- property TimerReset¶
- property TimerSelector¶
- property TimerStatus¶
- property TimerTriggerActivation¶
- property TimerTriggerSource¶
- property TimerValue¶
- property Timestamp¶
- property TimestampIncrement¶
- property TimestampLatch¶
- property TimestampLatchValue¶
- property TimestampReset¶
- property TotalDisparity¶
- property TransferAbort¶
- property TransferBlockCount¶
- property TransferBurstCount¶
- property TransferComponentSelector¶
- property TransferControlMode¶
- property TransferOperationMode¶
- property TransferPause¶
- property TransferQueueCurrentBlockCount¶
- property TransferQueueMaxBlockCount¶
- property TransferQueueMode¶
- property TransferQueueOverflowCount¶
- property TransferResume¶
- property TransferSelector¶
- property TransferStart¶
- property TransferStatus¶
- property TransferStatusSelector¶
- property TransferStop¶
- property TransferStreamChannel¶
- property TransferTriggerActivation¶
- property TransferTriggerMode¶
- property TransferTriggerSelector¶
- property TransferTriggerSource¶
- property TransmissionDelay¶
- property TransmissionDelayAverage¶
- property TransmissionDelayMax¶
- property TriggerActivation¶
- property TriggerDeglitch¶
- property TriggerDelay¶
- property TriggerDivider¶
- property TriggerEventTest¶
- property TriggerMode¶
- property TriggerMultiplier¶
- property TriggerOverlap¶
- property TriggerSelector¶
- property TriggerSoftware¶
- property TriggerSource¶
- property U3VAccessPrivilege¶
- property U3VCPCapability¶
- property U3VCPEIRMAvailable¶
- property U3VCPIIDC2Available¶
- property U3VCPSIRMAvailable¶
- property U3VCurrentSpeed¶
- property U3VMaxAcknowledgeTransferLength¶
- property U3VMaxCommandTransferLength¶
- property U3VMaxDeviceResponseTime¶
- property U3VMessageChannelID¶
- property U3VNumberOfStreamChannels¶
- property U3VVersionMajor¶
- property U3VVersionMinor¶
- property UniquenessRatio¶
- property UserMode¶
- property UserModeUpdate¶
- property UserOutputSelector¶
- property UserOutputValue¶
- property UserOutputValueAll¶
- property UserOutputValueAllMask¶
- property UserSetDefault¶
- property UserSetFeatureEnable¶
- property UserSetIsLocked¶
- property UserSetLoad¶
- property UserSetLock¶
- property UserSetRestoreCurrentSet¶
- property UserSetSave¶
- property UserSetSelector¶
- property V3_3Enable¶
- property WhiteBalanceCalibrate¶
- property WhiteBalanceHeight¶
- property WhiteBalanceOffsetX¶
- property WhiteBalanceOffsetY¶
- property WhiteBalanceStatus¶
- property WhiteBalanceStatusProgress¶
- property WhiteBalanceWidth¶
- property WhiteClip¶
- property WhiteClipSelector¶
- property Width¶
- property WidthAddress¶
- property WidthMax¶
- property WindowSizeH¶
- property WindowSizeW¶
- property WriteParamsLocked¶
- property XmlManifestSelector¶
- property XmlManifestSize¶
- property XmlSchemeVersion¶
- property XmlUrlAddress¶
- property XmlVersion¶
- property aPAUSEMACCtrlFramesReceived¶
- property aPAUSEMACCtrlFramesTransmitted¶
- class CameraBase(*args, **kwargs)¶
Bases:
ICameraBaseThe base class for the camera object.
- BeginAcquisition(self)¶
BeginAcquisition Starts the image acquisition engine. The camera must be initialized via a call to Init() before starting an acquisition.
Note that an error SPINNAKER_ERR_NOT_IMPLEMENTED will be thrown if an unsupported combination of stream mode and buffer ownership is set.
See: Init()
- DeInit(self)¶
DeInit Disconnects camera port, resets camera back to read access and frees GenICam node map and GUI XML.
Do not call more functions that access the remote device such as WritePort/ReadPort after calling DeInit(). Events should also be unregistered before calling camera DeInit(). Otherwise an exception will be thrown in the DeInit() call and require the user to unregister events before the camera can be re-initialized again.
See: Init()
UnregisterEventHandler(EventHandler & evtHandlerToUnregister)
- DiscoverMaxPacketSize(self) unsigned int¶
DiscoverMaxPacketSize Returns the largest packet size that can be safely used on the interface that device is connected to
The maximum packet size returned.
- EndAcquisition(self)¶
EndAcquisition Stops the image acquisition engine. If EndAcquisition() is called without a prior call to BeginAcquisition() an error message “Camera is not started” will be thrown. All Images that were acquired using GetNextImage() or GetNextImageSync() need to be released first using image->Release() or imageList->Release() before calling EndAcquisition(). All buffers in the input pool and output queue will be discarded when EndAcquisition() is called.
See: Init()
BeginAcquisition()
GetNextImage( grabTimeout )
GetNextImageSync( grabTimeout )
Image::Release()
- ForceIP(self)¶
ForceIP Forces the camera to be on the same subnet as its corresponding interface.
- GetAccessMode(self) Spinnaker::GenApi::EAccessMode¶
GetAccessMode Returns the access mode that the software has on the Camera. The camera does not need to be initialized before calling this function.
See: Init()
An enumeration value indicating the access mode
- GetActiveNumDataStreams(self) unsigned int¶
GetActiveNumDataStreams Returns the number of data streams that are currently active.
The number of active data streams
- GetBufferOwnership(self) Spinnaker::BufferOwnership¶
GetBufferOwnership Gets data buffer ownership. The data buffers can be owned by System or User. If the system owns the buffers, the memory required for the buffers are allocated and freed by the library. If user owns the buffers, the user is responsible for allocating and ultimately freeing the memory. By default, data buffers are owned by the System.
See: SetBufferOwnership()
SetUserBuffers()
Buffer ownership
- GetDeviceID(self) gcstring¶
GetDeviceID This returns a unique id string that identifies the camera; a unique string for USB devices, and MAC address for GEV devices.
string that uniquely identifies the camera
- GetDeviceSerialNumber(self) gcstring¶
GetDeviceSerialNumber This returns a manufacturer specific serial number that identifies the camera.
serial number string that identifies the camera
- GetGuiXml(self) gcstring¶
GetGuiXml Returns the GUI XML that can be passed into the Spinnaker GUI framework
GenICam::gcstring that represents the uncompressed GUI XML file
- GetNextImage(self, grabTimeout=EVENT_TIMEOUT_INFINITE, streamIndex=0) ImagePtr¶
Parameters¶
grabTimeout: uint64_t streamIndex: uint64_t
GetNextImage Gets the next image that was received by the transport layer. This function will block for the specified timeout period until an image arrives. Most cameras support one stream so the default streamIndex is 0, but if a camera supports multiple streams the user can input the streamIndex to select from which stream to grab images.
See: Init()
BeginAcquisition()
EndAcquisition()
Args: grabTimeout: A 64bit value that represents a timeout in milliseconds streamIndex: The index of the stream to grab the image from pointer to an Image object
- GetNextImageSync(self, grabTimeout=EVENT_TIMEOUT_INFINITE) ImageList¶
Parameters¶
grabTimeout: uint64_t
GetNextImageSync If a camera supports one or more streams, this function gets one image from each of the camera’s streams, and returns the image(s) in a list. This function will block for the specified timeout period until an image arrives on all the streams.
Note: This function should not be used together with GetNextImage. Results will be undeterministic and could lead to missing or lost of images.
See: Init()
BeginAcquisition()
EndAcquisition()
Args: grabTimeout: A 64bit value that represents a timeout in milliseconds a list containing the Image objects
- GetNodeMap(self) INodeMap¶
GetNodeMap Gets a reference to the node map that is generated from a GenICam XML file. The camera must be initialized by a call to Init() first before a node map reference can be successfully acquired.
See: Init()
A reference to the INodeMap.
- GetNumDataStreams(self) unsigned int¶
GetNumDataStreams Returns the total number of streams that the device supports. For configurable multistream cameras, use GetActiveNumDataStreams() to get the number of active streams.
See: GetActiveNumDataStreams()
The total number of data streams
- GetNumImagesInUse(self) unsigned int¶
GetNumImagesInUse Returns the number of images that are currently in use. Each of the images that are currently in use must be cleaned up with a call to image->Release() before calling system->ReleaseInstance().
The number of images that needs to be cleaned up.
- GetProducer(self) Spinnaker::ProducerPtr¶
Returns a producer from which this camera is enumerated.
A Producer object.
- GetTLDeviceNodeMap(self) INodeMap¶
GetTLDeviceNodeMap Gets a reference to the node map that is generated from a GenICam XML file for the GenTL Device module. The camera does not need to be initialized before acquiring this node map.
A reference to the INodeMap.
- GetTLStreamNodeMap(self, streamIndex=0) INodeMap¶
Parameters¶
streamIndex: uint64_t
GetTLStreamNodeMap Gets a reference to the node map that is generated from a GenICam XML file for the GenTL Stream module. The camera does not need to be initialized before acquiring this node map.
- param streamIndex:
The index of the stream to grab the image from
A reference to the INodeMap.
- GetUniqueID(self) gcstring¶
GetUniqueID This returns a unique id string that identifies the camera.
Deprecated Use GetDeviceID() instead.
string that uniquely identifies the camera
- GetUserBufferCount(self) uint64_t¶
GetUserBufferCount Gets the number of user memory buffers. This will throw an exception if user memory buffer has not been set. If the user memory is contiguous, this will throw an exception unless BeginAcquisition() has been called.
See: BeginAcquisition()
SetUserBuffers()
The number of user memory buffers
- GetUserBufferSize(self) uint64_t¶
GetUserBufferSize Gets the size of one user memory buffer (in bytes). This will throw an exception if user memory buffer has not been set. If the user memory is contiguous, this will throw an exception unless BeginAcquisition() has been called. To prevent image tearing when working with USB3 cameras, the size of each buffer should be equal to: ((unsigned int) (bufferSize + 1024 - 1) / 1024) * 1024 where 1024 is the USB3 packet size.
See: BeginAcquisition()
SetUserBuffers()
The size of one user memory buffer (in bytes)
- GetUserBufferTotalSize(self) uint64_t¶
GetUserBufferTotalSize Gets the total size of all the user memory buffers (in bytes). This will throw an exception if user memory buffer has not been set. The total size should be GetUserBufferSize() multiplied by GetUserBufferCount() or larger.
See: GetUserBufferCount()
GetUserBufferSize()
SetUserBuffers()
The total size of all the user memory buffers (in bytes)
- Init(self)¶
Init Connects to camera with read and write access, retrieves remote device and GUI XML and generates node map references.
This function needs to be called before any camera related API calls such as BeginAcquisition(), EndAcquisition(), GetNodeMap(), GetNextImage() and GetNextImageSync().
See: BeginAcquisition()
EndAcquisition()
GetNodeMap()
GetNextImage()
GetNextImageSync()
- IsInitialized(self) bool¶
IsInitialized Checks if camera is initialized. This function needs to return true in order to retrieve a valid NodeMap from the GetNodeMap() call.
See: GetNodeMap()
If camera is initialized or not
- IsStreaming(self) bool¶
IsStreaming Returns true if the camera is currently streaming or false if it is not.
See: Init()
returns true if camera is streaming and false otherwise.
- IsValid(self) bool¶
IsValid Checks a flag to determine if camera is still valid for use.
If camera is valid or not
- RegisterEventHandler(self, evtHandlerToRegister)¶
Parameters¶
evtHandlerToRegister: Spinnaker::EventHandler &
RegisterEventHandler(self, evtHandlerToRegister, eventName)
Parameters¶
evtHandlerToRegister: Spinnaker::DeviceEventHandler & eventName: Spinnaker::GenICam::gcstring const &
RegisterEventHandler(self, evtHandlerToRegister, streamIndex)
Parameters¶
evtHandlerToRegister: Spinnaker::ImageEventHandler & streamIndex: uint64_t
RegisterEventHandler(ImageEventHandler &, uint64_t) Registers a specific stream handler for the camera given a stream index. The camera has to be initialized first with a call to Init() before registering handlers for events.
See: Init()
UnregisterEventHandler()
Args: evtHandlerToRegister: The event handler to register for the camera streamIndex: The index of the stream of where this handler will be registered to
- SetBufferOwnership(self, mode)¶
Parameters¶
mode: enum Spinnaker::BufferOwnership const
SetBufferOwnership Sets data buffer ownership. The data buffers can be owned by System or User. If the system owns the buffers, the memory required for the buffers are allocated and freed by the library. If user owns the buffers, the user is responsible for allocating and ultimately freeing the memory. By default, data buffers are owned by the library.
Note that an error SPINNAKER_ERR_NOT_IMPLEMENTED will be thrown during BeginAcquisition() if an unsupported combination of stream mode and buffer ownership is set.
See: GetBufferOwnership()
SetUserBuffers()
Args: mode: Buffer ownership to set
- SetUserBuffers(self, pMemBuffers, totalSize)¶
Parameters¶
pMemBuffers: void *const totalSize: uint64_t
SetUserBuffers(self, ppMemBuffers, bufferCount, bufferSize)
Parameters¶
ppMemBuffers: void **const bufferCount: uint64_t const bufferSize: uint64_t const
SetUserBuffers Specify non-contiguous user allocated memory to use as data buffers. Each pointer to a buffer must have enough memory to hold one image. To prevent image tearing when working with USB3 cameras, the size of each buffer should be equal to: ((unsigned int) (bufferSize + 1024 - 1) / 1024) * 1024 where 1024 is the USB3 packet size.
See: GetBufferOwnership()
SetBufferOwnership()
GetUserBufferCount()
GetUserBufferSize()
GetUserBufferTotalSize()
Args: ppMemBuffers: Pointer to pointers that each point to a single user memory buffer to be written to bufferCount: The number of user memory buffers bufferSize: The size of the memory allocated for each user buffer (in bytes)
- UnregisterAllLoggingEventHandlers(self)¶
Unregisters all previously registered logging events.
- UnregisterEventHandler(self, evtHandlerToUnregister)¶
Parameters¶
evtHandlerToUnregister: Spinnaker::EventHandler &
UnregisterEventHandler Unregisters any type of event handler for the camera. Event handlers should be unregistered first before calling camera DeInit(). Otherwise an exception will be thrown in the DeInit() call and require the user to unregister event handlers before the camera can be re-initialized again.
See: DeInit()
RegisterEventHandler()
Args: evtHandlerToUnregister: The event handler to unregister from the camera
- class CameraList(*args)¶
Bases:
ICameraListUsed to hold a list of camera objects.
- Add(self, camera)¶
Parameters¶
camera: Spinnaker::CameraPtr
Adds a copy of an camera object.
- param camera:
A camera object to be added to this list.
- Append(self, list)¶
Parameters¶
list: Spinnaker::CameraList const &
Appends a copy of the camera list.
- param list:
Another CameraList object, whose elements are added to this list.
- Clear(self)¶
Clears the list of cameras and destroys their corresponding reference counted objects. This is necessary in order to clean up the parent interface. It is important that the camera list is destroyed or is cleared before calling system->ReleaseInstance() or else the call to system->ReleaseInstance() will result in an error message thrown that a reference to the camera is still held.
See: System:ReleaseInstance()
- GetByDeviceID(self, deviceID) CameraPtr¶
Parameters¶
deviceID: std::string
Returns a pointer to a camera object with the specified device identifier. This function will return a NULL CameraPtr if no matching device identifier is found.
- param deviceID:
The unique device identifier of the camera object to retrieve
A pointer to a camera object.
- GetByIndex(self, index) CameraPtr¶
Parameters¶
index: unsigned int
Returns a pointer to a camera object at the “index”. This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the input index is out of range.
- param index:
The index at which to retrieve the camera object
A pointer to a camera object.
- GetBySerial(self, serialNumber) CameraPtr¶
Parameters¶
serialNumber: std::string
Returns a pointer to a camera object with the specified serial number. This function will return a NULL CameraPtr if no matching camera serial is found.
- param serialNumber:
The serial number of the camera object to retrieve
A pointer to a camera object.
- GetSize(self) unsigned int¶
Returns the size of the camera list. The size is the number of Camera objects stored in the list.
An integer that represents the list size.
- Remove(self, camera)¶
Parameters¶
camera: Spinnaker::CameraPtr
Removes all occurences of an camera that is pointed to by the input camera pointer and destroys its corresponding reference counted object. This function will throw a Spinnaker exception with SPINNAKER_ERR_NOT_AVAILABLEerror if no matching camera is found.
- param camera:
Pointer to the camera that is to be removed
- RemoveByDeviceID(self, deviceID)¶
Parameters¶
deviceID: std::string
Removes a camera using its unique device identifier and destroys its corresponding reference counted object. This function will throw a Spinnaker exception with SPINNAKER_ERR_NOT_AVAILABLE error if no matching device identifier is found.
- param deviceID:
The unique device identifier of the camera object to retrieve
- RemoveByIndex(self, index)¶
Parameters¶
index: unsigned int
Removes a camera at “index” and destroys its corresponding reference counted object. This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the input index is out of range.
- param index:
The index at which to remove the Camera object
- RemoveBySerial(self, serialNumber)¶
Parameters¶
serialNumber: std::string
Removes a camera using its serial number and destroys its corresponding reference counted object. This function will throw a Spinnaker exception with SPINNAKER_ERR_NOT_AVAILABLE error if no matching camera serial is found.
- param serialNumber:
The serial number of the Camera object to remove
- class CameraPtr(*args)¶
Bases:
_SWIG_CamPtrA reference tracked pointer to a camera object.
- class CategoryNode(*args, **kwargs)¶
-
Interface for string properties.
- GetFeatures(self)¶
Get all features of the category (including sub-categories)
- class ChannelStatistics(image, channel)¶
Bases:
objectClass used to store statistics (as properties) for one channel of an image. Properties:
channel: The image channel that the statistics are based on (as an int).
range_min: The smallest possible pixel value.
range_max: The largest possible pixel value.
pixel_value_min: The smallest pixel value in the current channel.
pixel_value_max: The largest pixel value in the current channel.
num_pixel_values: The total number of pixel values in the current channel.
pixel_value_mean: The average pixel value in the current channel.
histogram: NumPy array representing the histogram of the current channel.
- property channel¶
- property histogram¶
- property num_pixel_values¶
- property pixel_value_max¶
- property pixel_value_mean¶
- property pixel_value_min¶
- property range_max¶
- property range_min¶
- class ChunkData(*args)¶
Bases:
IChunkDataThe chunk data which contains additional information about an image.
- GetBlackLevel(self) float64_t¶
Description: Returns the black level used to capture the image. Visibility:
- GetCRC(self) int64_t¶
Description: Returns the CRC of the image payload. Visibility:
- GetCompressionMode(self) int64_t¶
Description: Visibility:
- GetCompressionRatio(self) float64_t¶
Description: Visibility:
- GetCounterValue(self) int64_t¶
Description: Returns the value of the selected Chunk counter at the time of the FrameStart event. Visibility: Expert
- GetCurrentDatarate(self) int64_t¶
Description: Visibility:
- GetEnable(self) bool¶
Description: Enables the inclusion of the selected Chunk data in the payload of the image. Visibility:
- GetEncoderValue(self) int64_t¶
Description: Returns the counter’s value of the selected Encoder at the time of the FrameStart in area scan mode or the counter’s value at the time of the LineStart selected by ChunkScanLineSelector in LineScan mode. Visibility: Expert
- GetExposureEndLineStatusAll(self) int64_t¶
Description: Returns the status of all the I/O lines at the end of exposure event. Visibility:
- GetExposureTime(self) float64_t¶
Description: Returns the exposure time used to capture the image. Visibility:
- GetFrameID(self) int64_t¶
Description: Returns the image frame ID. Visibility:
- GetGain(self) float64_t¶
Description: Returns the gain used to capture the image. Visibility:
- GetHeight(self) int64_t¶
Description: Returns the height of the image included in the payload. Visibility:
- GetImage(self) int64_t¶
Description: Returns the image payload. Visibility:
- GetInferenceBoundingBoxResult(self) InferenceBoundingBoxResult¶
Description: Returns the chunk inference bounding box result data. Visibility: Expert
- GetInferenceConfidence(self) float64_t¶
Description: Returns the chunk data inference confidence percentage. Visibility: Expert
- GetInferenceFrameId(self) int64_t¶
Description: Returns the frame ID associated with the most recent inference result. Visibility: Expert
- GetInferenceResult(self) int64_t¶
Description: Returns the chunk data inference result. Visibility: Expert
- GetLargePenalty(self) int64_t¶
Description: Returns the penalty when the change of Disparity Change is plus or minus 1. Visibility: Expert
- GetLinePitch(self) int64_t¶
Description: Returns the LinePitch of the image included in the payload. Visibility: Expert
- GetLineStatusAll(self) int64_t¶
Description: Returns the status of all the I/O lines at the start of exposure event. Visibility:
- GetMaxZ(self) float64_t¶
Description: Returns the maximum depth in meters for the point cloud range. Visibility: Expert
- GetMinZ(self) float64_t¶
Description: Returns the minimum depth in meters for the point cloud range. Visibility: Expert
- GetModeActive(self) bool¶
Description: Activates the inclusion of Chunk data in the payload of the image. Visibility:
- GetOffsetX(self) int64_t¶
Description: Returns the Offset X of the image included in the payload. Visibility:
- GetOffsetY(self) int64_t¶
Description: Returns the Offset Y of the image included in the payload. Visibility:
- GetPartSelector(self) int64_t¶
Description: Selects the part to access in chunk data in a multipart transmission. Visibility: Expert
- GetPixelDynamicRangeMax(self) int64_t¶
Description: Returns the maximum value of dynamic range of the image included in the payload. Visibility: Expert
- GetPixelDynamicRangeMin(self) int64_t¶
Description: Returns the minimum value of dynamic range of the image included in the payload. Visibility: Expert
- GetScan3dAxisMax(self) float64_t¶
Description: Returns the Maximum Axis value for the selected coordinate axis of the image included in the payload. Visibility: Expert
- GetScan3dAxisMin(self) float64_t¶
Description: Returns the Minimum Axis value for the selected coordinate axis of the image included in the payload. Visibility: Expert
- GetScan3dBaseline(self) float64_t¶
Description: Returns the baseline as the physical distance of two cameras in a stereo camera setup. The value of this feature can be used for 3D reconstruction from disparity images. In this case, the unit of the 3D coordinates corresponds to the unit of the baseline. Visibility: Expert
- GetScan3dCoordinateOffset(self) float64_t¶
Description: Returns the Offset for the selected coordinate axis of the image included in the payload. Visibility: Expert
- GetScan3dCoordinateReferenceValue(self) float64_t¶
Description: Reads the value of a position or pose coordinate for the anchor or transformed coordinate systems relative to the reference point. Visibility: Expert
- GetScan3dCoordinateScale(self) float64_t¶
Description: Returns the Scale for the selected coordinate axis of the image included in the payload. Visibility: Expert
- GetScan3dFocalLength(self) float64_t¶
Description: Returns the focal length of the camera in pixel. The focal length depends on the selected region. The value of this feature takes into account horizontal binning, decimation, or any other function changing the image resolution. Visibility: Expert
- GetScan3dInvalidDataFlag(self) bool¶
Description: Returns if a specific non-valid data flag is used in the data stream. Visibility: Expert
- GetScan3dInvalidDataValue(self) float64_t¶
Description: Returns the Invalid Data Value used for the image included in the payload. Visibility: Expert
- GetScan3dPrincipalPointU(self) float64_t¶
Description: Returns the value of this feature gives the horizontal position of the principal point, relative to the region origin, i.e. OffsetX. The value of this feature takes into account horizontal binning, decimation, or any other function changing the image resolution. Visibility: Expert
- GetScan3dPrincipalPointV(self) float64_t¶
Description: Returns the value of this feature gives the vertical position of the principal point, relative to the region origin, i.e. OffsetY. The value of this feature takes into account vertical binning, decimation, or any other function changing the image resolution. Visibility: Expert
- GetScan3dTransformValue(self) float64_t¶
Description: Returns the transform value. Visibility: Expert
- GetScanLineSelector(self) int64_t¶
Description: Index for vector representation of one chunk value per line in an image. Visibility: Expert
- GetSequencerSetActive(self) int64_t¶
Description: Returns the index of the active set of the running sequencer included in the payload. Visibility:
- GetSerialData(self) uint8_t *¶
Description: Returns the serial data that was received. Visibility:
- GetSerialDataLength(self) int64_t¶
Description: Returns the length of the received serial data that was included in the payload. Visibility:
- GetSerialReceiveOverflow(self) bool¶
Description: Returns the status of the chunk serial receive overflow. Visibility:
- GetSmallPenalty(self) int64_t¶
Description: Returns the penalty when the change of Disparity Change is plus or minus 1. Visibility: Expert
- GetStereoHeight(self) int64_t¶
Description: Returns the height of the image after stereo processing by the device (in pixels). Visibility: Expert
- GetStereoWidth(self) int64_t¶
Description: Returns the width of the image after stereo processing by the device (in pixels). Visibility: Expert
- GetStreamChannelID(self) int64_t¶
Description: Returns identifier of the stream channel used to carry the block. Visibility: Expert
- GetTimerValue(self) float64_t¶
Description: Returns the value of the selected Timer at the time of the FrameStart internal event. Visibility: Expert
- GetTimestamp(self) int64_t¶
Description: Returns the Timestamp of the image. Visibility:
- GetTimestampLatchValue(self) int64_t¶
Description: Returns the last Timestamp latched with the TimestampLatch command. Visibility: Expert
- GetTransferBlockID(self) int64_t¶
Description: Returns the unique identifier of the transfer block used to transport the payload. Visibility: Expert
- GetTransferQueueCurrentBlockCount(self) int64_t¶
Description: Returns the current number of blocks in the transfer queue. Visibility: Expert
- GetUniquenessRatio(self) int64_t¶
Description: Returns the difference between the best matching disparity and the second-best matching disparity. Visibility: Expert
- GetWidth(self) int64_t¶
Description: Returns the width of the image included in the payload. Visibility:
- class CommandNode(*args, **kwargs)¶
-
Interface for string properties.
- Execute(self, Verify=True)¶
Parameters¶
Verify: bool
Execute the command
- param Verify:
Enables AccessMode and Range verification (default = true)
- class CoordinateDependentParams¶
Bases:
objectContainer for 3D scan calibration parameters used in stereo processing.
The Scan3DParameters class provides access to camera calibration parameters required for stereo image processing, including computing 3D point clouds from disparity images. This is the primary API for working with stereo camera parameters.
Key Parameters: Baseline: Physical distance between the two cameras (in meters)
Focal Length: Focal length in pixels
Principal Point (U, V): Optical center of the camera
Coordinate Scale/Offset: Transform disparity values to world coordinates
Coordinate Selector: Select coordinate axis (X/Y/Z or CoordinateA/B/C)
Invalid Data: Identify and handle invalid pixels in disparity images
Coordinate-Dependent Parameters: Some parameters (CoordinateOffset, CoordinateScale, InvalidDataFlag, InvalidDataValue, AxisMin, AxisMax) vary per coordinate axis. Set the CoordinateSelector before accessing these parameters to specify which coordinate axis (A/B/C) you want to configure.
Common Usage Pattern:
See: ImageUtilityStereo for stereo processing functions
StereoCameraParameters for legacy API (deprecated)
ToStereoCameraParameters() for backward compatibility conversion
FromStereoCameraParameters() for legacy parameter import
This class replaces the deprecated StereoCameraParameters struct. Use ToStereoCameraParameters() and FromStereoCameraParameters() for migration and backward compatibility.
For cameras with coordinate selector support, coordinate-dependent parameters are stored per axis. Always set CoordinateSelector before accessing these parameters to ensure you’re working with the correct axis. Structure containing all coordinate-dependent parameters for a single axis. This structure groups together all parameters that vary per coordinate (A, B, C). Use with GetCoordinateParams() and SetCoordinateParams() for efficient batch operations.
- property axisMax¶
- property axisMin¶
- property coordinateOffset¶
- property coordinateScale¶
- property invalidDataFlag¶
- property invalidDataValue¶
- class DeviceArrivalEventHandler¶
Bases:
IDeviceArrivalEventHandlerAn event handler for capturing the device arrival event.
- class DeviceEventExposureEndData¶
Bases:
objectData Fields for Device Event payload for EventExposureEnd
- property frameID¶
- class DeviceEventHandler¶
Bases:
IDeviceEventHandlerA handler to device events.
Deprecated Use GenApi::Register() and GenApi::Unregister() for handling device node callbacks instead.
- GetDeviceEventId(self) uint64_t¶
Get the ID of the device event.
The device event ID
- class DeviceEventInferenceData¶
Bases:
objectData fields for Device Event payload for EventInference
- property confidence¶
- property frameID¶
- property result¶
- class DeviceRemovalEventHandler¶
Bases:
IDeviceRemovalEventHandlerAn event handler for capturing the device removal event.
- class EAccessModeClass¶
Bases:
objectHolds conversion methods for the access mode enumeration.
- class ECachingModeClass¶
Bases:
objectHolds conversion methods for the caching mode enumeration.
- class EDisplayNotationClass¶
Bases:
objectHolds conversion methods for the notation type of floats.
- class EEndianessClass¶
Bases:
objectHolds conversion methods for the endianess enumeration.
- class EGenApiSchemaVersionClass¶
Bases:
objecthelper class converting EGenApiSchemaVersion from and to string
- class EInputDirectionClass¶
Bases:
objectHolds conversion methods for the notation type of floats.
- class ENameSpaceClass¶
Bases:
objectHolds conversion methods for the namespace enumeration.
- class ERepresentationClass¶
Bases:
objectHolds conversion methods for the representation enumeration.
- class ESignClass¶
Bases:
objectHolds conversion methods for the sign enumeration.
- class ESlopeClass¶
Bases:
objectHolds conversion methods for the converter formulas.
- class EStandardNameSpaceClass¶
Bases:
objectHolds conversion methods for the standard namespace enumeration.
- class EVisibilityClass¶
Bases:
objectHolds conversion methods for the visibility enumeration.
- class EYesNoClass¶
Bases:
objectHolds conversion methods for the standard namespace enumeration.
- class EnumEntryNode(*args, **kwargs)¶
Bases:
IEnumEntry,ValueNodeInterface for string properties.
- GetNumericValue(self) double¶
Get double number associated with the entry
- GetValue(self) int64_t¶
Get numeric enum value
- class EnumNode(*args, **kwargs)¶
Bases:
IEnumeration,ValueNodeInterface for string properties.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
Get the current entry
- GetEntries(self)¶
Get list of entry nodes
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
Get an entry node by its IntValue
- GetEntryByName(self, Symbolic) IEnumEntry¶
Parameters¶
Symbolic: Spinnaker::GenICam::gcstring const &
Get an entry node by name
- GetIntValue(self, Verify=False, IgnoreCache=False) int64_t¶
Parameters¶
Verify: bool IgnoreCache: bool
Get integer node value
- param Verify:
Enables Range verification (default = false). The AccessMode is always checked
- param IgnoreCache:
If true the value is read ignoring any caches (default = false)
The value read
- GetSymbolics(self, Symbolics)¶
Parameters¶
Symbolics: Spinnaker::GenApi::StringList_t &
Get list of symbolic Values
- class EventHandler(*args, **kwargs)¶
Bases:
objectThe base class for all event handler types.
- GetEventPayloadData(self) PyObject *¶
Gets the event payload data
The event payload data
- GetEventPayloadDataSize(self) size_t const¶
Gets the event payload data size
The event payload data size
- GetEventType(self) Spinnaker::EventType¶
Gets the event type
The event type
- class FloatNode(*args, **kwargs)¶
-
Interface for string properties.
- GetDisplayNotation(self) Spinnaker::GenApi::EDisplayNotation¶
Get the way the float should be converted to a string
- GetDisplayPrecision(self) int64_t¶
Get the precision to be used when converting the float to a string
- GetEnumAlias(self) IEnumeration¶
gets the interface of an alias node.
- GetInc(self) double¶
Get the constant increment if there is any
- GetIncMode(self) Spinnaker::GenApi::EIncMode¶
Get increment mode
- GetListOfValidValues(self, bounded=True) double_autovector_t¶
Parameters¶
bounded: bool
Get list of valid value
- GetMax(self) double¶
Get maximum value allowed
- GetMin(self) double¶
Get minimum value allowed
- GetRepresentation(self) Spinnaker::GenApi::ERepresentation¶
Get recommended representation
- GetValue(self, Verify=False, IgnoreCache=False) double¶
Parameters¶
Verify: bool IgnoreCache: bool
Get node value
- param Verify:
Enables Range verification (default = false). The AccessMode is always checked
- param IgnoreCache:
If true the value is read ignoring any caches (default = false)
The value read
- IsValueUpdated(self) bool¶
Checks if the content of the node has changed since the value was last cached by IsValueUpdated() or GetValue().
true if the node value has changed, false otherwise.
- class FloatRegNode(*args, **kwargs)¶
Bases:
FloatNode,RegisterNodeInterface for string properties.
- class H264Option¶
Bases:
objectOptions for saving H264 files.
- property bitrate¶
- property crf¶
- property frameRate¶
- property height¶
- property reserved¶
- property useMP4¶
- property width¶
- class IBase(*args, **kwargs)¶
Bases:
objectProxy of C++ Spinnaker::GenApi::IBase class.
- GetAccessMode(self) Spinnaker::GenApi::EAccessMode¶
- class ICameraBase(*args, **kwargs)¶
Bases:
objectThe interface file for base class for the camera object.
- BeginAcquisition(self)¶
- DeInit(self)¶
- DiscoverMaxPacketSize(self) unsigned int¶
- EndAcquisition(self)¶
- ForceIP(self)¶
- GetAccessMode(self) Spinnaker::GenApi::EAccessMode¶
- GetActiveNumDataStreams(self) unsigned int¶
- GetBufferOwnership(self) Spinnaker::BufferOwnership¶
- GetNextImage(self, grabTimeout=EVENT_TIMEOUT_INFINITE, streamIndex=0) ImagePtr¶
Parameters¶
grabTimeout: uint64_t streamIndex: uint64_t
- GetNextImageSync(self, grabTimeout=EVENT_TIMEOUT_INFINITE) ImageList¶
Parameters¶
grabTimeout: uint64_t
- GetNumDataStreams(self) unsigned int¶
- GetNumImagesInUse(self) unsigned int¶
- GetProducer(self) Spinnaker::ProducerPtr¶
- GetUserBufferCount(self) uint64_t¶
- GetUserBufferSize(self) uint64_t¶
- GetUserBufferTotalSize(self) uint64_t¶
- Init(self)¶
- RegisterEventHandler(self, evtHandlerToRegister)¶
Parameters¶
evtHandlerToRegister: Spinnaker::EventHandler &
RegisterEventHandler(self, evtHandlerToRegister, eventName)
Parameters¶
evtHandlerToRegister: Spinnaker::DeviceEventHandler & eventName: Spinnaker::GenICam::gcstring const &
RegisterEventHandler(self, evtHandlerToRegister, streamIndex)
Parameters¶
evtHandlerToRegister: Spinnaker::ImageEventHandler & streamIndex: uint64_t
- SetUserBuffers(self, pMemBuffers, totalSize)¶
Parameters¶
pMemBuffers: void *const totalSize: uint64_t
SetUserBuffers(self, ppMemBuffers, bufferCount, bufferSize)
Parameters¶
ppMemBuffers: void **const bufferCount: uint64_t const bufferSize: uint64_t const
- UnregisterAllLoggingEventHandlers(self)¶
- UnregisterEventHandler(self, evtHandlerToUnregister)¶
Parameters¶
evtHandlerToUnregister: Spinnaker::EventHandler &
- property TLDevice¶
- property TLStream¶
- class ICameraList(*args, **kwargs)¶
Bases:
objectUsed to hold a list of camera objects.
- Clear(self)¶
- GetSize(self) unsigned int¶
- class ICategory(*args, **kwargs)¶
Bases:
IValueProxy of C++ Spinnaker::GenApi::ICategory class.
- GetFeatures(self)¶
- class IChunkData(*args, **kwargs)¶
Bases:
objectThe Interface file for ChunkData.
- GetBlackLevel(self) float64_t¶
- GetCRC(self) int64_t¶
- GetCompressionMode(self) int64_t¶
- GetCompressionRatio(self) float64_t¶
- GetCounterValue(self) int64_t¶
- GetCurrentDatarate(self) int64_t¶
- GetEncoderValue(self) int64_t¶
- GetExposureEndLineStatusAll(self) int64_t¶
- GetExposureTime(self) float64_t¶
- GetFrameID(self) int64_t¶
- GetGain(self) float64_t¶
- GetHeight(self) int64_t¶
- GetImage(self) int64_t¶
- GetInferenceBoundingBoxResult(self) InferenceBoundingBoxResult¶
- GetInferenceConfidence(self) float64_t¶
- GetInferenceFrameId(self) int64_t¶
- GetInferenceResult(self) int64_t¶
- GetLargePenalty(self) int64_t¶
- GetLinePitch(self) int64_t¶
- GetLineStatusAll(self) int64_t¶
- GetMaxZ(self) float64_t¶
- GetMinZ(self) float64_t¶
- GetOffsetX(self) int64_t¶
- GetOffsetY(self) int64_t¶
- GetPartSelector(self) int64_t¶
- GetPixelDynamicRangeMax(self) int64_t¶
- GetPixelDynamicRangeMin(self) int64_t¶
- GetScan3dAxisMax(self) float64_t¶
- GetScan3dAxisMin(self) float64_t¶
- GetScan3dBaseline(self) float64_t¶
- GetScan3dCoordinateOffset(self) float64_t¶
- GetScan3dCoordinateReferenceValue(self) float64_t¶
- GetScan3dCoordinateScale(self) float64_t¶
- GetScan3dFocalLength(self) float64_t¶
- GetScan3dInvalidDataValue(self) float64_t¶
- GetScan3dPrincipalPointU(self) float64_t¶
- GetScan3dPrincipalPointV(self) float64_t¶
- GetScan3dTransformValue(self) float64_t¶
- GetScanLineSelector(self) int64_t¶
- GetSequencerSetActive(self) int64_t¶
- GetSerialData(self) uint8_t *¶
- GetSerialDataLength(self) int64_t¶
- GetSmallPenalty(self) int64_t¶
- GetStereoHeight(self) int64_t¶
- GetStereoWidth(self) int64_t¶
- GetStreamChannelID(self) int64_t¶
- GetTimerValue(self) float64_t¶
- GetTimestamp(self) int64_t¶
- GetTimestampLatchValue(self) int64_t¶
- GetTransferBlockID(self) int64_t¶
- GetTransferQueueCurrentBlockCount(self) int64_t¶
- GetUniquenessRatio(self) int64_t¶
- GetWidth(self) int64_t¶
- class IDestroy(*args, **kwargs)¶
Bases:
objectProxy of C++ Spinnaker::GenApi::IDestroy class.
- Destroy(self)¶
- class IDeviceArrivalEventHandler(*args, **kwargs)¶
Bases:
EventHandler
- class IDeviceEventHandler(*args, **kwargs)¶
Bases:
EventHandler- GetDeviceEventId(self) uint64_t¶
- class IDeviceInfo(*args, **kwargs)¶
Bases:
objectProxy of C++ Spinnaker::GenApi::IDeviceInfo class.
- class IDeviceRemovalEventHandler(*args, **kwargs)¶
Bases:
EventHandler
- class IEnumEntry(*args, **kwargs)¶
Bases:
IValueProxy of C++ Spinnaker::GenApi::IEnumEntry class.
- GetNumericValue(self) double¶
- GetValue(self) int64_t¶
- class IEnumReference(*args, **kwargs)¶
Bases:
objectProxy of C++ Spinnaker::GenApi::IEnumReference class.
- class IEnumeration(*args, **kwargs)¶
Bases:
IValueProxy of C++ Spinnaker::GenApi::IEnumeration class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntries(self)¶
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
- GetEntryByName(self, Symbolic) IEnumEntry¶
Parameters¶
Symbolic: Spinnaker::GenICam::gcstring const &
- class IEnumerationT_AcquisitionModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< AcquisitionModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::AcquisitionModeEnums const
- class IEnumerationT_AcquisitionStatusSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< AcquisitionStatusSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::AcquisitionStatusSelectorEnums const
- class IEnumerationT_ActionSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ActionSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ActionSelectorEnums const
- class IEnumerationT_ActionUnconditionalModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ActionUnconditionalModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ActionUnconditionalModeEnums const
- class IEnumerationT_AdcBitDepthEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< AdcBitDepthEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::AdcBitDepthEnums const
- class IEnumerationT_AutoAlgorithmSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< AutoAlgorithmSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::AutoAlgorithmSelectorEnums const
- class IEnumerationT_AutoExposureControlPriorityEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< AutoExposureControlPriorityEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::AutoExposureControlPriorityEnums const
- class IEnumerationT_AutoExposureLightingModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< AutoExposureLightingModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::AutoExposureLightingModeEnums const
- class IEnumerationT_AutoExposureMeteringModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< AutoExposureMeteringModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::AutoExposureMeteringModeEnums const
- class IEnumerationT_AutoExposureTargetGreyValueAutoEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< AutoExposureTargetGreyValueAutoEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::AutoExposureTargetGreyValueAutoEnums const
- class IEnumerationT_BalanceRatioSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< BalanceRatioSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::BalanceRatioSelectorEnums const
- class IEnumerationT_BalanceWhiteAutoEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< BalanceWhiteAutoEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::BalanceWhiteAutoEnums const
- class IEnumerationT_BalanceWhiteAutoProfileEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< BalanceWhiteAutoProfileEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::BalanceWhiteAutoProfileEnums const
- class IEnumerationT_BinningHorizontalModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< BinningHorizontalModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::BinningHorizontalModeEnums const
- class IEnumerationT_BinningSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< BinningSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::BinningSelectorEnums const
- class IEnumerationT_BinningVerticalModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< BinningVerticalModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::BinningVerticalModeEnums const
- class IEnumerationT_BlackLevelAutoBalanceEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< BlackLevelAutoBalanceEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::BlackLevelAutoBalanceEnums const
- class IEnumerationT_BlackLevelAutoEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< BlackLevelAutoEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::BlackLevelAutoEnums const
- class IEnumerationT_BlackLevelSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< BlackLevelSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::BlackLevelSelectorEnums const
- class IEnumerationT_BsiFlatFieldCorrectionAutoEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< BsiFlatFieldCorrectionAutoEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::BsiFlatFieldCorrectionAutoEnums const
- class IEnumerationT_BsiFlatFieldCorrectionGainSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< BsiFlatFieldCorrectionGainSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::BsiFlatFieldCorrectionGainSelectorEnums const
- class IEnumerationT_ChunkBlackLevelSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkBlackLevelSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkBlackLevelSelectorEnums const
- class IEnumerationT_ChunkCounterSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkCounterSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkCounterSelectorEnums const
- class IEnumerationT_ChunkEncoderSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkEncoderSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkEncoderSelectorEnums const
- class IEnumerationT_ChunkEncoderStatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkEncoderStatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkEncoderStatusEnums const
- class IEnumerationT_ChunkExposureTimeSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkExposureTimeSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkExposureTimeSelectorEnums const
- class IEnumerationT_ChunkGainSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkGainSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkGainSelectorEnums const
- class IEnumerationT_ChunkImageComponentEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkImageComponentEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkImageComponentEnums const
- class IEnumerationT_ChunkPixelFormatEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkPixelFormatEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkPixelFormatEnums const
- class IEnumerationT_ChunkRegionIDEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkRegionIDEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkRegionIDEnums const
- class IEnumerationT_ChunkScan3dCoordinateReferenceSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkScan3dCoordinateReferenceSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkScan3dCoordinateReferenceSelectorEnums const
- class IEnumerationT_ChunkScan3dCoordinateSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkScan3dCoordinateSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkScan3dCoordinateSelectorEnums const
- class IEnumerationT_ChunkScan3dCoordinateSystemEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkScan3dCoordinateSystemEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkScan3dCoordinateSystemEnums const
- class IEnumerationT_ChunkScan3dCoordinateSystemReferenceEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkScan3dCoordinateSystemReferenceEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkScan3dCoordinateSystemReferenceEnums const
- class IEnumerationT_ChunkScan3dCoordinateTransformSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkScan3dCoordinateTransformSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkScan3dCoordinateTransformSelectorEnums const
- class IEnumerationT_ChunkScan3dDistanceUnitEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkScan3dDistanceUnitEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkScan3dDistanceUnitEnums const
- class IEnumerationT_ChunkScan3dOutputModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkScan3dOutputModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkScan3dOutputModeEnums const
- class IEnumerationT_ChunkSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkSelectorEnums const
- class IEnumerationT_ChunkSourceIDEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkSourceIDEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkSourceIDEnums const
- class IEnumerationT_ChunkTimerSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkTimerSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkTimerSelectorEnums const
- class IEnumerationT_ChunkTransferStreamIDEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ChunkTransferStreamIDEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ChunkTransferStreamIDEnums const
- class IEnumerationT_ClConfigurationEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ClConfigurationEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ClConfigurationEnums const
- class IEnumerationT_ClTimeSlotsCountEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ClTimeSlotsCountEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ClTimeSlotsCountEnums const
- class IEnumerationT_ColorTransformationSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ColorTransformationSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ColorTransformationSelectorEnums const
- class IEnumerationT_ColorTransformationValueSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ColorTransformationValueSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ColorTransformationValueSelectorEnums const
- class IEnumerationT_ComponentDestinationEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ComponentDestinationEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ComponentDestinationEnums const
- class IEnumerationT_ComponentSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ComponentSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ComponentSelectorEnums const
- class IEnumerationT_CompressionSaturationPriorityEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< CompressionSaturationPriorityEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::CompressionSaturationPriorityEnums const
- class IEnumerationT_ConnectionConfigDefaultEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ConnectionConfigDefaultEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ConnectionConfigDefaultEnums const
- class IEnumerationT_ConnectionConfigEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ConnectionConfigEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ConnectionConfigEnums const
- class IEnumerationT_CounterEventActivationEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< CounterEventActivationEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::CounterEventActivationEnums const
- class IEnumerationT_CounterEventSourceEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< CounterEventSourceEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::CounterEventSourceEnums const
- class IEnumerationT_CounterResetActivationEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< CounterResetActivationEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::CounterResetActivationEnums const
- class IEnumerationT_CounterResetSourceEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< CounterResetSourceEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::CounterResetSourceEnums const
- class IEnumerationT_CounterSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< CounterSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::CounterSelectorEnums const
- class IEnumerationT_CounterStatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< CounterStatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::CounterStatusEnums const
- class IEnumerationT_CounterTriggerActivationEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< CounterTriggerActivationEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::CounterTriggerActivationEnums const
- class IEnumerationT_CounterTriggerSourceEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< CounterTriggerSourceEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::CounterTriggerSourceEnums const
- class IEnumerationT_CpuAffinityPrivilegeEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< CpuAffinityPrivilegeEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::CpuAffinityPrivilegeEnum const
- class IEnumerationT_CpuAffinityServiceStatusEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< CpuAffinityServiceStatusEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::CpuAffinityServiceStatusEnum const
- class IEnumerationT_CxpConnectionTestModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< CxpConnectionTestModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::CxpConnectionTestModeEnums const
- class IEnumerationT_CxpLinkConfigurationEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< CxpLinkConfigurationEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::CxpLinkConfigurationEnums const
- class IEnumerationT_CxpLinkConfigurationPreferredEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< CxpLinkConfigurationPreferredEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::CxpLinkConfigurationPreferredEnums const
- class IEnumerationT_CxpLinkConfigurationStatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< CxpLinkConfigurationStatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::CxpLinkConfigurationStatusEnums const
- class IEnumerationT_CxpPoCxpStatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< CxpPoCxpStatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::CxpPoCxpStatusEnums const
- class IEnumerationT_DecimationHorizontalModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DecimationHorizontalModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DecimationHorizontalModeEnums const
- class IEnumerationT_DecimationSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DecimationSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DecimationSelectorEnums const
- class IEnumerationT_DecimationVerticalModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DecimationVerticalModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DecimationVerticalModeEnums const
- class IEnumerationT_DefectCorrectionModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DefectCorrectionModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DefectCorrectionModeEnums const
- class IEnumerationT_DefectPixelStatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DefectPixelStatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DefectPixelStatusEnums const
- class IEnumerationT_DefectPixelTestModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DefectPixelTestModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DefectPixelTestModeEnums const
- class IEnumerationT_DeinterlacingEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeinterlacingEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeinterlacingEnums const
- class IEnumerationT_DeviceAccessStatusEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceAccessStatusEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceAccessStatusEnum const
- class IEnumerationT_DeviceCharacterSetEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceCharacterSetEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceCharacterSetEnums const
- class IEnumerationT_DeviceClockSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceClockSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceClockSelectorEnums const
- class IEnumerationT_DeviceConnectionStatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceConnectionStatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceConnectionStatusEnums const
- class IEnumerationT_DeviceCurrentSpeedEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceCurrentSpeedEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceCurrentSpeedEnum const
- class IEnumerationT_DeviceDataRW_SelectEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceDataRW_SelectEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceDataRW_SelectEnums const
- class IEnumerationT_DeviceDataStatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceDataStatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceDataStatusEnums const
- class IEnumerationT_DeviceEndianessMechanismEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceEndianessMechanismEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceEndianessMechanismEnum const
- class IEnumerationT_DeviceIndicatorModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceIndicatorModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceIndicatorModeEnums const
- class IEnumerationT_DeviceLinkHeartbeatModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceLinkHeartbeatModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceLinkHeartbeatModeEnums const
- class IEnumerationT_DeviceLinkThroughputLimitModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceLinkThroughputLimitModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceLinkThroughputLimitModeEnums const
- class IEnumerationT_DevicePowerSupplySelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DevicePowerSupplySelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DevicePowerSupplySelectorEnums const
- class IEnumerationT_DeviceRegistersEndiannessEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceRegistersEndiannessEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceRegistersEndiannessEnums const
- class IEnumerationT_DeviceScanTypeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceScanTypeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceScanTypeEnums const
- class IEnumerationT_DeviceSensorChromaEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceSensorChromaEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceSensorChromaEnums const
- class IEnumerationT_DeviceSerialPortBaudRateEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceSerialPortBaudRateEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceSerialPortBaudRateEnums const
- class IEnumerationT_DeviceSerialPortSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceSerialPortSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceSerialPortSelectorEnums const
- class IEnumerationT_DeviceStreamChannelEndiannessEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceStreamChannelEndiannessEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceStreamChannelEndiannessEnums const
- class IEnumerationT_DeviceStreamChannelTypeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceStreamChannelTypeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceStreamChannelTypeEnums const
- class IEnumerationT_DeviceTLTypeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceTLTypeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceTLTypeEnums const
- class IEnumerationT_DeviceTapGeometryEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceTapGeometryEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceTapGeometryEnums const
- class IEnumerationT_DeviceTemperatureSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceTemperatureSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceTemperatureSelectorEnums const
- class IEnumerationT_DeviceTypeEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceTypeEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceTypeEnum const
- class IEnumerationT_DeviceTypeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< DeviceTypeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::DeviceTypeEnums const
- class IEnumerationT_ElectricalCompliancyTestEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ElectricalCompliancyTestEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ElectricalCompliancyTestEnums const
- class IEnumerationT_EncoderModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< EncoderModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::EncoderModeEnums const
- class IEnumerationT_EncoderOutputModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< EncoderOutputModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::EncoderOutputModeEnums const
- class IEnumerationT_EncoderResetActivationEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< EncoderResetActivationEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::EncoderResetActivationEnums const
- class IEnumerationT_EncoderResetSourceEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< EncoderResetSourceEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::EncoderResetSourceEnums const
- class IEnumerationT_EncoderSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< EncoderSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::EncoderSelectorEnums const
- class IEnumerationT_EncoderSourceAEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< EncoderSourceAEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::EncoderSourceAEnums const
- class IEnumerationT_EncoderSourceBEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< EncoderSourceBEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::EncoderSourceBEnums const
- class IEnumerationT_EncoderStatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< EncoderStatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::EncoderStatusEnums const
- class IEnumerationT_EventNotificationEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< EventNotificationEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::EventNotificationEnums const
- class IEnumerationT_EventSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< EventSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::EventSelectorEnums const
- class IEnumerationT_ExposureActiveModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ExposureActiveModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ExposureActiveModeEnums const
- class IEnumerationT_ExposureAutoEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ExposureAutoEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ExposureAutoEnums const
- class IEnumerationT_ExposureModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ExposureModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ExposureModeEnums const
- class IEnumerationT_ExposureTimeModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ExposureTimeModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ExposureTimeModeEnums const
- class IEnumerationT_ExposureTimeSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ExposureTimeSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ExposureTimeSelectorEnums const
- class IEnumerationT_ExternalVoltageSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ExternalVoltageSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ExternalVoltageSelectorEnums const
- class IEnumerationT_FLIRFilterDriverStatusEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< FLIRFilterDriverStatusEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::FLIRFilterDriverStatusEnum const
- class IEnumerationT_FanTypeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< FanTypeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::FanTypeEnums const
- class IEnumerationT_FfcModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< FfcModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::FfcModeEnums const
- class IEnumerationT_FileOpenModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< FileOpenModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::FileOpenModeEnums const
- class IEnumerationT_FileOperationSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< FileOperationSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::FileOperationSelectorEnums const
- class IEnumerationT_FileOperationStatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< FileOperationStatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::FileOperationStatusEnums const
- class IEnumerationT_FileSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< FileSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::FileSelectorEnums const
- class IEnumerationT_FlashStrobeActiveStateEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< FlashStrobeActiveStateEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::FlashStrobeActiveStateEnums const
- class IEnumerationT_FlashStrobeModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< FlashStrobeModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::FlashStrobeModeEnums const
- class IEnumerationT_GUIXMLLocationEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GUIXMLLocationEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GUIXMLLocationEnum const
- class IEnumerationT_GainAutoBalanceEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GainAutoBalanceEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GainAutoBalanceEnums const
- class IEnumerationT_GainAutoEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GainAutoEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GainAutoEnums const
- class IEnumerationT_GainConversionEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GainConversionEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GainConversionEnums const
- class IEnumerationT_GainModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GainModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GainModeEnums const
- class IEnumerationT_GainSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GainSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GainSelectorEnums const
- class IEnumerationT_GenICamXMLLocationEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GenICamXMLLocationEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GenICamXMLLocationEnum const
- class IEnumerationT_GevCCPEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GevCCPEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GevCCPEnum const
- class IEnumerationT_GevCCPEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GevCCPEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GevCCPEnums const
- class IEnumerationT_GevCurrentPhysicalLinkConfigurationEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GevCurrentPhysicalLinkConfigurationEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GevCurrentPhysicalLinkConfigurationEnums const
- class IEnumerationT_GevGVCPExtendedStatusCodesSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GevGVCPExtendedStatusCodesSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GevGVCPExtendedStatusCodesSelectorEnums const
- class IEnumerationT_GevGVSPExtendedIDModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GevGVSPExtendedIDModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GevGVSPExtendedIDModeEnums const
- class IEnumerationT_GevIEEE1588ClockAccuracyEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GevIEEE1588ClockAccuracyEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GevIEEE1588ClockAccuracyEnums const
- class IEnumerationT_GevIEEE1588ModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GevIEEE1588ModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GevIEEE1588ModeEnums const
- class IEnumerationT_GevIEEE1588StatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GevIEEE1588StatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GevIEEE1588StatusEnums const
- class IEnumerationT_GevIEEE1588StatusLatchedEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GevIEEE1588StatusLatchedEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GevIEEE1588StatusLatchedEnums const
- class IEnumerationT_GevIPConfigurationStatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GevIPConfigurationStatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GevIPConfigurationStatusEnums const
- class IEnumerationT_GevPhysicalLinkConfigurationEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GevPhysicalLinkConfigurationEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GevPhysicalLinkConfigurationEnums const
- class IEnumerationT_GevSCPDirectionEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GevSCPDirectionEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GevSCPDirectionEnums const
- class IEnumerationT_GevSupportedOptionSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< GevSupportedOptionSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::GevSupportedOptionSelectorEnums const
- class IEnumerationT_ImageComponentSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ImageComponentSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ImageComponentSelectorEnums const
- class IEnumerationT_ImageCompressionJPEGFormatOptionEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ImageCompressionJPEGFormatOptionEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ImageCompressionJPEGFormatOptionEnums const
- class IEnumerationT_ImageCompressionModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ImageCompressionModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ImageCompressionModeEnums const
- class IEnumerationT_ImageCompressionRateOptionEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< ImageCompressionRateOptionEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::ImageCompressionRateOptionEnums const
- class IEnumerationT_InterfaceTypeEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< InterfaceTypeEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::InterfaceTypeEnum const
- class IEnumerationT_LF_FF_CalibrationROIEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LF_FF_CalibrationROIEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LF_FF_CalibrationROIEnums const
- class IEnumerationT_LF_FF_CalibrationStatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LF_FF_CalibrationStatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LF_FF_CalibrationStatusEnums const
- class IEnumerationT_LF_FF_RawSetDataStatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LF_FF_RawSetDataStatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LF_FF_RawSetDataStatusEnums const
- class IEnumerationT_LF_FF_ReferencePointEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LF_FF_ReferencePointEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LF_FF_ReferencePointEnums const
- class IEnumerationT_LF_FF_SequenceStatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LF_FF_SequenceStatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LF_FF_SequenceStatusEnums const
- class IEnumerationT_LF_FF_SetSelectionModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LF_FF_SetSelectionModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LF_FF_SetSelectionModeEnums const
- class IEnumerationT_LUTSelectionEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LUTSelectionEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LUTSelectionEnums const
- class IEnumerationT_LUTSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LUTSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LUTSelectorEnums const
- class IEnumerationT_LUTStatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LUTStatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LUTStatusEnums const
- class IEnumerationT_LensShadingCoefficientActiveSetEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LensShadingCoefficientActiveSetEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LensShadingCoefficientActiveSetEnums const
- class IEnumerationT_LensShadingCorrectionModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LensShadingCorrectionModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LensShadingCorrectionModeEnums const
- class IEnumerationT_LineFormatEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LineFormatEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LineFormatEnums const
- class IEnumerationT_LineInputFilterSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LineInputFilterSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LineInputFilterSelectorEnums const
- class IEnumerationT_LineModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LineModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LineModeEnums const
- class IEnumerationT_LineSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LineSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LineSelectorEnums const
- class IEnumerationT_LineSourceEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LineSourceEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LineSourceEnums const
- class IEnumerationT_LogicBlockLUTInputActivationEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LogicBlockLUTInputActivationEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LogicBlockLUTInputActivationEnums const
- class IEnumerationT_LogicBlockLUTInputSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LogicBlockLUTInputSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LogicBlockLUTInputSelectorEnums const
- class IEnumerationT_LogicBlockLUTInputSourceEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LogicBlockLUTInputSourceEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LogicBlockLUTInputSourceEnums const
- class IEnumerationT_LogicBlockLUTSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LogicBlockLUTSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LogicBlockLUTSelectorEnums const
- class IEnumerationT_LogicBlockSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< LogicBlockSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::LogicBlockSelectorEnums const
- class IEnumerationT_MediaOptimizationPrivilegeEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< MediaOptimizationPrivilegeEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::MediaOptimizationPrivilegeEnum const
- class IEnumerationT_MultiRoiConfigurationInvalidReasonEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< MultiRoiConfigurationInvalidReasonEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::MultiRoiConfigurationInvalidReasonEnums const
- class IEnumerationT_MultiRoiSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< MultiRoiSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::MultiRoiSelectorEnums const
- class IEnumerationT_POEStatusEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< POEStatusEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::POEStatusEnum const
- class IEnumerationT_PixelColorFilterEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< PixelColorFilterEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::PixelColorFilterEnums const
- class IEnumerationT_PixelFormatEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< PixelFormatEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::PixelFormatEnums const
- class IEnumerationT_PixelFormatInfoSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< PixelFormatInfoSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::PixelFormatInfoSelectorEnums const
- class IEnumerationT_PixelSizeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< PixelSizeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::PixelSizeEnums const
- class IEnumerationT_RegionDestinationEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< RegionDestinationEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::RegionDestinationEnums const
- class IEnumerationT_RegionModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< RegionModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::RegionModeEnums const
- class IEnumerationT_RegionSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< RegionSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::RegionSelectorEnums const
- class IEnumerationT_RgbTransformLightSourceEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< RgbTransformLightSourceEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::RgbTransformLightSourceEnums const
- class IEnumerationT_Scan3dCoordinateReferenceSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< Scan3dCoordinateReferenceSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::Scan3dCoordinateReferenceSelectorEnums const
- class IEnumerationT_Scan3dCoordinateSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< Scan3dCoordinateSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::Scan3dCoordinateSelectorEnums const
- class IEnumerationT_Scan3dCoordinateSystemEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< Scan3dCoordinateSystemEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::Scan3dCoordinateSystemEnums const
- class IEnumerationT_Scan3dCoordinateSystemReferenceEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< Scan3dCoordinateSystemReferenceEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::Scan3dCoordinateSystemReferenceEnums const
- class IEnumerationT_Scan3dCoordinateTransformSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< Scan3dCoordinateTransformSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::Scan3dCoordinateTransformSelectorEnums const
- class IEnumerationT_Scan3dDistanceUnitEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< Scan3dDistanceUnitEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::Scan3dDistanceUnitEnums const
- class IEnumerationT_Scan3dOutputModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< Scan3dOutputModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::Scan3dOutputModeEnums const
- class IEnumerationT_SensorBitDepthEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SensorBitDepthEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SensorBitDepthEnums const
- class IEnumerationT_SensorDigitizationTapsEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SensorDigitizationTapsEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SensorDigitizationTapsEnums const
- class IEnumerationT_SensorRegisterReadWriteModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SensorRegisterReadWriteModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SensorRegisterReadWriteModeEnums const
- class IEnumerationT_SensorShutterModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SensorShutterModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SensorShutterModeEnums const
- class IEnumerationT_SensorTapsEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SensorTapsEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SensorTapsEnums const
- class IEnumerationT_SequencerConfigurationModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SequencerConfigurationModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SequencerConfigurationModeEnums const
- class IEnumerationT_SequencerConfigurationValidEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SequencerConfigurationValidEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SequencerConfigurationValidEnums const
- class IEnumerationT_SequencerModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SequencerModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SequencerModeEnums const
- class IEnumerationT_SequencerSetValidEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SequencerSetValidEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SequencerSetValidEnums const
- class IEnumerationT_SequencerTriggerActivationEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SequencerTriggerActivationEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SequencerTriggerActivationEnums const
- class IEnumerationT_SequencerTriggerSourceEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SequencerTriggerSourceEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SequencerTriggerSourceEnums const
- class IEnumerationT_SerialPortBaudRateEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SerialPortBaudRateEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SerialPortBaudRateEnums const
- class IEnumerationT_SerialPortParityEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SerialPortParityEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SerialPortParityEnums const
- class IEnumerationT_SerialPortSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SerialPortSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SerialPortSelectorEnums const
- class IEnumerationT_SerialPortSourceEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SerialPortSourceEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SerialPortSourceEnums const
- class IEnumerationT_SerialPortStopBitsEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SerialPortStopBitsEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SerialPortStopBitsEnums const
- class IEnumerationT_SoftwareSignalSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SoftwareSignalSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SoftwareSignalSelectorEnums const
- class IEnumerationT_SoftwareUpdateStatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SoftwareUpdateStatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SoftwareUpdateStatusEnums const
- class IEnumerationT_SourceSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< SourceSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::SourceSelectorEnums const
- class IEnumerationT_StereoResolutionEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< StereoResolutionEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::StereoResolutionEnums const
- class IEnumerationT_StreamBufferCountModeEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< StreamBufferCountModeEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::StreamBufferCountModeEnum const
- class IEnumerationT_StreamBufferHandlingModeEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< StreamBufferHandlingModeEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::StreamBufferHandlingModeEnum const
- class IEnumerationT_StreamModeEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< StreamModeEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::StreamModeEnum const
- class IEnumerationT_StreamTypeEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< StreamTypeEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::StreamTypeEnum const
- class IEnumerationT_TLTypeEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TLTypeEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TLTypeEnum const
- class IEnumerationT_TeledyneGigeVisionFilterDriverStatusEnum(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TeledyneGigeVisionFilterDriverStatusEnum > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TeledyneGigeVisionFilterDriverStatusEnum const
- class IEnumerationT_TestImageSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TestImageSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TestImageSelectorEnums const
- class IEnumerationT_TestModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TestModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TestModeEnums const
- class IEnumerationT_TestPatternEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TestPatternEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TestPatternEnums const
- class IEnumerationT_TestPatternGeneratorSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TestPatternGeneratorSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TestPatternGeneratorSelectorEnums const
- class IEnumerationT_TimerSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TimerSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TimerSelectorEnums const
- class IEnumerationT_TimerStatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TimerStatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TimerStatusEnums const
- class IEnumerationT_TimerTriggerActivationEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TimerTriggerActivationEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TimerTriggerActivationEnums const
- class IEnumerationT_TimerTriggerSourceEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TimerTriggerSourceEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TimerTriggerSourceEnums const
- class IEnumerationT_TransferComponentSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TransferComponentSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TransferComponentSelectorEnums const
- class IEnumerationT_TransferControlModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TransferControlModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TransferControlModeEnums const
- class IEnumerationT_TransferOperationModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TransferOperationModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TransferOperationModeEnums const
- class IEnumerationT_TransferQueueModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TransferQueueModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TransferQueueModeEnums const
- class IEnumerationT_TransferSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TransferSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TransferSelectorEnums const
- class IEnumerationT_TransferStatusSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TransferStatusSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TransferStatusSelectorEnums const
- class IEnumerationT_TransferTriggerActivationEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TransferTriggerActivationEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TransferTriggerActivationEnums const
- class IEnumerationT_TransferTriggerModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TransferTriggerModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TransferTriggerModeEnums const
- class IEnumerationT_TransferTriggerSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TransferTriggerSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TransferTriggerSelectorEnums const
- class IEnumerationT_TransferTriggerSourceEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TransferTriggerSourceEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TransferTriggerSourceEnums const
- class IEnumerationT_TriggerActivationEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TriggerActivationEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TriggerActivationEnums const
- class IEnumerationT_TriggerModeEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TriggerModeEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TriggerModeEnums const
- class IEnumerationT_TriggerOverlapEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TriggerOverlapEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TriggerOverlapEnums const
- class IEnumerationT_TriggerSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TriggerSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TriggerSelectorEnums const
- class IEnumerationT_TriggerSourceEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< TriggerSourceEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::TriggerSourceEnums const
- class IEnumerationT_U3VCurrentSpeedEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< U3VCurrentSpeedEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::U3VCurrentSpeedEnums const
- class IEnumerationT_UserOutputSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< UserOutputSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::UserOutputSelectorEnums const
- class IEnumerationT_UserSetDefaultEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< UserSetDefaultEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::UserSetDefaultEnums const
- class IEnumerationT_UserSetSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< UserSetSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::UserSetSelectorEnums const
- class IEnumerationT_WhiteBalanceStatusEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< WhiteBalanceStatusEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::WhiteBalanceStatusEnums const
- class IEnumerationT_WhiteClipSelectorEnums(*args, **kwargs)¶
Bases:
IEnumeration,IEnumReferenceProxy of C++ Spinnaker::GenApi::IEnumerationT< WhiteClipSelectorEnums > class.
- GetCurrentEntry(self, Verify=False, IgnoreCache=False) IEnumEntry¶
Parameters¶
Verify: bool IgnoreCache: bool
- GetEntry(self, IntValue) IEnumEntry¶
Parameters¶
IntValue: int64_t const
GetEntry(self, Value) -> IEnumEntry
Parameters¶
Value: enum Spinnaker::WhiteClipSelectorEnums const
- class IFloat(*args, **kwargs)¶
Bases:
IValueProxy of C++ Spinnaker::GenApi::IFloat class.
- GetDisplayNotation(self) Spinnaker::GenApi::EDisplayNotation¶
- GetDisplayPrecision(self) int64_t¶
- GetInc(self) double¶
- GetIncMode(self) Spinnaker::GenApi::EIncMode¶
- GetListOfValidValues(self, bounded=True) double_autovector_t¶
Parameters¶
bounded: bool
- GetMax(self) double¶
- GetMin(self) double¶
- GetRepresentation(self) Spinnaker::GenApi::ERepresentation¶
- class IImage(*args, **kwargs)¶
Bases:
objectThe interface file for Image.
- CalculateChannelStatistics(self, channel) ChannelStatistics¶
Parameters¶
channel: enum Spinnaker::StatisticsChannel
- GetBitsPerPixel(self) size_t¶
- GetBufferSize(self) size_t¶
- GetChunkLayoutId(self) uint64_t¶
- GetColorProcessing(self) Spinnaker::ColorProcessingAlgorithm¶
- GetData(self)¶
- GetData(self) PyObject *
- GetFrameID(self) uint64_t¶
- GetHeight(self) size_t¶
- GetID(self) uint64_t¶
- GetImagePayloadType(self) Spinnaker::ImagePayloadType¶
- GetImageSize(self) size_t¶
- GetImageStatus(self) Spinnaker::ImageStatus¶
- GetNDArray(self) PyObject *¶
- GetNumChannels(self) size_t¶
- GetPayloadType(self) size_t¶
- GetPixelFormat(self) Spinnaker::PixelFormatEnums¶
- GetPixelFormatIntType(self) Spinnaker::PixelFormatIntType¶
- GetPrivateData(self) void *¶
- GetStreamIndex(self) uint64_t¶
- GetStride(self) size_t¶
- GetTLPayloadType(self) Spinnaker::TLPayloadType¶
- GetTLPixelFormat(self) uint64_t¶
- GetTLPixelFormatNamespace(self) Spinnaker::TLPixelFormatNamespace¶
- GetTimeStamp(self) uint64_t¶
- GetValidPayloadSize(self) size_t¶
- GetWidth(self) size_t¶
- GetXOffset(self) size_t¶
- GetXPadding(self) size_t¶
- GetYOffset(self) size_t¶
- GetYPadding(self) size_t¶
- Release(self)¶
- ResetImage(self, width, height, offsetX, offsetY, pixelFormat)¶
Parameters¶
width: size_t height: size_t offsetX: size_t offsetY: size_t pixelFormat: enum Spinnaker::PixelFormatEnums
ResetImage(self, width, height, offsetX, offsetY, pixelFormat, pData)
Parameters¶
width: size_t height: size_t offsetX: size_t offsetY: size_t pixelFormat: enum Spinnaker::PixelFormatEnums pData: void *
ResetImage(self, width, height, offsetX, offsetY, pixelFormat, pData, dataPayloadType, dataSize)
Parameters¶
width: size_t height: size_t offsetX: size_t offsetY: size_t pixelFormat: enum Spinnaker::PixelFormatEnums pData: void * dataPayloadType: enum Spinnaker::TLPayloadType dataSize: size_t
- Save(self, pFilename, format=SPINNAKER_IMAGE_FILE_FORMAT_FROM_FILE_EXT)¶
Parameters¶
pFilename: char const * format: enum Spinnaker::ImageFileFormat
Save(self, pFilename, pOption)
Parameters¶
pFilename: char const * pOption: Spinnaker::PNGOption &
Save(self, pFilename, pOption)
Parameters¶
pFilename: char const * pOption: Spinnaker::PPMOption &
Save(self, pFilename, pOption)
Parameters¶
pFilename: char const * pOption: Spinnaker::PGMOption &
Save(self, pFilename, pOption)
Parameters¶
pFilename: char const * pOption: Spinnaker::TIFFOption &
Save(self, pFilename, pOption)
Parameters¶
pFilename: char const * pOption: Spinnaker::JPEGOption &
Save(self, pFilename, pOption)
Parameters¶
pFilename: char const * pOption: Spinnaker::JPG2Option &
Save(self, pFilename, pOption)
Parameters¶
pFilename: char const * pOption: Spinnaker::BMPOption &
Save(self, pFilename, pOption)
Parameters¶
pFilename: char const * pOption: Spinnaker::GenDCOption &
Save(self, pFilename, option)
Parameters¶
pFilename: char const * option: Spinnaker::SIOption &
- class IImageEventHandler(*args, **kwargs)¶
Bases:
EventHandler
- class IImageList(*args, **kwargs)¶
Bases:
objectThe interface file for ImageList class.
- Clear(self)¶
- GetByPayloadType(self, payloadType) ImagePtr¶
Parameters¶
payloadType: enum Spinnaker::ImagePayloadType const
- GetByPixelFormat(self, pixelFormat) ImagePtr¶
Parameters¶
pixelFormat: enum Spinnaker::PixelFormatEnums
- GetImagesByPayloadType(self, payloadType) ImageList¶
Parameters¶
payloadType: enum Spinnaker::ImagePayloadType const
- GetImagesByPixelFormat(self, pixelFormat) ImageList¶
Parameters¶
pixelFormat: enum Spinnaker::PixelFormatEnums
- GetSize(self) unsigned int¶
- Release(self)¶
- class IImageListEventHandler(*args, **kwargs)¶
Bases:
EventHandler
- class IImageProcessor(*args, **kwargs)¶
Bases:
objectThe interface file for ImageProcessor class.
- ApplyGamma(self, srcImage, gamma, isGammaInverse=False) ImagePtr¶
Parameters¶
srcImage: Spinnaker::ImagePtr const & gamma: float isGammaInverse: bool
ApplyGamma(self, srcImage, destImage, gamma, isGammaInverse=False)
Parameters¶
srcImage: Spinnaker::ImagePtr const & destImage: Spinnaker::ImagePtr & gamma: float isGammaInverse: bool
- Convert(self, srcImage, destFormat) ImagePtr¶
Parameters¶
srcImage: Spinnaker::ImagePtr const & destFormat: enum Spinnaker::PixelFormatEnums
Convert(self, srcImage, destImage, destFormat)
Parameters¶
srcImage: Spinnaker::ImagePtr const & destImage: Spinnaker::ImagePtr & destFormat: enum Spinnaker::PixelFormatEnums
Convert(self, srcImageList, destFormat) -> ImagePtr
Parameters¶
srcImageList: Spinnaker::ImageList const & destFormat: enum Spinnaker::PixelFormatEnums
Convert(self, srcImageList, destImage, destFormat)
Parameters¶
srcImageList: Spinnaker::ImageList const & destImage: Spinnaker::ImagePtr & destFormat: enum Spinnaker::PixelFormatEnums
- GetColorProcessing(self) Spinnaker::ColorProcessingAlgorithm¶
- GetNumDecompressionThreads(self) unsigned int¶
- class IInteger(*args, **kwargs)¶
Bases:
IValueProxy of C++ Spinnaker::GenApi::IInteger class.
- GetInc(self) int64_t¶
- GetIncMode(self) Spinnaker::GenApi::EIncMode¶
- GetListOfValidValues(self, bounded=True) int64_autovector_t¶
Parameters¶
bounded: bool
- GetMax(self) int64_t¶
- GetMin(self) int64_t¶
- GetRepresentation(self) Spinnaker::GenApi::ERepresentation¶
- class IInterface(*args, **kwargs)¶
Bases:
objectThe interface file for Interface.
- GetCameras(self, updateCameras=True) CameraList¶
Parameters¶
updateCameras: bool
- GetProducer(self) Spinnaker::ProducerPtr¶
- RegisterEventHandler(self, evtHandlerToRegister)¶
Parameters¶
evtHandlerToRegister: Spinnaker::EventHandler &
- SendActionCommand(self, deviceKey, groupKey, groupMask, actionTime=0, requestAck=False, pResultSize=None, results=0)¶
Parameters¶
deviceKey: unsigned int groupKey: unsigned int groupMask: unsigned int actionTime: unsigned long long requestAck: bool pResultSize: unsigned int * results: Spinnaker::ActionCommandResult []
- UnregisterAllLoggingEventHandlers(self)¶
- UnregisterEventHandler(self, evtHandlerToUnregister)¶
Parameters¶
evtHandlerToUnregister: Spinnaker::EventHandler &
- property TLInterface¶
- class IInterfaceArrivalEventHandler(*args, **kwargs)¶
Bases:
EventHandler
- class IInterfaceEventHandler(*args, **kwargs)¶
Bases:
IDeviceArrivalEventHandler,IDeviceRemovalEventHandler
- class IInterfaceList(*args, **kwargs)¶
Bases:
objectThe interface file for InterfaceList class.
- Clear(self)¶
- GetByIndex(self, index) InterfacePtr¶
Parameters¶
index: unsigned int
- GetSize(self) unsigned int¶
- class IInterfaceRemovalEventHandler(*args, **kwargs)¶
Bases:
EventHandler
- class ILoggingEventHandler(*args, **kwargs)¶
Bases:
EventHandler
- class INode(*args, **kwargs)¶
Bases:
ISelector,IReferenceProxy of C++ Spinnaker::GenApi::INode class.
- DeregisterCallback(self, hCallback) bool¶
Parameters¶
hCallback: Spinnaker::GenApi::CallbackHandleType
- GetCachingMode(self) Spinnaker::GenApi::ECachingMode¶
- GetChildren(self, LinkType=ctReadingChildren)¶
Parameters¶
LinkType: enum Spinnaker::GenApi::ELinkType
- GetLockNodes(self)¶
- GetNameSpace(self) Spinnaker::GenApi::ENameSpace¶
- GetParents(self)¶
- GetPollingTime(self) int64_t¶
- GetPrincipalInterfaceType(self) Spinnaker::GenApi::EInterfaceType¶
- GetProperty(self, PropertyName, ValueStr, AttributeStr) bool¶
Parameters¶
PropertyName: Spinnaker::GenICam::gcstring const & ValueStr: Spinnaker::GenICam::gcstring & AttributeStr: Spinnaker::GenICam::gcstring &
- GetPropertyNames(self)¶
- GetVisibility(self) Spinnaker::GenApi::EVisibility¶
- ImposeAccessMode(self, ImposedAccessMode)¶
Parameters¶
ImposedAccessMode: enum Spinnaker::GenApi::EAccessMode
- ImposeVisibility(self, ImposedVisibility)¶
Parameters¶
ImposedVisibility: enum Spinnaker::GenApi::EVisibility
- InvalidateNode(self)¶
- IsAccessModeCacheable(self) Spinnaker::GenApi::EYesNo¶
- class INodeMap(*args, **kwargs)¶
Bases:
objectProxy of C++ Spinnaker::GenApi::INodeMap class.
- Connect(self, pPort, PortName) bool¶
Parameters¶
pPort: IPort * PortName: Spinnaker::GenICam::gcstring const &
Connect(self, pPort) -> bool
Parameters¶
pPort: IPort *
- DisableAutoPoll(self)¶
- GetNodes(self)¶
- GetNumNodes(self) uint64_t¶
- InvalidateNodes(self)¶
- class INodeMapDyn(*args, **kwargs)¶
Bases:
INodeMapProxy of C++ Spinnaker::GenApi::INodeMapDyn class.
- ClearAllNodes(self)¶
- ExtractIndependentSubtree(self, XMLData, InjectXMLData, SubTreeRootNodeName, ExtractedSubtree)¶
Parameters¶
XMLData: Spinnaker::GenICam::gcstring const & InjectXMLData: Spinnaker::GenICam::gcstring const & SubTreeRootNodeName: Spinnaker::GenICam::gcstring const & ExtractedSubtree: Spinnaker::GenICam::gcstring &
- GetSupportedSchemaVersions(self)¶
- LoadXMLFromFileInject(self, TargetFileName, InjectFileName)¶
Parameters¶
TargetFileName: Spinnaker::GenICam::gcstring const & InjectFileName: Spinnaker::GenICam::gcstring const &
- LoadXMLFromStringInject(self, TargetXMLData, InjectXMLData)¶
Parameters¶
TargetXMLData: Spinnaker::GenICam::gcstring const & InjectXMLData: Spinnaker::GenICam::gcstring const &
- LoadXMLFromZIPFile(self, ZipFileName)¶
Parameters¶
ZipFileName: Spinnaker::GenICam::gcstring const &
- MergeXMLFiles(self, TargetFileName, InjectedFileName, OutputFileName)¶
Parameters¶
TargetFileName: Spinnaker::GenICam::gcstring const & InjectedFileName: Spinnaker::GenICam::gcstring const & OutputFileName: Spinnaker::GenICam::gcstring const &
- PreprocessXMLFromFile(self, XMLFileName, StyleSheetFileName, OutputFileName, XMLValidation=xvDefault)¶
Parameters¶
XMLFileName: Spinnaker::GenICam::gcstring const & StyleSheetFileName: Spinnaker::GenICam::gcstring const & OutputFileName: Spinnaker::GenICam::gcstring const & XMLValidation: uint32_t const
- PreprocessXMLFromZIPFile(self, XMLFileName, StyleSheetFileName, OutputFileName, XMLValidation=xvDefault)¶
Parameters¶
XMLFileName: Spinnaker::GenICam::gcstring const & StyleSheetFileName: Spinnaker::GenICam::gcstring const & OutputFileName: Spinnaker::GenICam::gcstring const & XMLValidation: uint32_t const
- class IPersistScript(*args, **kwargs)¶
Bases:
objectProxy of C++ Spinnaker::GenApi::IPersistScript class.
- class IPointCloud(*args, **kwargs)¶
Bases:
objectThe interface file for PointCloud class.
- GetNumPoints(self) size_t¶
- GetPoint(self, index) Stereo3DPoint¶
Parameters¶
index: unsigned int const
- GetPointCloudData(self) Spinnaker::IPointCloud::PointCloudData *¶
- class IRegister(*args, **kwargs)¶
Bases:
IValueProxy of C++ Spinnaker::GenApi::IRegister class.
- Get(self, pBuffer, Length, Verify=False, IgnoreCache=False)¶
Parameters¶
pBuffer: uint8_t * Length: int64_t Verify: bool IgnoreCache: bool
Get(self, size_read) -> std::vector< uint8_t >
Parameters¶
size_read: int64_t
Get(self, size_read, verify_range) -> std::vector< uint8_t >
Parameters¶
size_read: int64_t verify_range: bool
Get(self, size_read, verify_range, ignore_cache) -> std::vector< uint8_t >
Parameters¶
size_read: int64_t verify_range: bool ignore_cache: bool
Gets a NumPy array representing the contents of the register, as 8-bit unsigned ints.
Parameters:¶
pBuffer: The number of bytes to retrieve
Verify: Enables Range verification (default = false). The AccessMode is always checked
IgnoreCache: If true the value is read ignoring any caches (default = false)
- GetAddress(self) int64_t¶
- GetLength(self) int64_t¶
- Set(self, pBuffer, Verify=True)¶
Parameters¶
pBuffer: uint8_t const * Verify: bool
Set the register’s contents with the contents (as 8-bit unsigned ints) of the given array.
Parameters:¶
pBuffer: The NumPy array containing the data to set
Verify: Enables AccessMode and Range verification (default = true)
- class IScan3DParameters(*args, **kwargs)¶
Bases:
objectThe Interface file for Scan3DParameters data.
- GetBaseline(self) float64_t¶
- GetCoordinateReferenceSelector(self) Spinnaker::Scan3dCoordinateReferenceSelectorEnums¶
- GetCoordinateReferenceValue(self) float64_t¶
- GetCoordinateSelector(self) Spinnaker::Scan3dCoordinateSelectorEnums¶
- GetCoordinateSystem(self) Spinnaker::Scan3dCoordinateSystemEnums¶
- GetCoordinateSystemReference(self) Spinnaker::Scan3dCoordinateSystemReferenceEnums¶
- GetCoordinateTransformSelector(self) Spinnaker::Scan3dCoordinateTransformSelectorEnums¶
- GetDistanceUnit(self) Spinnaker::Scan3dDistanceUnitEnums¶
- GetFocalLength(self) float64_t¶
- GetOutputMode(self) Spinnaker::Scan3dOutputModeEnums¶
- GetPrincipalPointU(self) float64_t¶
- GetPrincipalPointV(self) float64_t¶
- GetTransformValue(self) float64_t¶
- SetCoordinateReferenceSelector(self, value)¶
Parameters¶
value: enum Spinnaker::Scan3dCoordinateReferenceSelectorEnums
- SetCoordinateSelector(self, value)¶
Parameters¶
value: enum Spinnaker::Scan3dCoordinateSelectorEnums
- SetCoordinateSystemReference(self, value)¶
Parameters¶
value: enum Spinnaker::Scan3dCoordinateSystemReferenceEnums
- class ISelector(*args, **kwargs)¶
Bases:
IBaseProxy of C++ Spinnaker::GenApi::ISelector class.
- GetSelectedFeatures(self)¶
- GetSelectingFeatures(self)¶
- class ISelectorDigit(*args, **kwargs)¶
Bases:
objectProxy of C++ Spinnaker::GenApi::ISelectorDigit class.
- Restore(self)¶
- class IString(*args, **kwargs)¶
Bases:
IValueProxy of C++ Spinnaker::GenApi::IString class.
- GetMaxLength(self) int64_t¶
- class ISystem(*args, **kwargs)¶
Bases:
objectThe interface file for System.
- GetCameras(self, updateInterfaces=True, updateCameras=True) CameraList¶
Parameters¶
updateInterfaces: bool updateCameras: bool
- GetInterfaces(self, updateInterface=True) InterfaceList¶
Parameters¶
updateInterface: bool
- GetLibraryVersion(self) LibraryVersion¶
- GetLoggingEventPriorityLevel(self) Spinnaker::SpinnakerLogLevel¶
- RegisterEventHandler(self, evtHandlerToRegister, updateInterface=False)¶
Parameters¶
evtHandlerToRegister: Spinnaker::EventHandler & updateInterface: bool
- ReleaseInstance(self)¶
- SendActionCommand(self, deviceKey, groupKey, groupMask, actionTime=0, requestAck=False, pResultSize=None, results=0)¶
Parameters¶
deviceKey: unsigned int groupKey: unsigned int groupMask: unsigned int actionTime: unsigned long long requestAck: bool pResultSize: unsigned int * results: Spinnaker::ActionCommandResult []
- UnregisterAllLoggingEventHandlers(self)¶
- UnregisterEventHandler(self, evtHandlerToUnregister)¶
Parameters¶
evtHandlerToUnregister: Spinnaker::EventHandler &
- UpdateInterfaceList(self)¶
- property TLSystem¶
- class ISystemEventHandler(*args, **kwargs)¶
Bases:
IInterfaceArrivalEventHandler,IInterfaceRemovalEventHandler
- class IValue(*args, **kwargs)¶
Bases:
INodeProxy of C++ Spinnaker::GenApi::IValue class.
- class Image(*args, **kwargs)¶
Bases:
IImageThe image object class.
- static Create() ImagePtr¶
- static Create(image) ImagePtr
Parameters¶
image: Spinnaker::ImagePtr const
Create(width, height, offsetX, offsetY, pixelFormat, pData) -> ImagePtr
Parameters¶
width: size_t height: size_t offsetX: size_t offsetY: size_t pixelFormat: enum Spinnaker::PixelFormatEnums pData: void *
Create(width, height, offsetX, offsetY, pixelFormat, pData, dataPayloadType, dataSize) -> ImagePtr
Parameters¶
width: size_t height: size_t offsetX: size_t offsetY: size_t pixelFormat: enum Spinnaker::PixelFormatEnums pData: void * dataPayloadType: enum Spinnaker::TLPayloadType dataSize: size_t
Creates a new Image object, either using a default constructor, copied from another ImagePtr, or using width, height, offset_x, offset_y, pixel format, and a NumPy array containing 8-bit unsigned ints representing the image data (replaces the void* pData argument).
- static GetImageStatusDescription(status) char const *¶
Parameters¶
status: enum Spinnaker::ImageStatus
- static Load(pFilename, format=SPINNAKER_IMAGE_FILE_FORMAT_FROM_FILE_EXT) ImagePtr¶
Parameters¶
pFilename: char const * format: enum Spinnaker::ImageFileFormat
- CheckCRC(self) bool¶
Checks if the computed checksum matches with chunk data’s ImageCRC
Returns true if computed checksum matches with the chunk data’s CRC and false otherwise.
- DeepCopy(self, pSrcImage)¶
Parameters¶
pSrcImage: Spinnaker::ImagePtr const
Performs a deep copy of the Image. After this operation, the image contents and member variables will be the same. The Images will not share a buffer. The Image’s current buffer will not be released.
- param pSrcImage:
The Image to copy the data from.
- GetBitsPerPixel(self) size_t¶
Gets the number of bits used per pixel in the image. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.
The number of bits used per pixel.
- GetBufferSize(self) size_t¶
Gets the size of the buffer associated with the image in bytes.
For user created images, this function returns the size of the user provided data if the data size was provided. If the data size was not provided, the buffer size is calculated based on the image dimensions and pixel format.
See: GetImageSize()
GetValidPayloadSize()
The size of the buffer, in bytes.
- GetChunkData(self) ChunkData¶
Returns a pointer to a chunk data interface. No ownership is transfered, the chunk data interface reference is valid until Image::Release() is called on this image.
ChunkData interface that provides access to image chunks.
- GetChunkLayoutId(self) uint64_t¶
Returns the id of the chunk data layout.
uint64_t value representing the id of the chunk data layout.
- GetColorProcessing(self) Spinnaker::ColorProcessingAlgorithm¶
Gets the color algorithm used to produce the image.
See: ImageProcessor::Convert()
The color processing algorithm used to produce the image.
- GetDataAbsoluteMax(self) float¶
Get the value for which no image data will exceed.
the maximim theoretical image data value
- GetDataAbsoluteMin(self) float¶
Get the value for which no image data will be less than
the minimum theoretical image data value
- GetFrameID(self) uint64_t¶
Gets the frame ID for this image.
The frame ID.
- GetHeight(self) size_t¶
Gets the height of the image in pixels. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.
The height in pixels.
- GetID(self) uint64_t¶
Gets a unique ID for this image that is associated with a stream. Note that an ID of 0 indicates that the image is no longer associated with a stream or is a copy of the original image.
See: GetFrameID()
The 64 bit unique id for this image.
- GetImagePayloadType(self) Spinnaker::ImagePayloadType¶
Gets the image specific payload type.
Image payload type
- GetImageSize(self) size_t¶
Returns the size of the image
If the image is compressed, the value returned represents the size of the compressed image data in bytes. For chunk enabled data transmissions, only the size of the image chunk is reported here. If the image chunk is compressed, the value returned represents the size of the compressed image data in bytes. The entire chunk data payload including the image chunk and other optional data chunks can be queried by GetValidPayloadSize().
See: GetBufferSize()
GetValidPayloadSize()
The image size in bytes.
- GetImageStatus(self) Spinnaker::ImageStatus¶
Returns data integrity status of the image returned from GetNextImage()
Returns whether image has any data integrity issues.
- GetNumChannels(self) size_t¶
Gets the number of channels (depth) used in the image. Returns 0 if the number of channels for the given pixel format is unknown.
The number of channels per pixel.
- GetPayloadType(self) size_t¶
Gets the device specific payload type that was transmitted. This is a Transport Layer specific value that identifies how the image was transmitted. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.
Transport Layer device specific payload type.
- GetPixelFormat(self) Spinnaker::PixelFormatEnums¶
Returns an enum value that represents the pixel format of this image. The enum can be used with the easy access GenICam features available through the Camera.h header file. This easy access enum can also be used in the ImageProcessor::Convert() function.
See: ImageProcessor::Convert()
enum value representing the PixelFormat.
- GetPixelFormatIntType(self) Spinnaker::PixelFormatIntType¶
Returns an enum value that represents the integer type used in the pixel format of this image.
enum value representing the integer type used.
- GetPixelFormatName(self) gcstring¶
Returns a string value that represents this image’s pixel format. The string is a valid SFNC name that maps to the underlying TL specific pixel format. This is the most generic way to identify the pixel format of the image.
string value representing the PixelFormat.
- GetPrivateData(self) void *¶
Gets a pointer to the user passed data associated with the image. This function is considered unsafe. The pointer returned could be invalidated if the buffer is released. The pointer may also be invalidated if the Image object is passed to Image::Release().
TODO: no way to set private data for image yet.
A pointer to the user passed data pointer.
- GetSerialNumber(self) gcstring¶
Gets the serial number of the camera that captured the image. Note that an empty string indicates that the image is not associated with a camera
The serial number of the camera that captured the image.
- GetStreamIndex(self) uint64_t¶
Gets the stream channel index of where the image is received.
The stream channel index of where this image is received.
- GetStride(self) size_t¶
Gets the stride of the image in bytes. The stride of an image is how many bytes are in each row. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.
The stride in bytes.
- GetTLPayloadType(self) Spinnaker::TLPayloadType¶
Gets the GenTL payload type that was transmitted. This is a generic Transport agnostic value that identifies how the image was transmitted. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.
Transport Layer agnostic GenTL payload type.
- GetTLPixelFormat(self) uint64_t¶
Gets the pixel format of the image. This is a Transport Layer specific pixel format that identifies how the pixels in the image should be interpreted. To understand how to interpret this value it is necessary to know what the transport layer namespace is. This can be retrieved through a call to GetTLPixelFormatNamespace(). This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.
See: GetTLPixelFormatNamespace()
Transport Layer specific pixel format.
- GetTLPixelFormatNamespace(self) Spinnaker::TLPixelFormatNamespace¶
Returns an enum value that represents the namespace in which this image’s TL specific pixel format resides. This information is important to properly interpret the value returned by GetTLPixelFormat()
See: GetTLPixelFormat()
enum value representing the PixelFormatNamespace.
- GetTimeStamp(self) uint64_t¶
Gets the time stamp for the image in nanoseconds.
The time stamp of the image.
- GetValidPayloadSize(self) size_t¶
Returns the size of valid data in the image payload.
This is the actual amount of data read from the device. For non-chunk images, the value returned here is equal to the value returned by GetImageSize(). For chunk enabled data transmissions, the sum of the image chunk, other optional data chunks (e.g. ExposureTime) and their associated chunk headers is returned here. Note that GetBufferSize() returns the total size of bytes allocated for the image and could be equal to or greater than the size returned by this function.
See: GetBufferSize()
GetImageSize()
size_t value representing valid payload.
- GetWidth(self) size_t¶
Gets the width of the image in pixels. This information is retrieved from the Transport Layer image format headers. It is retrieved on a per image basis.
The width in pixels.
- GetXOffset(self) size_t¶
Gets the ROI x offset in pixels for this image. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.
The x offset in pixels.
- GetXPadding(self) size_t¶
Gets the x padding in bytes for this image. This is the number of bytes at the end of each line to facilitate alignment in buffers. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.
The x padding in bytes.
- GetYOffset(self) size_t¶
Gets the ROI y offset in pixels for this image. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.
The y offset in pixels.
- GetYPadding(self) size_t¶
Gets the y padding in bytes for this image. This is the number of bytes at the end of each image to facilitate alignment in buffers. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.
The y padding in bytes.
- HasCRC(self) bool¶
Checks if the image contains ImageCRC checksum from chunk data
Returns true if image contains ImageCRC checksum from chunk data and false otherwise.
- HasChunkData(self) bool¶
Checks if the image contains chunk data
Returns true if image contains chunk data and false otherwise.
- IsCompressed(self) bool¶
Returns a boolean value indicating whether this image is compressed.
Returns true if image is compressed, false otherwise.
- IsInUse(self) bool¶
Returns true if the image is still in use by the stream
Returns true if the image is in use and false otherwise.
- IsIncomplete(self) bool¶
Returns a boolean value indicating if this image was incomplete. An image is marked as incomplete if the transport layer received less data then it requested.
Returns true if image is incomplete, false otherwise.
- Release(self)¶
- ResetImage(self, width, height, offsetX, offsetY, pixelFormat)¶
Parameters¶
width: size_t height: size_t offsetX: size_t offsetY: size_t pixelFormat: enum Spinnaker::PixelFormatEnums
ResetImage(self, width, height, offsetX, offsetY, pixelFormat, pData)
Parameters¶
width: size_t height: size_t offsetX: size_t offsetY: size_t pixelFormat: enum Spinnaker::PixelFormatEnums pData: void *
ResetImage(self, width, height, offsetX, offsetY, pixelFormat, pData, dataPayloadType, dataSize)
Parameters¶
width: size_t height: size_t offsetX: size_t offsetY: size_t pixelFormat: enum Spinnaker::PixelFormatEnums pData: void * dataPayloadType: enum Spinnaker::TLPayloadType dataSize: size_t
Sets new dimensions of the image object. This function is used to create an image from existing image data with a specific payload type, such as a compressed image.
- param width:
The width of image in pixels to set.
- param height:
The height of image in pixels to set.
- param offsetX:
The x offset in pixels to set.
- param offsetY:
The y offset in pixels to set.
- param pixelFormat:
Pixel format to set.
- param pData:
Pointer to the image buffer.
- param dataPayloadType:
The payload type of the data. This value can be retrieved from an existing image by using the GetTLPayloadType() function call.
- param dataSize:
The size of the provided data in bytes
- See:
GetTLPayloadType()
- Save(self, pFilename, format=SPINNAKER_IMAGE_FILE_FORMAT_FROM_FILE_EXT)¶
Parameters¶
pFilename: char const * format: enum Spinnaker::ImageFileFormat
Save(self, pFilename, pOption)
Parameters¶
pFilename: char const * pOption: Spinnaker::PNGOption &
Save(self, pFilename, pOption)
Parameters¶
pFilename: char const * pOption: Spinnaker::PPMOption &
Save(self, pFilename, pOption)
Parameters¶
pFilename: char const * pOption: Spinnaker::PGMOption &
Save(self, pFilename, pOption)
Parameters¶
pFilename: char const * pOption: Spinnaker::TIFFOption &
Save(self, pFilename, pOption)
Parameters¶
pFilename: char const * pOption: Spinnaker::JPEGOption &
Save(self, pFilename, pOption)
Parameters¶
pFilename: char const * pOption: Spinnaker::JPG2Option &
Save(self, pFilename, pOption)
Parameters¶
pFilename: char const * pOption: Spinnaker::BMPOption &
Save(self, pFilename, pOption)
Parameters¶
pFilename: char const * pOption: Spinnaker::GenDCOption &
Save(self, pFilename, pOption)
Parameters¶
pFilename: char const * pOption: Spinnaker::SIOption &
Saves the image to the specified file name with the options specified.
- param pFilename:
Filename to save image with.
- param pOption:
Options to use while saving image.
- class ImageEventHandler¶
Bases:
IImageEventHandlerA handler for capturing image arrival events.
- class ImageList(*args)¶
Bases:
IImageListUsed to hold a list of image objects.
- Add(self, image)¶
Parameters¶
image: Spinnaker::ImagePtr
Adds a copy of an image object.
- param image:
An image object to be added to this list.
- Append(self, list)¶
Parameters¶
list: Spinnaker::ImageList const &
Appends a copy of the image list.
- param list:
Another ImageList object, whose elements are added to this list.
- Clear(self)¶
Clears the list of images and destroys their corresponding reference counted objects. This is necessary in order to clean up the parent interface. It is important that the camera list is destroyed or is cleared before calling system->ReleaseInstance() or else the call to system->ReleaseInstance() will result in an error message thrown that a reference to the camera is still held.
See: System::ReleaseInstance()
- GetByIndex(self, index) ImagePtr¶
Parameters¶
index: unsigned int
Returns a pointer to an image object at the “index”. This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the input index is out of range.
- param index:
The index at which to retrieve the Image object
A pointer to an image object.
- GetByPayloadType(self, payloadType) ImagePtr¶
Parameters¶
payloadType: enum Spinnaker::ImagePayloadType const
Returns a pointer to an image object with the specified image payload type. This function will return a null image pointer if no image with matching image payload type is found.
- param payloadType:
The stream index of the Image object to retrieve
A pointer to a image object.
- GetByPixelFormat(self, pixelFormat) ImagePtr¶
Parameters¶
pixelFormat: enum Spinnaker::PixelFormatEnums
Returns a pointer to the first image object with the pixel format from the list. This function will return a null image pointer if no image with matching pixel format is found.
- param pixelFormat:
The pixel format of the Image object to retrieve
A pointer to an image object.
- GetByStreamIndex(self, streamIndex) ImagePtr¶
Parameters¶
streamIndex: uint64_t const
Returns a pointer to an image object with the specified stream index. This function will return a NULL ImagePtr if no image with matching stream index is found.
- param streamIndex:
The stream index of the Image object to retrieve
A pointer to a image object.
- GetImagesByPayloadType(self, payloadType) ImageList¶
Parameters¶
payloadType: enum Spinnaker::ImagePayloadType const
Returns an ImageList containing all the images matching the specified image payload type. This function will return an empty list if no image with matching image payload type is found.
- param payloadType:
The stream index of the Image object to retrieve
A pointer to a image object.
- GetImagesByPixelFormat(self, pixelFormat) ImageList¶
Parameters¶
pixelFormat: enum Spinnaker::PixelFormatEnums
Returns an ImageList containing all imageList objects that match the pixel format provided. This function will return an empty list if no image with matching pixel format is found.
- param pixelFormat:
The pixel format of the Image object to retrieve
An ImageList containing all matching image objects.
- GetSize(self) unsigned int¶
Returns the size of the image list. The size is the number of Image objects stored in the list.
An integer that represents the list size.
- Release(self)¶
- RemoveByIndex(self, index)¶
Parameters¶
index: unsigned int
Removes an image at “index” and destroys its corresponding reference counted object. This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the input index is out of range.
- param index:
The index at which to remove the Image object
- RemoveByPayloadType(self, payloadType)¶
Parameters¶
payloadType: enum Spinnaker::ImagePayloadType const
Removes an image object with the specified payload type from the list. This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the list does not have any image with the specified payload type.
- param payloadType:
The payload type of the Image object to retrieve
- RemoveByPixelFormat(self, pixelFormat)¶
Parameters¶
pixelFormat: enum Spinnaker::PixelFormatEnums
Removes an image object with the image pixel format from the list. This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the list does not have any image with the specified pixel format.
- param pixelFormat:
The pixel format of the image object to remove
- RemoveByStreamIndex(self, streamIndex)¶
Parameters¶
streamIndex: uint64_t const
Removes an image object with the stream index from the list. This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the list does not have any image with the specified stream index.
- param streamIndex:
The stream index of the Image object to retrieve
- class ImageListEventHandler¶
Bases:
IImageListEventHandlerA handler for capturing image list arrival events.
- class ImageProcessor(*args)¶
Bases:
IImageProcessorImage post processing class for converting a source image to another pixel format.
All supported input image pixel formats can be converted to supported output image pixel formats. If the input pixel format is a compressed format, the decompression will occur before converting to the output pixel format.
List of supported input image pixel formats:
PixelFormat_Mono8
PixelFormat_Mono16
PixelFormat_BayerGR8
PixelFormat_BayerRG8
PixelFormat_BayerGB8
PixelFormat_BayerBG8
PixelFormat_BayerGR16
PixelFormat_BayerRG16
PixelFormat_BayerGB16
PixelFormat_BayerBG16
PixelFormat_Mono12Packed
PixelFormat_BayerGR12Packed
PixelFormat_BayerRG12Packed
PixelFormat_BayerGB12Packed
PixelFormat_BayerBG12Packed
PixelFormat_YUV411Packed
PixelFormat_YUV422Packed
PixelFormat_YUV444Packed
PixelFormat_Mono12p
PixelFormat_BayerGR12p
PixelFormat_BayerRG12p
PixelFormat_BayerGB12p
PixelFormat_BayerBG12p
PixelFormat_YCbCr8
PixelFormat_YCbCr422_8
PixelFormat_YCbCr411_8
PixelFormat_BGR8
PixelFormat_BGRa8
PixelFormat_Mono10Packed
PixelFormat_BayerGR10Packed
PixelFormat_BayerRG10Packed
PixelFormat_BayerGB10Packed
PixelFormat_BayerBG10Packed
PixelFormat_Mono10p
PixelFormat_BayerGR10p
PixelFormat_BayerRG10p
PixelFormat_BayerGB10p
PixelFormat_BayerBG10p
PixelFormat_Mono10
PixelFormat_Mono12
PixelFormat_Mono14
PixelFormat_BayerBG10
PixelFormat_BayerBG12
PixelFormat_BayerGB10
PixelFormat_BayerGB12
PixelFormat_BayerGR10
PixelFormat_BayerGR12
PixelFormat_BayerRG10
PixelFormat_BayerRG12
PixelFormat_RGBa8
PixelFormat_RGB8
PixelFormat_RGB12
PixelFormat_BGR16
PixelFormat_R12
PixelFormat_G12
PixelFormat_B12
PixelFormat_YUV8_UYV
PixelFormat_YUV411_8_UYYVYY
PixelFormat_YUV422_8
PixelFormat_Polarized8
PixelFormat_Polarized10p
PixelFormat_Polarized12p
PixelFormat_Polarized16
PixelFormat_BayerRGPolarized8
PixelFormat_BayerRGPolarized10p
PixelFormat_BayerRGPolarized12p
PixelFormat_BayerRGPolarized16
PixelFormat_LLCMono8
PixelFormat_LLCBayerRG8
PixelFormat_JPEGMono8
PixelFormat_JPEGColor8
PixelFormat_Raw16
PixelFormat_Raw8
PixelFormat_R12_Jpeg
PixelFormat_GR12_Jpeg
PixelFormat_GB12_Jpeg
PixelFormat_B12_Jpeg
List of supported output image pixel formats
PixelFormat_Mono8
PixelFormat_Mono16
PixelFormat_BayerBG8
PixelFormat_BayerGB8
PixelFormat_BayerRG8
PixelFormat_BayerGR8
PixelFormat_BayerBG16
PixelFormat_BayerGB16
PixelFormat_BayerRG16
PixelFormat_BayerGR16
PixelFormat_BGR8
PixelFormat_BGRa8
PixelFormat_RGB8
PixelFormat_RGBa8
PixelFormat_BGR16
PixelFormat_RGB16
PixelFormat_R12
PixelFormat_G12
PixelFormat_B12
- ApplyGamma(self, srcImage, gamma, applyGammaInverse=False) ImagePtr¶
Parameters¶
srcImage: Spinnaker::ImagePtr const & gamma: float applyGammaInverse: bool
ApplyGamma(self, srcImage, destImage, gamma, applyGammaInverse=False)
Parameters¶
srcImage: Spinnaker::ImagePtr const & destImage: Spinnaker::ImagePtr & gamma: float applyGammaInverse: bool
Applies gamma correction to the source image and stores the result in the destination image.
Note that the destination image buffer cannot point to the same memory location as the source image buffer. This ensures that the image processing operation does not result in undefined behavior or data corruption due to overlapping memory regions.
- param srcImage:
The source image from which to apply gamma on.
- param destImage:
The destination image in which the gamma applied image data will be stored.
- param gamma:
Gamma value to apply. A value between 0.5 and 4 is acceptable. (Default assuming image-to-screen)
- param applyGammaInverse:
Converts a gamma corrected source image back to the original image using the inverse of the gamma value (used for applying screen-to-image gamma)
- Convert(self, srcImage, destFormat) ImagePtr¶
Parameters¶
srcImage: Spinnaker::ImagePtr const & destFormat: enum Spinnaker::PixelFormatEnums
Convert(self, srcImage, destImage, destFormat)
Parameters¶
srcImage: Spinnaker::ImagePtr const & destImage: Spinnaker::ImagePtr & destFormat: enum Spinnaker::PixelFormatEnums
Convert(self, srcImageList, destFormat) -> ImagePtr
Parameters¶
srcImageList: Spinnaker::ImageList const & destFormat: enum Spinnaker::PixelFormatEnums
Convert(self, srcImageList, destImage, destFormat)
Parameters¶
srcImageList: Spinnaker::ImageList const & destImage: Spinnaker::ImagePtr & destFormat: enum Spinnaker::PixelFormatEnums
Converts the source list of image buffers to the specified output pixel format and stores the result in the destination image. The conversion could encompasses decompression, interleaving and conversion of image data depending on the source pixel format of images in the source image list. The destination image needs to be configured to have the correct buffer size before calling this function. See ResetImage() to setup the correct buffer size according to specified pixel format.
Note that compressed images are decompressed before any further color processing, interleaving or conversion is performed. Decompression is multi-threaded and defaults to utilizing one less than the number of concurrent threads supported by the system. The default number of decompression threads can be set with SetNumDecompressionThreads().
Note not all the supported image pixel formats described in the class description are supported in this function.
List of supported image pixel formats for the source image list:
PixelFormat_R12
PixelFormat_GR12
PixelFormat_GB12
PixelFormat_B12
PixelFormat_R12_Jpeg
PixelFormat_GR12_Jpeg
PixelFormat_GB12_Jpeg
PixelFormat_B12_Jpeg
See: PixelFormatEnums
ResetImage
SetNumDecompressionThreads
Args: srcImageList: List of images from which to convert the images from. destImage: The destination image in which the converted image data will be stored. destFormat: Output format of the converted image.
- GetColorProcessing(self) Spinnaker::ColorProcessingAlgorithm¶
Gets the default color processing algorithm.
See: SetColorProcessing()
The default color processing algorithm.
- GetNumDecompressionThreads(self) unsigned int¶
Gets the number of threads used for image decompression during Convert().
See: SetNumDecompressionThreads()
Number of parallel image decompression threads set to run.
- SetColorProcessing(self, colorAlgorithm)¶
Parameters¶
colorAlgorithm: enum Spinnaker::ColorProcessingAlgorithm
Sets the color processing algorithm used at the time of the Convert() call, therefore the most recent execution of this function will take precedence. The DEFAULT algorithm is deprecated and should not be used in the ImageProcessor class.
- param colorAlgorithm:
The color processing algorithm to set.
- See:
GetColorProcessing()
- SetNumDecompressionThreads(self, numThreads)¶
Parameters¶
numThreads: unsigned int
Sets the default number of threads used for image decompression during Convert(). The number of threads used is defaulted to be equal to one less than the number of concurrent threads supported by the system.
- param numThreads:
Number of parallel image decompression threads set to run
- See:
Convert()
- class ImagePtr(*args)¶
Bases:
_SWIG_ImgPtrA reference tracked pointer to an image object. When the ImagePtr goes out of scope, it will trigger an auto release of the image from the stream.
- class ImageUtility¶
Bases:
objectStatic helper functions for the image object class.
- static CreateNormalized(srcImage, destPixelFormat, srcDataRange=SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE) ImagePtr¶
Parameters¶
srcImage: Spinnaker::ImagePtr const & destPixelFormat: enum Spinnaker::PixelFormatEnums const srcDataRange: enum Spinnaker::SourceDataRange
CreateNormalized(srcImage, min, max, srcDataRange=SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE) -> ImagePtr
Parameters¶
srcImage: Spinnaker::ImagePtr const & min: double const max: double const srcDataRange: enum Spinnaker::SourceDataRange
CreateNormalized(srcImage, min, max, destPixelFormat, srcDataRange=SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE) -> ImagePtr
Parameters¶
srcImage: Spinnaker::ImagePtr const & min: double const max: double const destPixelFormat: enum Spinnaker::PixelFormatEnums const srcDataRange: enum Spinnaker::SourceDataRange
CreateNormalized(srcImage, destImage, srcDataRange=SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE)
Parameters¶
srcImage: Spinnaker::ImagePtr const & destImage: Spinnaker::ImagePtr & srcDataRange: enum Spinnaker::SourceDataRange
CreateNormalized(srcImage, destImage, min, max, srcDataRange=SPINNAKER_SOURCE_DATA_RANGE_IMAGE_DATA_RANGE)
Parameters¶
srcImage: Spinnaker::ImagePtr const & destImage: Spinnaker::ImagePtr & min: double const max: double const srcDataRange: enum Spinnaker::SourceDataRange
- static CreateScaled(srcImage, scalingAlg, scalingFactor) ImagePtr¶
Parameters¶
srcImage: Spinnaker::ImagePtr const & scalingAlg: enum Spinnaker::ImageScalingAlgorithm scalingFactor: double
CreateScaled(srcImage, destImage, scalingAlg, scalingFactor)
Parameters¶
srcImage: Spinnaker::ImagePtr const & destImage: Spinnaker::ImagePtr & scalingAlg: enum Spinnaker::ImageScalingAlgorithm scalingFactor: double
- static GetNumThreads() unsigned int¶
- class ImageUtilityCCM¶
Bases:
objectStatic function to create color corrected images from an image object.
- static ApplicationToString(application) std::string¶
Parameters¶
application: Spinnaker::CCMApplication const &
- static ColorSpaceToString(colorSpace) std::string¶
Parameters¶
colorSpace: Spinnaker::CCMColorSpace const &
- static ColorTemperatureToString(colorTemperature) std::string¶
Parameters¶
colorTemperature: Spinnaker::CCMColorTemperature const &
- static CreateColorCorrected(srcImage, settings) ImagePtr¶
Parameters¶
srcImage: Spinnaker::ImagePtr const & settings: Spinnaker::CCMSettings const &
CreateColorCorrected(srcImage, destImage, settings)
Parameters¶
srcImage: Spinnaker::ImagePtr const & destImage: Spinnaker::ImagePtr & settings: Spinnaker::CCMSettings const &
- class ImageUtilityHeatmap¶
Bases:
objectStatic functions to create heatmap images from image objects of pixel format Mono8 and Mono16.
- static CreateHeatmap(srcImage) ImagePtr¶
Parameters¶
srcImage: Spinnaker::ImagePtr const &
CreateHeatmap(srcImage, destImage)
Parameters¶
srcImage: Spinnaker::ImagePtr const & destImage: Spinnaker::ImagePtr &
CreateHeatmap(srcImage, minPixelValue, maxPixelValue, lowColor, highColor, doCheckInvalidVal, invalidVal) -> ImagePtr
Parameters¶
srcImage: Spinnaker::ImagePtr const & minPixelValue: float const maxPixelValue: float const lowColor: enum Spinnaker::HeatmapColor const highColor: enum Spinnaker::HeatmapColor const doCheckInvalidVal: bool const invalidVal: unsigned int const
CreateHeatmap(srcImage, destImage, minPixelValue, maxPixelValue, lowColor, highColor, doCheckInvalidVal, invalidVal)
Parameters¶
srcImage: Spinnaker::ImagePtr const & destImage: Spinnaker::ImagePtr & minPixelValue: float const maxPixelValue: float const lowColor: enum Spinnaker::HeatmapColor const highColor: enum Spinnaker::HeatmapColor const doCheckInvalidVal: bool const invalidVal: unsigned int const
- static GetHeatmapColorGradient(currentLowColor, currentHighColor)¶
Parameters¶
currentLowColor: Spinnaker::HeatmapColor & currentHighColor: Spinnaker::HeatmapColor &
- static GetHeatmapRange(currentLowValue, currentHighValue)¶
Parameters¶
currentLowValue: unsigned int & currentHighValue: unsigned int &
- class ImageUtilityPolarization¶
Bases:
objectStatic functions to create polarization images from image objects of pixel format Polarized8 and BayerRGPolarized8.
- static CreateAolp(srcImage, colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR) ImagePtr¶
Parameters¶
srcImage: Spinnaker::ImagePtr const & colorProcessingAlg: enum Spinnaker::ColorProcessingAlgorithm const
CreateAolp(srcImage, destAolpImg, colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
Parameters¶
srcImage: Spinnaker::ImagePtr const & destAolpImg: Spinnaker::ImagePtr & colorProcessingAlg: enum Spinnaker::ColorProcessingAlgorithm const
- static CreateDolp(srcImage, colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR) ImagePtr¶
Parameters¶
srcImage: Spinnaker::ImagePtr const & colorProcessingAlg: enum Spinnaker::ColorProcessingAlgorithm const
CreateDolp(srcImage, destDolpImage, colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
Parameters¶
srcImage: Spinnaker::ImagePtr const & destDolpImage: Spinnaker::ImagePtr & colorProcessingAlg: enum Spinnaker::ColorProcessingAlgorithm const
- static CreateGlareReduced(srcImage) ImagePtr¶
Parameters¶
srcImage: Spinnaker::ImagePtr const &
CreateGlareReduced(srcImage, destGlareReducedImage)
Parameters¶
srcImage: Spinnaker::ImagePtr const & destGlareReducedImage: Spinnaker::ImagePtr &
- static CreateStokesS0(srcImage, colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR) ImagePtr¶
Parameters¶
srcImage: Spinnaker::ImagePtr const & colorProcessingAlg: enum Spinnaker::ColorProcessingAlgorithm const
CreateStokesS0(srcImage, destStokesS0Image, colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
Parameters¶
srcImage: Spinnaker::ImagePtr const & destStokesS0Image: Spinnaker::ImagePtr & colorProcessingAlg: enum Spinnaker::ColorProcessingAlgorithm const
- static CreateStokesS1(srcImage, colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR) ImagePtr¶
Parameters¶
srcImage: Spinnaker::ImagePtr const & colorProcessingAlg: enum Spinnaker::ColorProcessingAlgorithm const
CreateStokesS1(srcImage, destStokesS1Image, colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
Parameters¶
srcImage: Spinnaker::ImagePtr const & destStokesS1Image: Spinnaker::ImagePtr & colorProcessingAlg: enum Spinnaker::ColorProcessingAlgorithm const
- static CreateStokesS2(srcImage, colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR) ImagePtr¶
Parameters¶
srcImage: Spinnaker::ImagePtr const & colorProcessingAlg: enum Spinnaker::ColorProcessingAlgorithm const
CreateStokesS2(srcImage, destStokesS2Image, colorProcessingAlg=SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR)
Parameters¶
srcImage: Spinnaker::ImagePtr const & destStokesS2Image: Spinnaker::ImagePtr & colorProcessingAlg: enum Spinnaker::ColorProcessingAlgorithm const
- static ExtractPolarQuadrant(srcImage, desiredQuadrant) ImagePtr¶
Parameters¶
srcImage: Spinnaker::ImagePtr const & desiredQuadrant: enum Spinnaker::PolarizationQuadrant const
ExtractPolarQuadrant(srcImage, destQuadImage, desiredQuadrant)
Parameters¶
srcImage: Spinnaker::ImagePtr const & destQuadImage: Spinnaker::ImagePtr & desiredQuadrant: enum Spinnaker::PolarizationQuadrant const
- class ImageUtilityStereo¶
Bases:
objectStatic helper functions for stereo related computations.
- static Compute3DPointFromPixel(disparity, scan3dParams, stereo3DPoint) bool¶
Parameters¶
disparity: uint16_t const scan3dParams: Spinnaker::Scan3DParameters const & stereo3DPoint: Spinnaker::Stereo3DPoint &
Compute3DPointFromPixel(disparity, stereoCameraParameters, stereo3DPoint) -> bool
Parameters¶
disparity: uint16_t const stereoCameraParameters: Spinnaker::StereoCameraParameters const & stereo3DPoint: Spinnaker::Stereo3DPoint &
- static ComputeDistanceBetweenPoints(disparityImage, stereoParam, imagePixel1, imagePixel2) PyObject *¶
Parameters¶
disparityImage: Spinnaker::ImagePtr const & stereoParam: Spinnaker::StereoCameraParameters const & imagePixel1: Spinnaker::ImagePixel const & imagePixel2: Spinnaker::ImagePixel const &
- static ComputeDistanceToPoint(disparityImage, stereoParam, imagePixel) PyObject *¶
Parameters¶
disparityImage: Spinnaker::ImagePtr const & stereoParam: Spinnaker::StereoCameraParameters const & imagePixel: Spinnaker::ImagePixel const &
- static ComputePointCloud(rangeImage, intensityImage, pointCloudParameters, scan3dParams) PointCloud¶
Parameters¶
rangeImage: Spinnaker::ImagePtr const & intensityImage: Spinnaker::ImagePtr const & pointCloudParameters: Spinnaker::PointCloudParameters const & scan3dParams: Spinnaker::Scan3DParameters const &
ComputePointCloud(rangeImage, intensityImage, pointCloudParameters, stereoCameraParameters) -> PointCloud
Parameters¶
rangeImage: Spinnaker::ImagePtr const & intensityImage: Spinnaker::ImagePtr const & pointCloudParameters: Spinnaker::PointCloudParameters const & stereoCameraParameters: Spinnaker::StereoCameraParameters const &
ComputePointCloud(rangeImage, intensityImage, pointCloudParameters, scan3dParams, pointCloud)
Parameters¶
rangeImage: Spinnaker::ImagePtr const & intensityImage: Spinnaker::ImagePtr const & pointCloudParameters: Spinnaker::PointCloudParameters const & scan3dParams: Spinnaker::Scan3DParameters const & pointCloud: Spinnaker::PointCloud &
ComputePointCloud(rangeImage, intensityImage, pointCloudParameters, stereoCameraParameters, pointCloud)
Parameters¶
rangeImage: Spinnaker::ImagePtr const & intensityImage: Spinnaker::ImagePtr const & pointCloudParameters: Spinnaker::PointCloudParameters const & stereoCameraParameters: Spinnaker::StereoCameraParameters const & pointCloud: Spinnaker::PointCloud &
- static CreateDepthImage(disparityImage, stereoCameraParameters, invalidDepthVal, depth_range_list) ImagePtr¶
Parameters¶
disparityImage: Spinnaker::ImagePtr const & stereoCameraParameters: Spinnaker::StereoCameraParameters const & invalidDepthVal: uint16_t const depth_range_list: PyObject *
CreateDepthImage(disparityImage, stereoCameraParameters, invalidDepthVal, depthImage, depth_range_list)
Parameters¶
disparityImage: Spinnaker::ImagePtr const & stereoCameraParameters: Spinnaker::StereoCameraParameters const & invalidDepthVal: uint16_t const depthImage: Spinnaker::ImagePtr & depth_range_list: PyObject *
- static CreateGradientImage(rectifiedImage) ImagePtr¶
Parameters¶
rectifiedImage: Spinnaker::ImagePtr const &
CreateGradientImage(rectifiedImage, gradientImage)
Parameters¶
rectifiedImage: Spinnaker::ImagePtr const & gradientImage: Spinnaker::ImagePtr &
- static DomainTransform(disparityImage, rectifiedImage, sigmaSpatial, sigmaColor, numIterations=3) ImagePtr¶
Parameters¶
disparityImage: Spinnaker::ImagePtr const & rectifiedImage: Spinnaker::ImagePtr const & sigmaSpatial: float const sigmaColor: float const numIterations: int const
- static DomainTransformFromImage(disparityImage, rectifiedImage, sigmaSpatial, sigmaColor, numIterations=3)¶
Parameters¶
disparityImage: Spinnaker::ImagePtr & rectifiedImage: Spinnaker::ImagePtr const & sigmaSpatial: float const sigmaColor: float const numIterations: int const
- static EdgeInterpolation(disparityImage, invalidDataValue, gradientImage, edgeThreshold, maxDistance) ImagePtr¶
Parameters¶
disparityImage: Spinnaker::ImagePtr const & invalidDataValue: float const gradientImage: Spinnaker::ImagePtr const & edgeThreshold: float const maxDistance: int const
- static EdgeInterpolationFromImage(disparityImage, invalidDataValue, gradientImage, edgeThreshold, maxDistance)¶
Parameters¶
disparityImage: Spinnaker::ImagePtr & invalidDataValue: float const gradientImage: Spinnaker::ImagePtr const & edgeThreshold: float const maxDistance: int const
- static FilterSpeckles(disparityImage, maxSpeckleSize, speckleThreshold, disparityScaleFactor, invalidDataValue) ImagePtr¶
Parameters¶
disparityImage: Spinnaker::ImagePtr const & maxSpeckleSize: int const speckleThreshold: float const disparityScaleFactor: float const invalidDataValue: float const
- static FilterSpecklesFromImage(disparityImage, maxSpeckleSize, speckleThreshold, disparityScaleFactor, invalidDataValue)¶
Parameters¶
disparityImage: Spinnaker::ImagePtr & maxSpeckleSize: int const speckleThreshold: float const disparityScaleFactor: float const invalidDataValue: float const
- static JointBilateral(disparityImage, rectifiedImage, sigmaSpatial, sigmaColor, filterDiameter) ImagePtr¶
Parameters¶
disparityImage: Spinnaker::ImagePtr const & rectifiedImage: Spinnaker::ImagePtr const & sigmaSpatial: float const sigmaColor: float const filterDiameter: int const
- static JointBilateralFromImage(disparityImage, rectifiedImage, sigmaSpatial, sigmaColor, filterDiameter)¶
Parameters¶
disparityImage: Spinnaker::ImagePtr & rectifiedImage: Spinnaker::ImagePtr const & sigmaSpatial: float const sigmaColor: float const filterDiameter: int const
- static ProcessDisparity(disparityImage, rectifiedImage, processingMethod, scan3dParams) ImagePtr¶
Parameters¶
disparityImage: Spinnaker::ImagePtr const & rectifiedImage: Spinnaker::ImagePtr const & processingMethod: enum Spinnaker::DisparityProcessingMethod const scan3dParams: Spinnaker::Scan3DParameters const &
ProcessDisparity(disparityImage, rectifiedImage, processingMethod, stereoCameraParameters) -> ImagePtr
Parameters¶
disparityImage: Spinnaker::ImagePtr const & rectifiedImage: Spinnaker::ImagePtr const & processingMethod: enum Spinnaker::DisparityProcessingMethod const stereoCameraParameters: Spinnaker::StereoCameraParameters const &
- static ProcessDisparityFromImage(disparityImage, rectifiedImage, processingMethod, scan3dParams)¶
Parameters¶
disparityImage: Spinnaker::ImagePtr & rectifiedImage: Spinnaker::ImagePtr const & processingMethod: enum Spinnaker::DisparityProcessingMethod const scan3dParams: Spinnaker::Scan3DParameters const &
ProcessDisparityFromImage(disparityImage, rectifiedImage, processingMethod, stereoCameraParameters)
Parameters¶
disparityImage: Spinnaker::ImagePtr & rectifiedImage: Spinnaker::ImagePtr const & processingMethod: enum Spinnaker::DisparityProcessingMethod const stereoCameraParameters: Spinnaker::StereoCameraParameters const &
- property maxDepthThresholdInMeter¶
- property maxDepthThresholdInMm¶
- class InferenceBoundingBox¶
Bases:
objectInference Bounding Boxes data structure
- property boxType¶
- property circle¶
- property classId¶
- property confidence¶
- property rect¶
- property rotatedRect¶
- class InferenceBoundingBoxResult(*args)¶
Bases:
objectAn inference bounding boxes object which holds information about the detected bounding boxes.
- GetBoxAt(self, index) InferenceBoundingBox¶
Parameters¶
index: uint16_t const
Returns the bounding box at specified index.
- param index:
Index of the bounding box to return.
- GetBoxCount(self) int16_t¶
Returns the number of bounding boxes.
- GetBoxSize(self) int8_t¶
Returns the number of bytes allocated for one bounding box.
- GetVersion(self) int8_t¶
Returns the bounding box format version number.
- class InferenceBoxCircle¶
Bases:
object- property centerXCoord¶
- property centerYCoord¶
- property radius¶
- class InferenceBoxRect¶
Bases:
objectInference Bounding Box Type Data Structures
- property bottomRightXCoord¶
- property bottomRightYCoord¶
- property topLeftXCoord¶
- property topLeftYCoord¶
- class InferenceBoxRotatedRect¶
Bases:
object- property bottomRightXCoord¶
- property bottomRightYCoord¶
- property rotationAngle¶
- property topLeftXCoord¶
- property topLeftYCoord¶
- class IntRegNode(*args, **kwargs)¶
Bases:
IntegerNode,RegisterNodeInterface for string properties.
- class IntegerNode(*args, **kwargs)¶
-
Interface for string properties.
- GetInc(self) int64_t¶
Get increment
- GetIncMode(self) Spinnaker::GenApi::EIncMode¶
Get increment mode
- GetListOfValidValues(self, bounded=True) int64_autovector_t¶
Parameters¶
bounded: bool
Get list of valid value
- GetMax(self) int64_t¶
Get maximum value allowed
- GetMin(self) int64_t¶
Get minimum value allowed
- GetRepresentation(self) Spinnaker::GenApi::ERepresentation¶
Get recommended representation
- GetValue(self, Verify=False, IgnoreCache=False) int64_t¶
Parameters¶
Verify: bool IgnoreCache: bool
Get node value
- param Verify:
Enables Range verification (default = false). The AccessMode is always checked
- param IgnoreCache:
If true the value is read ignoring any caches (default = false)
The value read
- IsValueUpdated(self) bool¶
Checks if the content of the node has changed since the value was last cached by IsValueUpdated() or GetValue().
true if the node value has changed, false otherwise.
- class InterfaceArrivalEventHandler¶
Bases:
IInterfaceArrivalEventHandlerAn event handler for capturing the interface arrival event. Note that only GEV interface arrivals are currently handled.
- class InterfaceEventHandler¶
Bases:
IInterfaceEventHandlerA handler to device arrival and removal events on all interfaces.
- class InterfaceList(*args)¶
Bases:
IInterfaceListA list of the available interfaces on the system.
- Add(self, iface)¶
Parameters¶
iface: Spinnaker::InterfacePtr
Adds a copy of an interface object.
- param iface:
An interface object to be added to this list.
- Append(self, list)¶
Parameters¶
list: Spinnaker::InterfaceList const *
Appends a copy of the interfact list.
- param list:
Another InterfaceList object, whose elements are added to this list.
- Clear(self)¶
Clears the list of interfaces and destroys their corresponding objects. It is important to first make sure there are no referenced cameras still in use before calling Clear(). If a camera on any of the interfaces is still in use this function will throw an exception.
- GetByIndex(self, index) InterfacePtr¶
Parameters¶
index: unsigned int
Returns a pointer to an Interface object at the “index”.
- param index:
The index at which to retrieve the Interface object
A pointer to an Interface object.
- GetByInterfaceID(self, interfaceID) InterfacePtr¶
Parameters¶
interfaceID: std::string
Returns a pointer to a interface object with the specified interface identifier. This function will return a NULL InterfacePtr if no matching interface identifier is found.
- param interfaceID:
The unique interface identifier of the interface object to retrieve
A pointer to an Interface object.
- GetSize(self) unsigned int¶
Returns the size of the interface list. The size is the number of Interface objects stored in the list.
An integer that represents the list size.
- Remove(self, iface)¶
Parameters¶
iface: Spinnaker::InterfacePtr
Removes all occurences of an interface that is pointed to by the input interface pointer and destroys its corresponding reference counted object. This function will throw a Spinnaker exception with SPINNAKER_ERR_NOT_AVAILABLEerror if no matching interface is found.
- param iface:
Pointer to the interface that is to be removed
- class InterfacePtr(*args)¶
Bases:
_SWIG_IFacePtrA reference tracked pointer to the interface object.
- class InterfaceRemovalEventHandler¶
Bases:
IInterfaceRemovalEventHandlerAn event handler for capturing the interface removal event. Note that only GEV interface removals are currently handled.
- class JPEGOption¶
Bases:
objectOptions for saving JPEG image.
- property progressive¶
- property quality¶
- property reserved¶
- class JPG2Option¶
Bases:
objectOptions for saving JPEG2000 image.
- property quality¶
- property reserved¶
- class LibraryVersion¶
Bases:
objectProvides easier access to the current version of Spinnaker.
- property build¶
- property major¶
- property minor¶
- property type¶
- class LoggingEventData(*args, **kwargs)¶
Bases:
objectThe LoggingEventData object.
- GetCategoryName(self) char const *¶
Gets the logging event category name.
The category name
- GetLogMessage(self) char const *¶
Gets the logging event message.
The log message
- GetNDC(self) char const *¶
Gets the logging event’s Nested Diagnostic Context (NDC).
The log event’s NDC
- GetPriority(self) int const¶
Gets the logging event priority.
The log priority
- GetPriorityName(self) char const *¶
Gets the logging event priority name.
The priority name of the log
- GetThreadName(self) char const *¶
Gets the logging event thread name.
The thread name
- GetTimestamp(self) char const *¶
Gets the logging event time stamp.
The time stamp of the log
- class LoggingEventDataPtr(*args)¶
Bases:
_SWIG_LogPtrA reference tracked pointer to the LoggingEvent object.
- class LoggingEventHandler¶
Bases:
ILoggingEventHandlerAn event handler for capturing the device logging event.
- class MJPGOption¶
Bases:
objectOptions for saving MJPG files.
- property frameRate¶
- property height¶
- property quality¶
- property reserved¶
- property width¶
- class Node(*args, **kwargs)¶
Bases:
INodeclass common to all nodes
- DeregisterCallback(self, hCallback) bool¶
Parameters¶
hCallback: Spinnaker::GenApi::CallbackHandleType
De register change callback Destroys CNodeCallback object true if the callback handle was valid
- GetAccessMode(self) Spinnaker::GenApi::EAccessMode¶
Base interface overrides.
Get the access mode of the node
- GetCachingMode(self) Spinnaker::GenApi::ECachingMode¶
Get Caching Mode
- GetCastAlias(self) INode¶
Retrieves the a node which describes the same feature so that it can be casted
- GetChildren(self, LinkType=ctReadingChildren)¶
Parameters¶
LinkType: enum Spinnaker::GenApi::ELinkType
Get all nodes this node directly depends on.
- param Children:
List of children nodes
- param LinkType:
The link type
- GetLockNodes(self)¶
Gets all nodes which can directly lock this node.
- Parameters:
LockNodes – List of lock nodes.
- GetNameSpace(self) Spinnaker::GenApi::ENameSpace¶
Get name space
- GetNodeHandle(self) std::shared_ptr< Spinnaker::GenApi::Node::NodeImpl >¶
Get Node handle
- GetParents(self)¶
Gets all nodes this node is directly depending on.
- Parameters:
Parents – List of parent nodes
- GetPollingTime(self) int64_t¶
recommended polling time (for not cacheable nodes)
- GetPrincipalInterfaceType(self) Spinnaker::GenApi::EInterfaceType¶
Get the type of the main interface of a node
- GetProperty(self, PropertyName, ValueStr, AttributeStr) bool¶
Parameters¶
PropertyName: Spinnaker::GenICam::gcstring const & ValueStr: Spinnaker::GenICam::gcstring & AttributeStr: Spinnaker::GenICam::gcstring &
Retrieves a property plus an additional attribute by name If a property has multiple values/attribute they come with Tabs as delimiters
- GetPropertyNames(self)¶
Returns a list of the names all properties set during initialization
- GetSelectedFeatures(self)¶
retrieve the group of selected features
- GetSelectingFeatures(self)¶
retrieve the group of features selecting this node
- GetVisibility(self) Spinnaker::GenApi::EVisibility¶
Get the recommended visibility of the node
- ImposeAccessMode(self, ImposedAccessMode)¶
Parameters¶
ImposedAccessMode: enum Spinnaker::GenApi::EAccessMode
Imposes an access mode to the natural access mode of the node
- ImposeVisibility(self, ImposedVisibility)¶
Parameters¶
ImposedVisibility: enum Spinnaker::GenApi::EVisibility
Imposes a visibility to the natural visibility of the node
- InvalidateNode(self)¶
Indicates that the node’s value may have changed. Fires the callback on this and all dependent nodes
- IsAccessModeCacheable(self) Spinnaker::GenApi::EYesNo¶
True if the AccessMode can be cached
- IsFeature(self) bool¶
True if the node can be reached via category nodes from a category node named “Root”
- IsSelector(self) bool¶
Selector interface overrides.
true if this feature selects a group of features
- RegisterCallback(self, pCallback) Spinnaker::GenApi::CallbackHandleType¶
Parameters¶
pCallback: Spinnaker::GenApi::CNodeCallback *
Register change callback Takes ownership of the CNodeCallback object
- class NodeMap(*args)¶
Bases:
INodeMap,IDeviceInfoSmart pointer template for NodeMaps with create function.
- Parameters:
TCameraParams – The camera specific parameter class (auto generated from camera xml file)
- Connect(self, pPort, PortName) bool¶
Parameters¶
pPort: IPort * PortName: Spinnaker::GenICam::gcstring const &
Connect(self, pPort) -> bool
Parameters¶
pPort: IPort *
Connects a port to the standard port “Device”
- Destroy(self)¶
Destroys the node map
- DisableAutoPoll(self)¶
Disable automatic polling to fire nodes at regular intervals.
- EnableAutoPoll(self, ElapsedTime)¶
Parameters¶
ElapsedTime: int64_t
Enable automatic polling to fire nodes at regular intervals based on the specified polling duration.
- GetDeviceVersion(self, Version)¶
Parameters¶
Version: Spinnaker::GenICam::Version_t &
Get the version of the device description file
- GetGenApiVersion(self, Version, Build)¶
Parameters¶
Version: Spinnaker::GenICam::Version_t & Build: uint16_t &
Get the version of the DLL’s GenApi implementation
- GetNode(self, key) INode¶
Parameters¶
key: Spinnaker::GenICam::gcstring const &
Retrieves the node from the central map by name
- GetNodeMapHandle(self) void *¶
- GetNodes(self)¶
Retrieves all nodes in the node map
- GetNumNodes(self) uint64_t¶
Get the number of nodes in the map
- GetSchemaVersion(self, Version)¶
Parameters¶
Version: Spinnaker::GenICam::Version_t &
Get the schema version number
- GetSupportedSchemaVersions(self)¶
Gets a list of supported schema versionsEach list entry is a string with the format “{Major}.{Minor}” were {Major} and {Minor} are integers Example: {“1.1”, “1.2”} indicates that the schema v1.1 and v1.2 are supported. The SubMinor version number is not given since it is for fully compatible bug fixes only
- InvalidateNodes(self)¶
Invalidates all nodes
- LoadXMLFromFile(self, FileName)¶
Parameters¶
FileName: Spinnaker::GenICam::gcstring
Creates the object from a XML file with given file name
- LoadXMLFromFileInject(self, TargetFileName, InjectFileName)¶
Parameters¶
TargetFileName: Spinnaker::GenICam::gcstring InjectFileName: Spinnaker::GenICam::gcstring
Creates the object from a XML target and an inject file with given file name
- LoadXMLFromString(self, XMLData)¶
Parameters¶
XMLData: Spinnaker::GenICam::gcstring const &
Creates the object from XML data given in a string
- LoadXMLFromStringInject(self, TargetXMLDataconst, InjectXMLData)¶
Parameters¶
TargetXMLDataconst: Spinnaker::GenICam::gcstring const & InjectXMLData: Spinnaker::GenICam::gcstring const &
Creates the object from XML data given in a string with injection
- LoadXMLFromZIPData(self, zipData, zipSize)¶
Parameters¶
zipData: void const * zipSize: size_t
Creates the object from a ZIP’d XML file given in a string
- class PGMOption¶
Bases:
objectOptions for saving PGM images.
- property binaryFile¶
- property reserved¶
- class PNGOption¶
Bases:
objectOptions for saving PNG images.
- property compressionLevel¶
- property interlaced¶
- property reserved¶
- class PPMOption¶
Bases:
objectOptions for saving PPM images.
- property binaryFile¶
- property reserved¶
- class PointCloud(*args)¶
Bases:
IPointCloudThe PointCloud object class.
- AddPoint(self, point)¶
Parameters¶
point: Spinnaker::Stereo3DPoint const
Adds a point to the point cloud.
- param point:
The point to be added.
- Clear(self)¶
Clears all points from the point cloud.
- GetNumPoints(self) size_t¶
Returns the number of points in the point cloud.
The number of points in the point cloud.
- GetPoint(self, index) Stereo3DPoint¶
Parameters¶
index: unsigned int const
Returns the Stereo3DPoint at the specified index.
Stereo3DPoint object
- GetPointCloudData(self) Spinnaker::IPointCloud::PointCloudData *¶
- LoadPointCloudFromPly(self, filename)¶
Parameters¶
filename: std::string const &
Loads a point cloud from a PLY file.
The function reads the file and parses the data into a vector of 3D points. The data is then stored in the class as a vector of Stereo3DPoint objects.
- param filename:
The path to the PLY file to be loaded.
- See:
SavePointCloudAsPly()
- PrintPoints(self, numPointsToPrint)¶
Parameters¶
numPointsToPrint: unsigned int
Prints a number of points from the point cloud to the console.
The function prints a number of points from the point cloud to the console. The number of points to print is specified by the user. The points are printed in the following format: x, y, z, r, g, b, i, j.
- param numPointsToPrint:
The number of points to print.
- SavePointCloudAsPly(self, arg0)¶
Parameters¶
arg0: std::string const &
Saves the point cloud to a PLY file.
The function writes the point cloud data to the specified file in PLY format. The data is written in the order of x, y, z, color (red, green, blue, alpha), image x, image y. The point cloud data is written as a binary file.
- param filename:
The path to the PLY file to be saved.
- See:
LoadPointCloudFromPly()
- class PointCloudParameters¶
Bases:
object- property ROIImageBottom¶
- property ROIImageLeft¶
- property ROIImageRight¶
- property ROIImageTop¶
- property ROIWorldCoordinatesXMax¶
- property ROIWorldCoordinatesXMin¶
- property ROIWorldCoordinatesYMax¶
- property ROIWorldCoordinatesYMin¶
- property ROIWorldCoordinatesZMax¶
- property ROIWorldCoordinatesZMin¶
- property decimationFactor¶
- class RegisterNode(*args, **kwargs)¶
-
Interface for string properties.
- Get(self, pBuffer, Length, Verify=False, IgnoreCache=False)¶
Parameters¶
pBuffer: uint8_t * Length: int64_t Verify: bool IgnoreCache: bool
Fills a buffer with the register’s contents
- param pBuffer:
The buffer receiving the data to read
- param Length:
The number of bytes to retrieve
- param Verify:
Enables Range verification (default = false). The AccessMode is always checked
- param IgnoreCache:
If true the value is read ignoring any caches (default = false)
The value read
- GetAddress(self) int64_t¶
Retrieves the Address of the register
- GetLength(self) int64_t¶
Retrieves the Length of the register [Bytes]
- class Scan3DParameters(*args)¶
Bases:
IScan3DParameters- FromStereoCameraParameters(self, params)¶
Parameters¶
params: Spinnaker::StereoCameraParameters const &
Populate Scan3D data from StereoCameraParameters struct. For backward compatibility with legacy stereo processing code.
- GetAllCoordinateParams(self) std::map< Spinnaker::Scan3dCoordinateSelectorEnums,Spinnaker::CoordinateDependentParams >¶
- GetAxisMax(self, coordinate=Scan3dCoordinateSelector_CoordinateC) float64_t¶
Parameters¶
coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums
- GetAxisMin(self, coordinate=Scan3dCoordinateSelector_CoordinateC) float64_t¶
Parameters¶
coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums
- GetBaseline(self) float64_t¶
Description: Displays the baseline in meters as the physical distance of two image sensors in the stereo camera. Visibility:
- GetCoordinateOffset(self, coordinate=Scan3dCoordinateSelector_CoordinateC) float64_t¶
Parameters¶
coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums
- GetCoordinateParams(self, coordinate=Scan3dCoordinateSelector_CoordinateC) CoordinateDependentParams¶
Parameters¶
coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums
- GetCoordinateReferenceSelector(self) Spinnaker::Scan3dCoordinateReferenceSelectorEnums¶
Description: Sets the index to read a coordinate system reference value defining the transform of a point from the current (Anchor or Transformed) system to the reference system. Visibility: Expert
- GetCoordinateReferenceValue(self) float64_t¶
Description: Returns the reference value selected. Reads the value of a rotation or translation value for the current (Anchor or Transformed) coordinate system transformation to the Reference system. Visibility: Expert
- GetCoordinateScale(self, coordinate=Scan3dCoordinateSelector_CoordinateC) float64_t¶
Parameters¶
coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums
- GetCoordinateSelector(self) Spinnaker::Scan3dCoordinateSelectorEnums¶
Description: Selects the individual coordinates in the vectors for 3D information/transformation. Visibility: Expert
- GetCoordinateSystem(self) Spinnaker::Scan3dCoordinateSystemEnums¶
Description: Specifies the Coordinate system to use for the device. Visibility: Expert
- GetCoordinateSystemReference(self) Spinnaker::Scan3dCoordinateSystemReferenceEnums¶
Description: Defines coordinate system reference location. Visibility: Expert
- GetCoordinateTransformSelector(self) Spinnaker::Scan3dCoordinateTransformSelectorEnums¶
Description: Sets the index to read/write a coordinate transform value. Visibility: Expert
- GetDistanceUnit(self) Spinnaker::Scan3dDistanceUnitEnums¶
Description: Specifies the unit used when delivering (calibrated) distance data. Visibility: Expert
- GetFocalLength(self) float64_t¶
Description: Displays the focal length of the camera in pixels. Visibility:
- GetInvalidDataFlag(self, coordinate=Scan3dCoordinateSelector_CoordinateC) bool¶
Parameters¶
coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums
- GetInvalidDataValue(self, coordinate=Scan3dCoordinateSelector_CoordinateC) float64_t¶
Parameters¶
coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums
- GetOutputMode(self) Spinnaker::Scan3dOutputModeEnums¶
Description: Controls the Calibration and data organization of the device and the coordinates transmitted. Visibility: Expert
- GetPrincipalPointU(self) float64_t¶
Description: Displays the value of the horizontal position of the principal point, relative to the region origin, i.e. OffsetX . Visibility:
- GetPrincipalPointV(self) float64_t¶
Description: Displays the value of the vertical position of the principal point, relative to the region origin, i.e. OffsetY. Visibility:
- GetTransformValue(self) float64_t¶
Description: Specifies the transform value selected. For translations (Scan3dCoordinateTransformSelector = TranslationX/Y/Z) it is expressed in the distance unit of the system, for rotations (Scan3dCoordinateTransformSelector =RotationX/Y/Z) in degrees. Visibility: Expert
- SetAllCoordinateParams(self, params)¶
Parameters¶
params: std::map< Spinnaker::Scan3dCoordinateSelectorEnums,Spinnaker::CoordinateDependentParams > const &
- SetAxisMax(self, value, coordinate=Scan3dCoordinateSelector_CoordinateC)¶
Parameters¶
value: float64_t coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums
- SetAxisMin(self, value, coordinate=Scan3dCoordinateSelector_CoordinateC)¶
Parameters¶
value: float64_t coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums
- SetBaseline(self, value)¶
Parameters¶
value: float64_t
Description: Displays the baseline in meters as the physical distance of two image sensors in the stereo camera. Visibility:
- SetCoordinateOffset(self, value, coordinate=Scan3dCoordinateSelector_CoordinateC)¶
Parameters¶
value: float64_t coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums
- SetCoordinateParams(self, params, coordinate=Scan3dCoordinateSelector_CoordinateC)¶
Parameters¶
params: Spinnaker::CoordinateDependentParams const & coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums
- SetCoordinateReferenceSelector(self, value)¶
Parameters¶
value: enum Spinnaker::Scan3dCoordinateReferenceSelectorEnums
Description: Sets the index to read a coordinate system reference value defining the transform of a point from the current (Anchor or Transformed) system to the reference system. Visibility: Expert
- SetCoordinateReferenceValue(self, value)¶
Parameters¶
value: float64_t
Description: Returns the reference value selected. Reads the value of a rotation or translation value for the current (Anchor or Transformed) coordinate system transformation to the Reference system. Visibility: Expert
- SetCoordinateScale(self, value, coordinate=Scan3dCoordinateSelector_CoordinateC)¶
Parameters¶
value: float64_t coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums
- SetCoordinateSelector(self, value)¶
Parameters¶
value: enum Spinnaker::Scan3dCoordinateSelectorEnums
Description: Selects the individual coordinates in the vectors for 3D information/transformation. Visibility: Expert
- SetCoordinateSystem(self, value)¶
Parameters¶
value: enum Spinnaker::Scan3dCoordinateSystemEnums
Description: Specifies the Coordinate system to use for the device. Visibility: Expert
- SetCoordinateSystemReference(self, value)¶
Parameters¶
value: enum Spinnaker::Scan3dCoordinateSystemReferenceEnums
Description: Defines coordinate system reference location. Visibility: Expert
- SetCoordinateTransformSelector(self, value)¶
Parameters¶
value: enum Spinnaker::Scan3dCoordinateTransformSelectorEnums
Description: Sets the index to read/write a coordinate transform value. Visibility: Expert
- SetDistanceUnit(self, value)¶
Parameters¶
value: enum Spinnaker::Scan3dDistanceUnitEnums
Description: Specifies the unit used when delivering (calibrated) distance data. Visibility: Expert
- SetFocalLength(self, value)¶
Parameters¶
value: float64_t
Description: Displays the focal length of the camera in pixels. Visibility:
- SetInvalidDataFlag(self, value, coordinate=Scan3dCoordinateSelector_CoordinateC)¶
Parameters¶
value: bool coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums
- SetInvalidDataValue(self, value, coordinate=Scan3dCoordinateSelector_CoordinateC)¶
Parameters¶
value: float64_t coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums
- SetOutputMode(self, value)¶
Parameters¶
value: enum Spinnaker::Scan3dOutputModeEnums
Description: Controls the Calibration and data organization of the device and the coordinates transmitted. Visibility: Expert
- SetPrincipalPointU(self, value)¶
Parameters¶
value: float64_t
Description: Displays the value of the horizontal position of the principal point, relative to the region origin, i.e. OffsetX . Visibility:
- SetPrincipalPointV(self, value)¶
Parameters¶
value: float64_t
Description: Displays the value of the vertical position of the principal point, relative to the region origin, i.e. OffsetY. Visibility:
- SetTransformValue(self, value)¶
Parameters¶
value: float64_t
Description: Specifies the transform value selected. For translations (Scan3dCoordinateTransformSelector = TranslationX/Y/Z) it is expressed in the distance unit of the system, for rotations (Scan3dCoordinateTransformSelector =RotationX/Y/Z) in degrees. Visibility: Expert
- ToStereoCameraParameters(self) StereoCameraParameters¶
Convert Scan3D data to StereoCameraParameters struct. For backward compatibility with legacy stereo processing code.
- class SpinVideo¶
Bases:
objectProvides the functionality for the user to record images to an AVI/MP4 file.
- Append(self, pImage)¶
Parameters¶
pImage: Spinnaker::ImagePtr
Append an image to the video file. When using the H264 encoder, several images are required to be appended before the encoder is able to output the first encoded frame.
- param pImage:
The image to append.
- Close(self)¶
Close the video file. This function will throw an exception when the H264 encoder was unable to output any encoded frames, in which case the output video should be considered invalid.
See: Open()
Append(ImagePtr pImage)
- Open(self, pFileName, pOption)¶
Parameters¶
pFileName: char const * pOption: Spinnaker::Video::AVIOption &
Open(self, pFileName, pOption)
Parameters¶
pFileName: char const * pOption: Spinnaker::Video::MJPGOption &
Open(self, pFileName, pOption)
Parameters¶
pFileName: char const * pOption: Spinnaker::Video::H264Option &
Open an H264 MP4 video file in preparation for writing Images to disk. The size of MP4 files is limited to 2GB. The filenames are automatically generated using the filename specified.
- param pFileName:
The filename of the MP4 video file.
- param pOption:
H264 options to apply to the MP4 video file.
- See:
Close()
H264Option
- SetMaximumFileSize(self, size)¶
Parameters¶
size: unsigned int
Set the maximum file size (in megabytes) of a AVI/MP4 file. A new video file is created automatically when file size limit is reached. Setting a maximum size of 0 indicates no limit on file size.
Note that this size serves only as a hint and can still be slightly exceeded in some cases after the video trailer is written.
- param size:
The maximum video file size in MB.
- See:
Append(ImagePtr pImage)
- class Stereo3DPoint¶
Bases:
object3D Point Structure
- property b¶
- property g¶
- property pixel¶
- property r¶
- property x¶
- property y¶
- property z¶
- class StereoCameraParameters¶
Bases:
object- property baseline¶
- property coordinateOffset¶
- property disparityScaleFactor¶
- property focalLength¶
- property invalidDataFlag¶
- property invalidDataValue¶
- property principalPointU¶
- property principalPointV¶
- property totalDisparity¶
- class StringNode(*args, **kwargs)¶
-
Interface for string properties.
- GetMaxLength(self) int64_t¶
Retrieves the maximum length of the string in bytes
- GetValue(self, Verify=False, IgnoreCache=False) gcstring¶
Parameters¶
Verify: bool IgnoreCache: bool
Get node value
- param Verify:
Enables Range verification (default = false). The AccessMode is always checked
- param IgnoreCache:
If true the value is read ignoring any caches (default = false)
The value read
- IsValueUpdated(self) bool¶
Checks if the content of the node has changed since the value was last cached by IsValueUpdated() or GetValue().
true if the node value has changed, false otherwise.
- class StringRegNode(*args, **kwargs)¶
Bases:
StringNode,RegisterNodeInterface for string properties.
- class System(*args, **kwargs)¶
Bases:
ISystemThe system object is used to retrieve the list of interfaces and cameras available.
- static GetInstance() SystemPtr¶
Return the singleton System instance, creating it on first call.
All cameras and interfaces are enumerated through this object. Call ReleaseInstance() when the application is done using the SDK.
- Returns:
The singleton System object.
- Return type:
- GetCameras(self, updateInterfaces=True, updateCameras=True) CameraList¶
Parameters¶
updateInterfaces: bool updateCameras: bool
Returns a list of cameras that are available on the system. This call returns both GigE Vision and Usb3 Vision cameras from all interfaces. The camera list object will reference count the cameras it returns. It is important that the camera list is destroyed or is cleared before calling system-> ReleaseInstance() or else the call to system-> ReleaseInstance() will result in an error message thrown that a reference to the camera is still held.
See: ReleaseInstance()
CameraList::Clear()
Args: updateInterfaces: Determines whether or not updateInterfaceList() is called before getting cameras from available interfaces on the system updateCameras: Determines whether or not UpdateCameras() is called before getting cameras from available interfaces on the system An CameraList object that contains a list of all cameras.
- GetInterfaces(self, updateInterface=True) InterfaceList¶
Parameters¶
updateInterface: bool
Returns a list of interfaces available on the system. This call returns GigE and Usb2 and Usb3 interfaces. Note that on MacOS only active GigE interfaces will be stored in the returned InterfaceList.
See: UpdateInterfaceList()
Args: updateInterface: Determines whether or not UpdateInterfaceList() is called before getting available interfaces An InterfaceList object that contains a list of all interfaces.
- GetLibraryVersion(self) LibraryVersion¶
Get current library version of Spinnaker.
A struct containing the current version of Spinnaker (major, minor, type, build).
- GetLoggingEventPriorityLevel(self) Spinnaker::SpinnakerLogLevel¶
Retrieves the current logging event priority level.
Spinnaker uses multiple levels of logging: Fatal - failures that are non-recoverable without user intervention.
Error - failures that may or may not be recoverable without user intervention (use case dependent).
Warning - failures that are recoverable without user intervention.
Notice - information about events such as camera arrival and removal, initialization and deinitialization, starting and stopping image acquisition, and feature modification.
Info - information about recurring events that are generated regularly such as information on individual images.
Debug - information that can be used to troubleshoot the system.
See: SpinnakerLogLevel
Level The threshold level
- GetProducers(self, updateProducers=True) ProducerList¶
Parameters¶
updateProducers: bool
Returns a list of producers available on the system. See: UpdateProducers()
Args: updateProducers: Determines whether or not UpdateProducers() is called before getting available producers An ProducerList object that contains a list of all producers.
- GetTLNodeMap(self) INodeMap¶
Gets a reference to the Spinnaker Producer node map. The system must be initialized by a call to System::GetInstance() first before a node map reference can be successfully acquired.
A reference to the Spinnaker Producer INodeMap.
- IsInUse(self) bool¶
Checks if the system is in use by any interface or camera objects.
Returns true if the system is in use and false otherwise.
- RegisterEventHandler(self, evtHandlerToRegister, updateInterface=False)¶
Parameters¶
evtHandlerToRegister: Spinnaker::EventHandler & updateInterface: bool
Registers an event handler for the system
See: SystemEventHandler
InterfaceEventHandler
Args: evtHandlerToRegister: The event handler to register for the system updateInterface: Determines whether or not UpdateInterfaceList() is called before registering event for available interfaces on the system
- RegisterLoggingEventHandler(self, handler)¶
Parameters¶
handler: Spinnaker::LoggingEventHandler &
Registers a logging event.
See: LoggingEventHandler
Args: handler: The logging event handler to register
- ReleaseInstance(self)¶
This call releases the referenced instance of the System Singleton. After successfully releasing the System instance, the pointer returned by GetInstance() will be invalid. Once the final System instance is released, all remaining Spinnaker resources will be released. If the final System instance is released while an interface or camera reference is still held, this function will throw an error of type SPINNAKER_ERR_RESOURCE_IN_USE.
See: Error
GetInstance()
- SendActionCommand(self, deviceKey, groupKey, groupMask, actionTime=0, requestAck=False, pResultSize=None, results=0)¶
Parameters¶
deviceKey: unsigned int groupKey: unsigned int groupMask: unsigned int actionTime: unsigned long long requestAck: bool pResultSize: unsigned int * results: Spinnaker::ActionCommandResult []
Broadcast an Action Command to all devices on system
- param deviceKey:
The Action Command’s device key
- param groupKey:
The Action Command’s group key
- param groupMask:
The Action Command’s group mask
- param actionTime:
(Optional) Time when to assert a future action. Zero means immediate action.
- param pResultSize:
(Optional) The number of results in the results array. The value passed should be equal to the expected number of devices that acknowledge the command. Returns the number of received results. If this parameter is 0 or NULL, the function will return as soon as the command has been broadcasted.
- param results:
(Optional) An Array with *pResultSize elements to hold the action command result status. The buffer is filled starting from index 0. If received results are less than expected number of devices that acknowledge the command, remaining results are not changed. If received results are more than expected number of devices that acknowledge the command, extra results are ignored and not appended to array. This parameter is ignored if pResultSize is 0. Thus this parameter can be NULL if pResultSize is 0 or NULL.
- SetLoggingEventPriorityLevel(self, level)¶
Parameters¶
level: enum Spinnaker::SpinnakerLogLevel
Sets a threshold priority level for logging event. Logging events below such level will not trigger callbacks.
Spinnaker uses multiple levels of logging: Fatal - failures that are non-recoverable without user intervention.
Error - failures that may or may not be recoverable without user intervention (use case dependent).
Warning - failures that are recoverable without user intervention.
Notice - information about events such as camera arrival and removal, initialization and deinitialization, starting and stopping image acquisition, and feature modification.
Info - information about recurring events that are generated regularly such as information on individual images.
Debug - information that can be used to troubleshoot the system.
See: SpinnakerLogLevel
Args: level: The threshold level
- UnregisterAllLoggingEventHandlers(self)¶
Unregisters all previously registered logging events.
- UnregisterEventHandler(self, evtHandlerToUnregister)¶
Parameters¶
evtHandlerToUnregister: Spinnaker::EventHandler &
Unregisters an event handler for the system
See: SystemEventHandler
InterfaceEventHandler
Args: evtHandlerToUnregister: The event handler to unregister from the system
- UnregisterLoggingEventHandler(self, handler)¶
Parameters¶
handler: Spinnaker::LoggingEventHandler &
Unregisters a logging event.
See: LoggingEventHandler
Args: handler: The logging event handler to unregister
- UpdateCameras(self, updateInterfaces=True) bool¶
Parameters¶
updateInterfaces: bool
Updates the list of cameras on the system. Note that System::GetCameras() internally calls UpdateCameras() for each interface it enumerates. If the list changed between this call and the last time UpdateCameras was called then the return value will be true, otherwise it is false.
See: GetCameras()
Args: updateInterfaces: Determines whether or not UpdateInterfaceList() is called before updating cameras for available interfaces on the system True if cameras changed on interface and false otherwise.
- UpdateInterfaceList(self)¶
Updates the list of interfaces on the system. If desired, local copies of InterfaceList should be updated by calling GetInterfaces.
See: GetInterfaces()
- UpdateProducers(self, ctiPath='') bool¶
Parameters¶
ctiPath: Spinnaker::GenICam::gcstring
Updates the list of GenICam producers discoverable by the system given a producer library path. Only producers with the “cti” extension representing “Common Transport Interface” will be loaded. Spinnaker GenTL producer will be loaded by default.
Please see section “Working with GenICam GenTL Devices” in the Spinnaker C++ API Documentation for more information on GenTL producers.
Note: Only the Teledyne CoaXPress producer is supported at this time.
Producer loading will behave as follows: System loads all third party CTIs found in GENICAM_GENTL path when an empty path is provided
System loads a specific producer when the full path to producer is provided
System loads a specific producer based on GENICAM_GENTL paths when only the CTI file name is provided
- param ctiPath:
The CTI file name or full path including the CTI file name to load in the system
True if new producers have loaded and false otherwise.
- class SystemEventHandler¶
Bases:
ISystemEventHandlerA handler to interface arrival and removal events on the system. Note that only GEV interface arrivals and removals are currently handled.
- class SystemPtr(*args)¶
Bases:
_SWIG_SysPtrA reference tracked pointer to a system object.
- class TIFFOption¶
Bases:
objectOptions for saving TIFF images.
- property compression¶
- property reserved¶
- class TransportLayerDevice(nodeMapTLDevice)¶
Bases:
objectPart of the QuickSpin API to provide access to camera information without having to first initialize the camera.
- property DeviceAccessStatus¶
- property DeviceBootloaderVersion¶
- property DeviceCurrentSpeed¶
- property DeviceDisplayName¶
- property DeviceDriverVersion¶
- property DeviceEndianessMechanism¶
- property DeviceID¶
- property DeviceInstanceId¶
- property DeviceIsUpdater¶
- property DeviceLinkSpeed¶
- property DeviceLocation¶
- property DeviceModelName¶
- property DeviceMulticastMonitorMode¶
- property DevicePortId¶
- property DeviceReset¶
- property DeviceSerialNumber¶
- property DeviceType¶
- property DeviceU3VProtocol¶
- property DeviceUserID¶
- property DeviceVendorName¶
- property DeviceVersion¶
- property GUIXMLLocation¶
- property GUIXMLPath¶
- property GenICamXMLLocation¶
- property GenICamXMLPath¶
- property GevCCP¶
- property GevDeviceAutoForceIP¶
- property GevDeviceDiscoverMaximumPacketSize¶
- property GevDeviceForceGateway¶
- property GevDeviceForceIP¶
- property GevDeviceForceIPAddress¶
- property GevDeviceForceSubnetMask¶
- property GevDeviceGateway¶
- property GevDeviceIPAddress¶
- property GevDeviceIsWrongSubnet¶
- property GevDeviceMACAddress¶
- property GevDeviceMaximumPacketSize¶
- property GevDeviceMaximumRetryCount¶
- property GevDeviceModeIsBigEndian¶
- property GevDevicePort¶
- property GevDeviceReadAndWriteTimeout¶
- property GevDeviceSubnetMask¶
- property GevVersionMajor¶
- property GevVersionMinor¶
- property StreamID¶
- property StreamSelector¶
- class TransportLayerInterface(nodeMapTLDevice)¶
Bases:
objectPart of the QuickSpin API to provide access to camera information without having to first initialize the camera.
- property ActionCommand¶
- property CPUAffinityEnable¶
- property CpuAffinityPrivilege¶
- property DeviceAccessStatus¶
- property DeviceCount¶
- property DeviceID¶
- property DeviceModelName¶
- property DeviceSelector¶
- property DeviceSerialNumber¶
- property DeviceUnlock¶
- property DeviceUpdateList¶
- property DeviceVendorName¶
- property FLIRFilterDriverStatus¶
- property GevActionAckRequired¶
- property GevActionDeviceKey¶
- property GevActionGroupKey¶
- property GevActionGroupMask¶
- property GevActionTime¶
- property GevDeviceAutoForceIP¶
- property GevDeviceDisableDiscovery¶
- property GevDeviceDiscoveryEnabled¶
- property GevDeviceEnableDiscovery¶
- property GevDeviceForceGateway¶
- property GevDeviceForceIP¶
- property GevDeviceForceIPAddress¶
- property GevDeviceForceSubnetMask¶
- property GevDeviceGateway¶
- property GevDeviceIPAddress¶
- property GevDeviceMACAddress¶
- property GevDeviceSubnetMask¶
- property GevInterfaceGateway¶
- property GevInterfaceGatewaySelector¶
- property GevInterfaceIsIPConflict¶
- property GevInterfaceMACAddress¶
- property GevInterfaceMTU¶
- property GevInterfaceReceiveLinkSpeed¶
- property GevInterfaceSubnetIPAddress¶
- property GevInterfaceSubnetMask¶
- property GevInterfaceSubnetSelector¶
- property GevInterfaceTransmitLinkSpeed¶
- property HostAdapterDriverVersion¶
- property HostAdapterName¶
- property HostAdapterVendor¶
- property IncompatibleDeviceCount¶
- property IncompatibleDeviceID¶
- property IncompatibleDeviceModelName¶
- property IncompatibleDeviceSelector¶
- property IncompatibleDeviceVendorName¶
- property IncompatibleGevDeviceIPAddress¶
- property IncompatibleGevDeviceMACAddress¶
- property IncompatibleGevDeviceSubnetMask¶
- property InterfaceDisplayName¶
- property InterfaceID¶
- property InterfaceType¶
- property POEStatus¶
- property ReceiveSideScalingReservedCores¶
- property ReceiveSideScalingReservedCoresCount¶
- property TeledyneGigeVisionFilterDriverStatus¶
- class TransportLayerStream(nodeMapTLDevice)¶
Bases:
objectPart of the QuickSpin API to provide access to camera information without having to first initialize the camera.
- property StreamAnnounceBufferMinimum¶
- property StreamAnnouncedBufferCount¶
- property StreamBlockTransferSize¶
- property StreamBufferAlignment¶
- property StreamBufferCountManual¶
- property StreamBufferCountMax¶
- property StreamBufferCountMode¶
- property StreamBufferCountResult¶
- property StreamBufferHandlingMode¶
- property StreamCRCCheckEnable¶
- property StreamChunkCountMaximum¶
- property StreamDeliveredFrameCount¶
- property StreamDroppedFrameCount¶
- property StreamFrameProcessingTimeLast¶
- property StreamFrameProcessingTimeMax¶
- property StreamFrameProcessingTimeMin¶
- property StreamFrameReceptionTimeLast¶
- property StreamFrameReceptionTimeMax¶
- property StreamFrameReceptionTimeMin¶
- property StreamID¶
- property StreamIncompleteFrameCount¶
- property StreamIncompleteFramePacketsMissingThresholdOverrunCount¶
- property StreamIncompleteFramePayloadProcessingFailedCount¶
- property StreamIncompleteFramePayloadTypeNotSupportedCount¶
- property StreamIncompleteFrameResendRequestQueueOverrunCount¶
- property StreamIncompleteFrameResendRequestsThresholdOverrunCount¶
- property StreamIncompleteFrameTimeoutCount¶
- property StreamIncompleteFrameTransferQueueOverrunCount¶
- property StreamInputBufferCount¶
- property StreamIsGrabbing¶
- property StreamLogMessagesEnable¶
- property StreamLostFrameCount¶
- property StreamLostFrameReceptionQueueOverrunCount¶
- property StreamLostFrameReceptionStorageOverrunCount¶
- property StreamLostFrameTrashedCount¶
- property StreamLostFrameUserMessageQueueOverrunCount¶
- property StreamMissedPacketCount¶
- property StreamMode¶
- property StreamOutputBufferCount¶
- property StreamPacketResendEnable¶
- property StreamPacketResendMaxRequests¶
- property StreamPacketResendReceivedPacketCount¶
- property StreamPacketResendRequestCount¶
- property StreamPacketResendRequestTimeoutCount¶
- property StreamPacketResendRequestedPacketCount¶
- property StreamPacketResendTimeout¶
- property StreamPacketsDuplicatedCount¶
- property StreamPacketsNotYetAvailableCount¶
- property StreamPacketsPerFrameCount¶
- property StreamPacketsRejectedCount¶
- property StreamPacketsTimeoutCount¶
- property StreamReceivedFrameCount¶
- property StreamReceivedPacketCount¶
- property StreamResetCounters¶
- property StreamStartedFrameCount¶
- property StreamType¶
- class TransportLayerSystem(nodeMapTLDevice)¶
Bases:
objectPart of the QuickSpin API to provide access to camera information without having to first initialize the camera.
- property CpuAffinityAvailableCores¶
- property CpuAffinityPrivilege¶
- property CpuAffinityServiceStart¶
- property CpuAffinityServiceStatus¶
- property CpuAffinityServiceStop¶
- property EnumerateGEVInterfaces¶
- property EnumerateGen2Cameras¶
- property EnumerateUSBInterfaces¶
- property GEVAutoAssignIPEnable¶
- property GenTLSFNCVersionMajor¶
- property GenTLSFNCVersionMinor¶
- property GenTLSFNCVersionSubMinor¶
- property GenTLVersionMajor¶
- property GenTLVersionMinor¶
- property GevInterfaceDefaultGateway¶
- property GevInterfaceDefaultIPAddress¶
- property GevInterfaceDefaultSubnetMask¶
- property GevInterfaceMACAddress¶
- property GevVersionMajor¶
- property GevVersionMinor¶
- property InterfaceDisplayName¶
- property InterfaceID¶
- property InterfaceSelector¶
- property InterfaceUpdateList¶
- property MediaOptimizationEnable¶
- property MediaOptimizationPrivilege¶
- property TLDisplayName¶
- property TLFileName¶
- property TLID¶
- property TLModelName¶
- property TLPath¶
- property TLType¶
- property TLVendorName¶
- property TLVersion¶
- class ValueNode(*args, **kwargs)¶
-
Interface for value properties.
- FromString(self, ValueStr, Verify=True)¶
Parameters¶
ValueStr: Spinnaker::GenICam::gcstring const & Verify: bool
Set content of the node as string
- param ValueStr:
The value to set
- param Verify:
Enables AccessMode and Range verification (default = true)
- IsValueCacheValid(self) bool¶
Checks if the value comes from cache or is requested from another node
- IsValueUpdated(self) bool¶
Checks if the value has changed since the last GetValue(). Returns true if GetValue() is unavailable.
true if the node value has changed, false otherwise.
- SetReference(self, pBase)¶
Parameters¶
pBase: Spinnaker::GenApi::INode *
overload SetReference for Value
- ToString(self, Verify=False, IgnoreCache=False) gcstring¶
Parameters¶
Verify: bool IgnoreCache: bool
Get content of the node as string
- param Verify:
Enables Range verification (default = false). The AccessMode is always checked
- param IgnoreCache:
If true the value is read ignoring any caches (default = false)
The value read
- class double_autovector_t(*args)¶
Bases:
objectVector of doubles with reference counting.
- size(self) size_t¶
- class gcstring(*args)¶
Bases:
object- append(self, str) gcstring¶
Parameters¶
str: Spinnaker::GenICam::gcstring const &
append(self, count, ch) -> gcstring
Parameters¶
count: size_t ch: char
- assign(self, str) gcstring¶
Parameters¶
str: Spinnaker::GenICam::gcstring const &
assign(self, count, ch) -> gcstring
Parameters¶
count: size_t ch: char
assign(self, pc) -> gcstring
Parameters¶
pc: char const *
assign(self, pc, n) -> gcstring
Parameters¶
pc: char const * n: size_t
- c_str(self) char const *¶
- find(self, ch, offset=0) size_t¶
Parameters¶
ch: char offset: size_t
find(self, str, offset=0) -> size_t
Parameters¶
str: Spinnaker::GenICam::gcstring const & offset: size_t
find(self, str, offset, count) -> size_t
Parameters¶
str: Spinnaker::GenICam::gcstring const & offset: size_t count: size_t
find(self, pc, offset=0) -> size_t
Parameters¶
pc: char const * offset: size_t
find(self, pc, offset, count) -> size_t
Parameters¶
pc: char const * offset: size_t count: size_t
- find_first_not_of(self, str, offset=0) size_t¶
Parameters¶
str: Spinnaker::GenICam::gcstring const & offset: size_t
- find_first_of(self, str, offset=0) size_t¶
Parameters¶
str: Spinnaker::GenICam::gcstring const & offset: size_t
- length(self) size_t¶
- max_size(self) size_t¶
- size(self) size_t¶
- npos = 18446744073709551615¶
- class int64_autovector_t(*args)¶
Bases:
objectVector of integers with reference counting.
- size(self) size_t¶
- class node_vector(*args)¶
Bases:
objectProxy of C++ Spinnaker::GenApi::node_vector class.
- at(self, uiIndex) INode¶
Parameters¶
uiIndex: size_t
at(self, uiIndex) -> INode
Parameters¶
uiIndex: size_t
- begin(self) Spinnaker::GenApi::node_vector::iterator¶
- begin(self) Spinnaker::GenApi::node_vector::const_iterator
- capacity(self) size_t¶
- clear(self)¶
- end(self) Spinnaker::GenApi::node_vector::iterator¶
- end(self) Spinnaker::GenApi::node_vector::const_iterator
- erase(self, pos) Spinnaker::GenApi::node_vector::iterator¶
Parameters¶
pos: Spinnaker::GenApi::node_vector::iterator
erase(self, uiIndex)
Parameters¶
uiIndex: size_t
- insert(self, pos, val) Spinnaker::GenApi::node_vector::iterator¶
Parameters¶
pos: Spinnaker::GenApi::node_vector::iterator val: Spinnaker::GenApi::node_vector::T const &
insert(self, uiIndex, val)
Parameters¶
uiIndex: size_t val: Spinnaker::GenApi::node_vector::T const &
- max_size(self) size_t¶
- pop_back(self)¶
- size(self) size_t¶
- class value_vector(*args)¶
Bases:
objectProxy of C++ Spinnaker::GenApi::value_vector class.
- at(self, uiIndex) IValue¶
Parameters¶
uiIndex: size_t
at(self, uiIndex) -> IValue
Parameters¶
uiIndex: size_t
- begin(self) Spinnaker::GenApi::value_vector::iterator¶
- begin(self) Spinnaker::GenApi::value_vector::const_iterator
- capacity(self) size_t¶
- clear(self)¶
- end(self) Spinnaker::GenApi::value_vector::iterator¶
- end(self) Spinnaker::GenApi::value_vector::const_iterator
- erase(self, pos) Spinnaker::GenApi::value_vector::iterator¶
Parameters¶
pos: Spinnaker::GenApi::value_vector::iterator
erase(self, uiIndex)
Parameters¶
uiIndex: size_t
- insert(self, pos, val) Spinnaker::GenApi::value_vector::iterator¶
Parameters¶
pos: Spinnaker::GenApi::value_vector::iterator val: Spinnaker::GenApi::value_vector::T const &
insert(self, uiIndex, val)
Parameters¶
uiIndex: size_t val: Spinnaker::GenApi::value_vector::T const &
- max_size(self) size_t¶
- pop_back(self)¶
- resize(self, uiSize, val)¶
Parameters¶
uiSize: size_t val: Spinnaker::GenApi::value_vector::T const &
- size(self) size_t¶
- Combine(Peter, Paul) Spinnaker::GenApi::EAccessMode¶
Parameters¶
Peter: enum Spinnaker::GenApi::EAccessMode Paul: enum Spinnaker::GenApi::EAccessMode
Combine(Peter, Paul) -> Spinnaker::GenApi::EVisibility
Parameters¶
Peter: enum Spinnaker::GenApi::EVisibility Paul: enum Spinnaker::GenApi::EVisibility
Combine(Peter, Paul) -> Spinnaker::GenApi::ECachingMode
Parameters¶
Peter: enum Spinnaker::GenApi::ECachingMode Paul: enum Spinnaker::GenApi::ECachingMode
Computes which CachingMode results from a combination
- DoesEnvironmentVariableExist(VariableName) bool¶
Parameters¶
VariableName: Spinnaker::GenICam::gcstring const &
Returns true if an environment variable exists
- EatComments(_is) std::istream &¶
Parameters¶
is: std::istream &
Helper function ignoring lines starting with comment character ‘#’.
- GetErrorMessage() char const *¶
- GetFiles(FileTemplate, DirectoriesOnly=False)¶
Parameters¶
FileTemplate: Spinnaker::GenICam::gcstring const & DirectoriesOnly: bool const
Gets a list of files or directories matching a given FileTemplate
- GetGenICamCLProtocolFolder() gcstring¶
Retrieve the path of the CLProtocol folder The path to the CLProtocol folder can be stored by calling SetGenICamCLProtocolFolder(). If GetGenICamCLProtocolFolder() is called before SetGenICamCLProtocolFolder(), it will return the value of environment variable GENICAM_CLPROTOCOL. If this environment variable does not exist, an exception will be thrown.
- GetGenICamCacheFolder() gcstring¶
Retrieve the path of the GenICam cache folder The path to the cache folder can be stored by calling SetGenICamCacheFolder(). If GetGenICamCacheFolder() is called before SetGenICamCacheFolder(), it will return the value of environment variable GENICAM_CACHE_Vx_y. If this environment variable does not exist, an exception will be thrown.
- GetGenICamLogConfig() gcstring¶
Retrieve the path of the GenICam logging properties file
The path to the logging properties file can be stored by calling SetGenICamLogConfig(). If GetGenICamLogConfig() is called before SetGenICamLogConfig(), it will return the value of environment variable GENICAM_LOG_CONFIG_Vx_y. If this environment variable does not exist, an exception will be thrown.
- GetInterfaceName(pBase) gcstring¶
Parameters¶
pBase: Spinnaker::GenApi::IBase *
Returns the name of the main interface as string DEPRICATED, use IBase::GetPrincipalInterfaceType() instead
- GetModulePathFromFunction(pFunction) gcstring¶
Parameters¶
pFunction: void *
true = only subdirectories (ex . and ..) are retrieved; false = only files are retrieved
Gets the full path to the module (DLL/SO) containing the given pFunction; empty string if not found.
- GetValueOfEnvironmentVariable(VariableName) gcstring¶
Parameters¶
VariableName: Spinnaker::GenICam::gcstring const &
GetValueOfEnvironmentVariable(VariableName, VariableContent) -> bool
Parameters¶
VariableName: Spinnaker::GenICam::gcstring const & VariableContent: Spinnaker::GenICam::gcstring &
Retrieve the value of an environment variable true if environment variable was found, otherwise false
- IsAvailable(AccessMode) bool¶
Parameters¶
AccessMode: enum Spinnaker::GenApi::EAccessMode
IsAvailable(p) -> bool
Parameters¶
p: Spinnaker::GenApi::IBase const *
IsAvailable(r) -> bool
Parameters¶
r: Spinnaker::GenApi::IBase const &
IsAvailable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IBase,Spinnaker::GenApi::IBase > const &
IsAvailable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::INode,Spinnaker::GenApi::IBase > const &
IsAvailable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IValue,Spinnaker::GenApi::IBase > const &
IsAvailable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::ICategory,Spinnaker::GenApi::IBase > const &
IsAvailable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IBoolean,Spinnaker::GenApi::IBase > const &
IsAvailable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IInteger,Spinnaker::GenApi::IBase > const &
IsAvailable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IString,Spinnaker::GenApi::IBase > const &
IsAvailable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IRegister,Spinnaker::GenApi::IBase > const &
IsAvailable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IEnumeration,Spinnaker::GenApi::IBase > const &
IsAvailable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IEnumEntry,Spinnaker::GenApi::IBase > const &
IsAvailable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::ISelector,Spinnaker::GenApi::IBase > const &
IsAvailable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::ICommand,Spinnaker::GenApi::IBase > const &
IsAvailable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IFloat,Spinnaker::GenApi::IBase > const &
Checks if a node is Available
- IsCacheable(CachingMode) bool¶
Parameters¶
CachingMode: enum Spinnaker::GenApi::ECachingMode
Tests Cacheability
- IsImplemented(AccessMode) bool¶
Parameters¶
AccessMode: enum Spinnaker::GenApi::EAccessMode
IsImplemented(p) -> bool
Parameters¶
p: Spinnaker::GenApi::IBase const *
IsImplemented(r) -> bool
Parameters¶
r: Spinnaker::GenApi::IBase const &
IsImplemented(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IBase,Spinnaker::GenApi::IBase > const &
IsImplemented(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::INode,Spinnaker::GenApi::IBase > const &
IsImplemented(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IValue,Spinnaker::GenApi::IBase > const &
IsImplemented(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::ICategory,Spinnaker::GenApi::IBase > const &
IsImplemented(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IBoolean,Spinnaker::GenApi::IBase > const &
IsImplemented(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IInteger,Spinnaker::GenApi::IBase > const &
IsImplemented(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IString,Spinnaker::GenApi::IBase > const &
IsImplemented(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IRegister,Spinnaker::GenApi::IBase > const &
IsImplemented(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IEnumeration,Spinnaker::GenApi::IBase > const &
IsImplemented(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IEnumEntry,Spinnaker::GenApi::IBase > const &
IsImplemented(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::ISelector,Spinnaker::GenApi::IBase > const &
IsImplemented(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::ICommand,Spinnaker::GenApi::IBase > const &
IsImplemented(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IFloat,Spinnaker::GenApi::IBase > const &
Checks if a node is Implemented
- IsReadable(AccessMode) bool¶
Parameters¶
AccessMode: enum Spinnaker::GenApi::EAccessMode
IsReadable(p) -> bool
Parameters¶
p: Spinnaker::GenApi::IBase const *
IsReadable(r) -> bool
Parameters¶
r: Spinnaker::GenApi::IBase const &
IsReadable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IBase,Spinnaker::GenApi::IBase > const &
IsReadable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::INode,Spinnaker::GenApi::IBase > const &
IsReadable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IValue,Spinnaker::GenApi::IBase > const &
IsReadable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::ICategory,Spinnaker::GenApi::IBase > const &
IsReadable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IBoolean,Spinnaker::GenApi::IBase > const &
IsReadable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IInteger,Spinnaker::GenApi::IBase > const &
IsReadable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IString,Spinnaker::GenApi::IBase > const &
IsReadable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IRegister,Spinnaker::GenApi::IBase > const &
IsReadable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IEnumeration,Spinnaker::GenApi::IBase > const &
IsReadable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IEnumEntry,Spinnaker::GenApi::IBase > const &
IsReadable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::ISelector,Spinnaker::GenApi::IBase > const &
IsReadable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::ICommand,Spinnaker::GenApi::IBase > const &
IsReadable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IFloat,Spinnaker::GenApi::IBase > const &
Checks if a node is readable
- IsVisible(Visibility, MaxVisiblity) bool¶
Parameters¶
Visibility: enum Spinnaker::GenApi::EVisibility MaxVisiblity: enum Spinnaker::GenApi::EVisibility
Tests Visibility CAVE : this relies on the EVisibility enum’s coding
- IsWritable(AccessMode) bool¶
Parameters¶
AccessMode: enum Spinnaker::GenApi::EAccessMode
IsWritable(p) -> bool
Parameters¶
p: Spinnaker::GenApi::IBase const *
IsWritable(r) -> bool
Parameters¶
r: Spinnaker::GenApi::IBase const &
IsWritable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IBase,Spinnaker::GenApi::IBase > const &
IsWritable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::INode,Spinnaker::GenApi::IBase > const &
IsWritable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IValue,Spinnaker::GenApi::IBase > const &
IsWritable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::ICategory,Spinnaker::GenApi::IBase > const &
IsWritable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IBoolean,Spinnaker::GenApi::IBase > const &
IsWritable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IInteger,Spinnaker::GenApi::IBase > const &
IsWritable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IString,Spinnaker::GenApi::IBase > const &
IsWritable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IRegister,Spinnaker::GenApi::IBase > const &
IsWritable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IEnumeration,Spinnaker::GenApi::IBase > const &
IsWritable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IEnumEntry,Spinnaker::GenApi::IBase > const &
IsWritable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::ISelector,Spinnaker::GenApi::IBase > const &
IsWritable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::ICommand,Spinnaker::GenApi::IBase > const &
IsWritable(ptr) -> bool
Parameters¶
ptr: Spinnaker::GenApi::CPointer< Spinnaker::GenApi::IFloat,Spinnaker::GenApi::IBase > const &
Checks if a node is Writable
- RegisterNodeCallback(pNode, f, CallbackType=Spinnaker::GenApi::cbPostInsideLock, fireOnValueChangedOnly=False)¶
Parameters¶
pNode: Spinnaker::GenApi::INode * f: NodeCallback & CallbackType: Spinnaker::GenApi::ECallbackType fireOnValueChangedOnly: bool
- RegisterNodeCallbackEx(pNode, f, CallbackType, fireOnValueChangedOnly)¶
Parameters¶
pNode: Spinnaker::GenApi::INode * f: NodeCallback & CallbackType: Spinnaker::GenApi::ECallbackType fireOnValueChangedOnly: bool
- ReplaceEnvironmentVariables(Buffer, ReplaceBlankBy20=False)¶
Parameters¶
Buffer: Spinnaker::GenICam::gcstring & ReplaceBlankBy20: bool
Replaces in a string and replace ‘ ‘ with %20
- SetGenICamCLProtocolFolder(path)¶
Parameters¶
path: Spinnaker::GenICam::gcstring const &
Stores the path of the CLProtocol folder
- SetGenICamCacheFolder(path)¶
Parameters¶
path: Spinnaker::GenICam::gcstring const &
Stores the path of the GenICam cache folder
- SetGenICamLogConfig(path)¶
Parameters¶
path: Spinnaker::GenICam::gcstring const &
Stores the path of the GenICam logging properties file
- SetMessageCallback(cb)¶
Adds a callback to the updator to handle messages from the updator. Only gets called if the -P switch is present in the arguments passed to UpdateFirmware[Console]!
- Parameters:
cb – Function to use as callback; this function must take exactly 1 argument.
- SetProgressCallback(cb)¶
Adds a callback to the updator to represent update progress. Only gets called if the -P switch is present in the arguments passed to UpdateFirmware[Console]!
- Parameters:
cb – Function to use as callback; this function must take exactly 4 arguments.
- SpinUpdate_SetMsgCallback(messageCallbackFunction)¶
Parameters¶
messageCallbackFunction: SpinUpdate::UpdatorMessageCallback
- SpinUpdate_SetProgCallback(progressCallbackFunction)¶
Parameters¶
progressCallbackFunction: SpinUpdate::UpdatorProgressCallback
- ThrowBadAlloc()¶
- Tokenize(str, delimiters=' ')¶
Parameters¶
str: Spinnaker::GenICam::gcstring const & delimiters: Spinnaker::GenICam::gcstring const &
splits str input string into a list of tokens using the delimiter
- UpdateFirmwareConsole(numArgs) int¶
Parameters¶
numArgs: unsigned int
Updates the firmware for the device.
- param numArgs:
Number of strings pointed to by argv
- param argList:
Pointer to list of string options for the firmware update
- 0 for success, otherwise non zero for failures.
Typical usage for updating is as follows: -R{serial number}
[-{options} ..] {firmware zim file} -R{serial number} -UU -B {firmware zim file}
Option definitions: -B = Reboots the camera after the update has completed. If this argument is not provided, a manual power cycle will be required. -A = Updates individual portions of the firmware in flash. The code section of camera at location 0xFF08000 will be updated. ./sample_app -AFF080000 camera.zim -U = Downgrade the firmware. Multiple U’s can be used to overwrite the ROM header. -F = Force program and EEprom reload. -R = Enter a regular expression for camera serial match. For example: ./sample_app -R.* camera.zim Results in matching any camera serial -P = Checks the progress of the updater. -epromsave = Save the content of the EEprom to a file.