Skip to content

Basler.Pylon Class List#

Provides classes and interfaces to find cameras, to parametrize cameras, and to acquire images.

Classes#

ClassDescription
Public classActionCommandResult Contains detailed results of calling Issue or Schedule methods.
Public classActionCommandTrigger Provides simplified access to GigE action commands. It can be used to automatically or manually configure the DeviceKey, GroupKey, and GroupMask features for cameras. It can also configure the camera's trigger and set the trigger source to action command. In addition, there are some static methods for issuing and scheduling an action command.
Public classAdvancedParameterAccessKey Provides advanced parameter information
Public classArrayBufferFactory(T) A basic buffer factory that allocates arrays of a given type provided by the generic parameter.
Public classAviVideoWriter Provides a convenient way to save AVI video files using Video for Windows (VfW).
Public classCamera Provides convenient access to a camera device.
Public classCameraFinder The camera finder can be used to query information about camera devices connected to the system.
Public classCameraInfoKey Provides standard camera info key names.
Public classConfiguration Provides standard camera configurations.
Public classDataContainerFactory Provides a factory for data container.
Public classDeviceType Lists common device types.
Public classGrabStopEventArgs Provides data for the GrabStopping & GrabStopped events.
Public classImageDecompressor Provides convenient access to cameras that support image compression and helps with decompressing these images.
Public classImageGrabbedEventArgs Provides data for the ImageGrabbed event
Public classImagePersistence Contains static methods that support saving of images.
Public classImageWindow Displays an IImage or IGrabResult on screen.
Public classInterface Provides convenient access to an interface.
Public classInterfaceFinder The interface finder can be used to query information about interfaces in the system.
Public classInterfaceInfoKey Provides standard interface info key names.
Public classIpConfigurator This class provides helper functions to work with IP based camera devices.
Public classLibrary Library provides some basic information on the PylonNET library, such as its version and the available transport layers.
Public classParameterChangedEventArgs Event arguments used when a parameter change event is raised from interface class IParameter.
Public classParameterListEnum Advanced: This class is used to create parameter lists.
Public classParameterPath Lists common objects.
Public classParameterValueChangedEventArgs Event arguments used when a parameter value change event is raised from interface class IParameter.
Public classPixelDataConverter Creates new images by converting a source image to another format.
Public classPLCamera List of all parameter names available for Basler camera devices
Public classPLCamera.BslDualROIRowSelectorEnum

Sets which row can be configured.

Applies to: boost_V_CoaXPress

Visibility: Expert

Selecting Parameters: BslDualROIRowOffset, BslDualROIRowSize

The feature documentation may provide more information.

Public classPLCamera.BslEnableFanEnum

Enables the external fan if one is connected.

Applies to: boost_V_CoaXPress

Visibility: Beginner

The feature documentation may provide more information.

Public classPLCamera.BslFlatFieldCorrectionModeEnum

Sets the flat-field correction mode.

Applies to: boost_V_CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public classPLCamera.BslImageStampEnum

Enables image stamping. If enabled, the first pixels of the image will contain metadata (e.g., an image counter) instead of visual information.

Applies to: boost_V_CoaXPress

Visibility: Beginner

The feature documentation may provide more information.

Public classPLCamera.BslStaticDefectPixelCorrectionFileStatusEnum

Returns the file status of the defect pixel correction file.

Applies to: ace 2 GigE, ace 2 USB and boost CoaXPress

Visibility: Guru

The feature documentation may provide more information.

Public classPLCamera.BslStaticDefectPixelCorrectionModeEnum

Sets the static defect pixel correction mode.

Applies to: ace 2 GigE, ace 2 USB, boost CoaXPress and boost_V_CoaXPress

Visibility: Beginner

The feature documentation may provide more information.

Public classPLCamera.BslStaticDefectPixelCorrectionTestModeEnum

Enables or disables the static defect pixel correction test mode. In test mode, all corrected pixels are set to completely white. This helps to find pixels that are being corrected in your images.

Applies to: boost_V_CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public classPLCamera.BslStaticDefectPixelCorrectionXSelectorEnum

Sets which x coordinate entry can be configured.

Applies to: boost_V_CoaXPress

Visibility: Expert

Selecting Parameters: BslStaticDefectPixelCorrectionXCoordinate

The feature documentation may provide more information.

Public classPLCamera.BslTransferBitDepthEnum

Sets the bit depth used for internal image processing. Lowering the transfer bit depth increases the frame rate, but image quality may degrade.

Applies to: boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public classPLCamera.BslTransferBitDepthModeEnum

Sets the transfer bit depth mode.

Applies to: boost CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public classPLCamera.BslUSBPowerSourceEnum

Indicates how power is supplied to the device.

Applies to: ace 2 USB

Visibility: Guru

The feature documentation may provide more information.

Public classPLCameraInstance List of all parameter names available for CameraInstance
Public classPLCameraInstance.BufferHandlingModeEnum

Determines whether the number of available buffers is limited and when they are allocated.

Visibility: Expert

Public classPLChunkData List of all parameter names available for chunk data of Basler camera devices
Public classPLEventGrabber List of all parameter names available for pylon event grabbers
Public classPLInterface List of all parameter names available for pylon interfaces
Public classPLInterface.DiscoveryMethodEnum

Discovery Method to look for remote devices. One can switch it to discover only real cameras, emulated cameras or both. The maximum number of emulated cameras is the maximum number of acquisition channels, which is applet dependent.

Applies to: CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public classPLPixelDataConverter List of all parameter names available for the Pixel Data Converter
Public classPLStream List of all parameter names available for pylon stream grabbers
Public classPLTransportLayer List of all parameter names available for pylon device transport layers
Public classPLTransportLayer.OverflowEventSelectEnum

An overflow event can be generated on each incomplete, lost or correct frame. It is possible to select all permutations of these three events to be reported via overflow event.

Applies to: CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public classPLTransportLayer.TriggerOutputEventSelectEnum

Select the pulse form generator for event monitoring.

Applies to: CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public classPLTransportLayer.VantagePointEnum

Vantage point. Use for mirroring. If VantagePoint is set to TopRight or BottomRight Width + XOffset must be smaller than SensorWidth. If VantagePoint is set to BottomLeft or BottomRight the Height + YOffset must be smaller than SensorHeight.

Applies to: CoaXPress

Visibility: Expert

The feature documentation may provide more information.

Public classPLVideoWriter List of all parameter names available for the Video Writer
Public classTLType Provides the names of the transport layer types.
Public classTransportLayerInfoKey Provides standard transport layer info key names.
Public classVideoWriter Provides a convenient way to save video files using the pylon Supplementary Package for MPEG-4.

Structures#

StructureDescription
Public structureArrayName Defines an array parameter name by combining the parameter name string and the parameter type information.
Public structureBooleanName Defines a boolean parameter name by combining the parameter name string and the parameter type information.
Public structureCommandName Defines a command parameter name by combining the parameter name string and the parameter type information.
Public structureCompressionInfo The struct containing information about a grab buffer/result.
Public structureEnumName Defines an enum parameter name by combining the parameter name string and the parameter type information.
Public structureFloatName Defines a float parameter name by combining the parameter name string and the parameter type information.
Public structureIntegerName Defines an integer parameter name by combining the parameter name string and the parameter type information.
Public structureStringName Defines a string parameter name by combining the parameter name string and the parameter type information.

Interfaces#

InterfaceDescription
Public interfaceIAdvancedParameterAccess Provides advanced parameter services.
Public interfaceIArrayParameter Interface class for array parameter access.
Public interfaceIBooleanParameter Interface class for boolean parameters.
Public interfaceIBufferFactory Implement this interface to provide custom memory allocation.
Public interfaceICamera Provides convenient access to a camera device.
Public interfaceICameraInfo Provides access to the properties of a camera device.
Public interfaceICommandParameter Interface class for command parameters.
Public interfaceIDataComponent Provides methods for accessing a single data component.
Public interfaceCode exampleIDataContainer Provides methods for accessing grab results consisting of multiple components
Public interfaceIEnumParameter Interface class for enumeration parameters. An enumeration parameter is enumerable. The enumerator lists all currently settable values.
Public interfaceIFloatParameter Interface class for float parameters.
Public interfaceIGrabResult Interface of the grab result data.
Public interfaceIImage Provides access to image properties and image buffer.
Public interfaceIInfo Provides access to the properties of an info object.
Public interfaceIIntegerParameter Interface class for integer parameters.
Public interfaceIInterface Provides convenient access to an interface.
Public interfaceIInterfaceInfo Provides access to the properties of an interface.
Public interfaceIParameter Interface base class of all parameters.
Public interfaceIParameterCollection Represents a collection of parameters that are identified by a path, a name, and a type.
Public interfaceIRawParameter Interface class for raw parameter access.
Public interfaceIStreamGrabber Provides convenient access to the StreamGrabber.
Public interfaceIStringParameter Interface class for string parameters.
Public interfaceITransportLayerInfo Provides access to the properties of a transport layer.
Public interfaceIVideoWriter Provides a convenient way to save video files.

Enumerations#

EnumerationDescription
Public enumerationActionCommandStatus Lists possible status codes returned by Basler.Pylon.ActionCommandTrigger.Issue or Basler.Pylon.ActionCommandTrigger.Schedule.
Public enumerationCameraSelectionStrategy Lists possible strategies for selecting a camera device.
Public enumerationComponentType Provides standard component types.
Public enumerationCompressionMode Mode used for transferring images.
Public enumerationCompressionStatus Status of a grab buffer/result with compressed data.
Public enumerationDeviceAccessibilityInfo Describes the accessibility state of a camera device.
Public enumerationEndianness Endianness for parsing the grab buffer/result as defined for the camera technology used.
Public enumerationFloatValueCorrection Lists possible float value correction strategies.
Public enumerationGrabLoop Defines the use of an additional grab loop thread.
Public enumerationGrabStopReason States the reason why a GrabStopping or GrabStopped event occurred.
Public enumerationGrabStrategy Lists the possible grab strategies.
Public enumerationImageFileFormat List of available file formats for ImagePersistence.
Public enumerationImageOrientation Defines the vertical orientation of an image in memory.
Public enumerationIntegerValueCorrection Lists possible integer value corrections.
Public enumerationIpConfigurationMethod Lists the possible IP address configuration methods.
Public enumerationParameterRelation Lists possible relationships between parameters.
Public enumerationPayloadType The list of possible payload types.
Public enumerationPixelColorFilter Lists the Bayer color filter types.
Public enumerationPixelType The PixelType specifies the pixel format and layout of a grab result or an image.
Public enumerationShowMode Defines the way an image window is shown. These constants follow the ShowWindow API.
Public enumerationTimeoutHandling Defines how a timeout is handled by a method.