Class PvBufferConverterRGBFilter

Contains a RGB filter configuration that can be used with a PvBufferConverter.

Inheritance

object

PvBufferConverterRGBFilter

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: eBUSDotNetReceive

Assembly: eBUSDotNetReceive.dll

Syntax

public class PvBufferConverterRGBFilter : IDisposable

Remarks

To configure an RGB filter (manual): - Create an RGB filter controller. - Set the filter's values. Use SetGain* and SetOffset* methods. See SetGainB.

<b>To configure a white balance filter (automatic):</b>
    - Create an RGB filter object.
    - Calculate and apply white-balance settings. Use WhiteBalance.

Constructors

PvBufferConverterRGBFilter()

Constructor.

Declaration

public PvBufferConverterRGBFilter()

Fields

swigCMemOwn

Determines who is responsible for deleting the underlying C++ object.

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

GainB

Gets or sets the filter's gain (blue).

Declaration

public double GainB { get; set; }

Property Value

Type	Description
double

GainG

Gets or sets the filter's gain (green).

Declaration

public double GainG { get; set; }

Property Value

Type	Description
double

GainR

Gets or sets the filter's gain (red).

Declaration

public double GainR { get; set; }

Property Value

Type	Description
double

OffsetB

Gets or sets the filter's offset (blue).

Declaration

public int OffsetB { get; set; }

Property Value

Type	Description
int

OffsetG

Gets or sets the filter's offset (green).

Declaration

public int OffsetG { get; set; }

Property Value

Type	Description
int

OffsetR

Gets or sets the filter's offset (red).

Declaration

public int OffsetR { get; set; }

Property Value

Type	Description
int

Methods

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~PvBufferConverterRGBFilter()

Destructor.

Declaration

protected ~PvBufferConverterRGBFilter()

Reset()

Reset the RGB filter configuration.

Declaration

public void Reset()

WhiteBalance(PvBuffer)

Calculate white-balance gains.

Declaration

public PvResult WhiteBalance(PvBuffer aBuffer)

Parameters

Type	Name	Description
PvBuffer	aBuffer	The sample image; the image upon which to base the white-balance settings.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::INVALID_PARAMETER,

Implements

IDisposable