Skip to content

Configuration Class#

Provides standard camera configurations.

Inheritance Hierarchy#

System.Object
  Basler.Pylon.Configuration

Syntax#

C#

public static class Configuration

VB

Public NotInheritable Class Configuration

The Configuration type exposes the following members.

Methods#

NameDescription
Public methodStatic memberAcquireContinuous(ICamera) Changes the configuration of the camera to free-running continuous acquisition.
Public methodStatic memberAcquireContinuous(Object, EventArgs) Changes the configuration of the camera to free-running continuous acquisition.
Public methodStatic memberAcquireSingleFrame(ICamera) Changes the configuration of the camera to single frame acquisition.
Public methodStatic memberAcquireSingleFrame(Object, EventArgs) Changes the configuration of the camera to single frame acquisition.
Public methodStatic memberDisableAllTriggers Turns off all triggers enabled on the camera.
Public methodStatic memberDisableCompression Disables compression on the camera.
Public methodStatic memberDisableGenDC Disables GenDC streaming on the camera.
Public methodStatic memberProbePacketSize Call Probe Packet Size to set maximum available packetsize to camera.
Public methodStatic memberSelectRangeComponent Select a simple range component (if available).
Public methodStatic memberSoftwareTrigger(ICamera) Changes the configuration of the camera to software triggered acquisition.
Public methodStatic memberSoftwareTrigger(Object, EventArgs) Changes the configuration of the camera to software triggered acquisition.
 

Configuration.AcquireContinuous Method (ICamera)#

Changes the configuration of the camera to free-running continuous acquisition.

Syntax#

C#

public static void AcquireContinuous(
    ICamera camera
)

VB

Public Shared Sub AcquireContinuous ( 
    camera As ICamera
)

Parameters#

 

camera
Type: Basler.Pylon.ICamera
The camera to be configured.

Remarks#

The camera has to be opened before calling this function.

Configuration.AcquireContinuous Method (Object, EventArgs)#

Changes the configuration of the camera to free-running continuous acquisition.

Syntax#

C#

public static void AcquireContinuous(
    Object sender,
    EventArgs e
)

VB

Public Shared Sub AcquireContinuous ( 
    sender As Object,
    e As EventArgs
)

Parameters#

 

sender
Type: System.Object
The sender of the event.
e
Type: System.EventArgs
The event argument.

Remarks#

To automatically apply this configuration when the connection to the camera is opened, add it to the CameraOpened event before calling ICamera.Open().

Configuration.AcquireSingleFrame Method (ICamera)#

Changes the configuration of the camera to single frame acquisition.

Syntax#

C#

public static void AcquireSingleFrame(
    ICamera camera
)

VB

Public Shared Sub AcquireSingleFrame ( 
    camera As ICamera
)

Parameters#

 

camera
Type: Basler.Pylon.ICamera
The camera to be configured.

Remarks#

The camera has to be opened before calling this function. To maximize the frame rate, grabbing single images using a software trigger is recommended. Using a software trigger will reduce the overhead per grabbed image compared to single frame acquisition.

Configuration.AcquireSingleFrame Method (Object, EventArgs)#

Changes the configuration of the camera to single frame acquisition.

Syntax#

C#

public static void AcquireSingleFrame(
    Object sender,
    EventArgs e
)

VB

Public Shared Sub AcquireSingleFrame ( 
    sender As Object,
    e As EventArgs
)

Parameters#

 

sender
Type: System.Object
The sender of the event.
e
Type: System.EventArgs
The event argument.

Remarks#

To maximize the frame rate, grabbing single images using a software trigger is recommended. Using a software trigger will reduce the overhead per grabbed image compared to single frame acquisition. To automatically apply this configuration when the connection to the camera is opened, add it to the CameraOpened event before calling ICamera.Open().

Configuration.DisableAllTriggers Method#

Turns off all triggers enabled on the camera.

Syntax#

C#

public static void DisableAllTriggers(
    Object sender,
    EventArgs e
)

VB

Public Shared Sub DisableAllTriggers ( 
    sender As Object,
    e As EventArgs
)

Parameters#

 

sender
Type: System.Object
The sender of the event.
e
Type: System.EventArgs
The event argument.

Configuration.DisableCompression Method#

Disables compression on the camera.

Syntax#

C#

public static void DisableCompression(
    Object sender,
    EventArgs e
)

VB

Public Shared Sub DisableCompression ( 
    sender As Object,
    e As EventArgs
)

Parameters#

 

sender
Type: System.Object
The sender of the event.
e
Type: System.EventArgs
The event argument.

Remarks#

Not all cameras support compression. Therefore, this procedure doesn't always have an effect.

Configuration.DisableGenDC Method#

Disables GenDC streaming on the camera.

Syntax#

C#

public static void DisableGenDC(
    Object sender,
    EventArgs e
)

VB

Public Shared Sub DisableGenDC ( 
    sender As Object,
    e As EventArgs
)

Parameters#

 

sender
Type: System.Object
The sender of the event.
e
Type: System.EventArgs
The event argument.

Remarks#

Not all cameras support GenDC streaming. Therefore, this procedure doesn't always have an effect.

Configuration.ProbePacketSize Method#

Call Probe Packet Size to set maximum available packetsize to camera.

Syntax#

C#

public static void ProbePacketSize(
    Object sender,
    EventArgs e
)

VB

Public Shared Sub ProbePacketSize ( 
    sender As Object,
    e As EventArgs
)

Parameters#

 

sender
Type: System.Object
The sender of the event.
e
Type: System.EventArgs
The event argument.

Configuration.SelectRangeComponent Method#

Select a simple range component (if available).

Syntax#

C#

public static void SelectRangeComponent(
    Object sender,
    EventArgs e
)

VB

Public Shared Sub SelectRangeComponent ( 
    sender As Object,
    e As EventArgs
)

Parameters#

 

sender
Type: System.Object
The sender of the event.
e
Type: System.EventArgs
The event argument.

Remarks#

Not all cameras support a range component. Therefore, this procedure doesn't always have an effect.

Configuration.SoftwareTrigger Method (ICamera)#

Changes the configuration of the camera to software triggered acquisition.

Syntax#

C#

public static void SoftwareTrigger(
    ICamera camera
)

VB

Public Shared Sub SoftwareTrigger ( 
    camera As ICamera
)

Parameters#

 

camera
Type: Basler.Pylon.ICamera
The camera to be configured.

Remarks#

The camera has to be opened before calling this function. Use together with WaitForFrameTriggerReady(Int32, TimeoutHandling) and ExecuteSoftwareTrigger().

Configuration.SoftwareTrigger Method (Object, EventArgs)#

Changes the configuration of the camera to software triggered acquisition.

Syntax#

C#

public static void SoftwareTrigger(
    Object sender,
    EventArgs e
)

VB

Public Shared Sub SoftwareTrigger ( 
    sender As Object,
    e As EventArgs
)

Parameters#

 

sender
Type: System.Object
The sender of the event.
e
Type: System.EventArgs
The event argument.

Remarks#

Use together with WaitForFrameTriggerReady(Int32, TimeoutHandling) and ExecuteSoftwareTrigger(). To automatically apply this configuration when the connection to the camera is opened, add it to the CameraOpened event before calling ICamera.Open().

Configuration.AcquireContinuous Method#

Overload List#

NameDescription
Public methodStatic memberAcquireContinuous(ICamera) Changes the configuration of the camera to free-running continuous acquisition.
Public methodStatic memberAcquireContinuous(Object, EventArgs) Changes the configuration of the camera to free-running continuous acquisition.
 

Configuration.AcquireSingleFrame Method#

Overload List#

NameDescription
Public methodStatic memberAcquireSingleFrame(ICamera) Changes the configuration of the camera to single frame acquisition.
Public methodStatic memberAcquireSingleFrame(Object, EventArgs) Changes the configuration of the camera to single frame acquisition.
 

Configuration.SoftwareTrigger Method#

Overload List#

NameDescription
Public methodStatic memberSoftwareTrigger(ICamera) Changes the configuration of the camera to software triggered acquisition.
Public methodStatic memberSoftwareTrigger(Object, EventArgs) Changes the configuration of the camera to software triggered acquisition.