Class PvTapFilter

Filter that remaps multi-tap image data into a contiguous output.

Inheritance

object

IPvFilter

PvTapFilter

Implements

IDisposable

Inherited Members

IPvFilter.swigCMemOwn

IPvFilter.Dispose()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: eBUSDotNet

Assembly: eBUSDotNet.dll

Syntax

public class PvTapFilter : IPvFilter, IDisposable

Constructors

PvTapFilter()

Constructor

Declaration

public PvTapFilter()

Properties

Geometry

Tap geometry used by the filter when performing reconstruction.

Declaration

public PvTapGeometryEnum Geometry { get; set; }

Property Value

Type	Description
PvTapGeometryEnum

SupportedGeometryCount

Gets the number of supported tap geometries.

Declaration

public uint SupportedGeometryCount { get; }

Property Value

Type	Description
uint

ThreadCount

ThreadCount property of PvTapFilter.

Declaration

public override uint ThreadCount { get; set; }

Property Value

Type	Description
uint

Overrides

IPvFilter.ThreadCount

Methods

Dispose(bool)

Dispose

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Overrides

IPvFilter.Dispose(bool)

Execute(PvBuffer, ref PvBuffer)

Executes the filter: performs tap reconstruction on aIn, writing into aOut.

Declaration

public override PvResult Execute(PvBuffer aIn, ref PvBuffer aOut)

Parameters

Type	Name	Description
PvBuffer	aIn	The input buffer where data is read from. Must be a PvImage.
PvBuffer	aOut	The output buffer where data is written to. Can be resized if needed if the buffer is allocated. If the buffer is attached, the buffer must be of the right image size and pixel type.

Returns

Type	Description
PvResult	Includes: - #PvResult::Code::OK - #PvResult::Code::INVALID_PARAMETER - #PvResult::Code::NOT_ENOUGH_MEMORY - #PvResult::Code::INVALID_DATA_FORMAT - #PvResult::Code::NOT_SUPPORTED - #PvResult::Code::GENERIC_ERROR

Overrides

IPvFilter.Execute(PvBuffer, ref PvBuffer)

GetOutputPixelTypeFor(PvBuffer)

Static method used to query the output pixel type for an input image of a specific pixel type.

Declaration

public static PvPixelType GetOutputPixelTypeFor(PvBuffer aBuffer)

Parameters

Type	Name	Description
PvBuffer	aBuffer	The input buffer to query.

Returns

Type	Description
PvPixelType	Required pixel type of the aOutput of #Execute if aBuffer is used as aInput. PvPixelUndefined is returned if the filter is not compatible with aBuffer (unsupported pixel type, not a PvImage, etc.)

GetSupportedGeometryName(uint)

Static method returning the name of a tap geometry indexed in a zero-based supported geometries array.

Declaration

public static string GetSupportedGeometryName(uint aIndex)

Parameters

Type	Name	Description
uint	aIndex	Zero-based index, maximum is #GetSupportedGeometryCount - 1.

Returns

Type	Description
string	Human understandable tap geometry name.

GetSupportedGeometryValue(uint)

Static method returning the value of a tap geometry indexed in a zero-based supported geometries array.

Declaration

public static PvTapGeometryEnum GetSupportedGeometryValue(uint aIndex)

Parameters

Type	Name	Description
uint	aIndex	Zero-based index, maximum is #GetSupportedGeometryCount - 1.

Returns

Type	Description
PvTapGeometryEnum	PvTapGeometryEnum value.

GetTapCountFor(PvTapGeometryEnum)

Utility method returning how many taps are used to a specific tap geometry.

Declaration

public static uint GetTapCountFor(PvTapGeometryEnum aValue)

Parameters

Type	Name	Description
PvTapGeometryEnum	aValue	Tap geometry enum.

Returns

Type	Description
uint	Tap count.

GetTapCountFor(string)

Utility method returning how many taps are used to a specific tap geometry.

Declaration

public static uint GetTapCountFor(string aValue)

Parameters

Type	Name	Description
string	aValue	SFNC compliant tap geometry name.

Returns

Type	Description
uint	Tap count.

GetThreadsPriority(out uint)

Gets the priority of the processing threads.

Declaration

public override PvResult GetThreadsPriority(out uint aPriority)

Parameters

Type	Name	Description
uint	aPriority	Output parameter to receive the thread priority.

Returns

Type	Description
PvResult	PV_OK on success, or an error code on failure.

Overrides

IPvFilter.GetThreadsPriority(out uint)

SetThreadsPriority(uint)

Sets the priority of the processing threads.

Declaration

public override PvResult SetThreadsPriority(uint aPriority)

Parameters

Type	Name	Description
uint	aPriority	The thread priority to set.

Returns

Type	Description
PvResult	PV_OK on success, or an error code on failure.

Overrides

IPvFilter.SetThreadsPriority(uint)

Implements

IDisposable