Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvTapFilter Class Reference

Public Member Functions

 PvTapFilter ()
 Constructor.
 
virtual ~PvTapFilter ()
 Destructor.
 
PvResult Execute (const PvBuffer *aIn, PvBuffer *aOut)
 Executes the filter: performs tap reconstruction on aIn, writing into aOut. More...
 
PvResult SetThreadCount (uint32_t aCount)
 Sets the thread count to be used by the filter. More...
 
uint32_t GetThreadCount () const
 Gets the maximum number of threads the filter can use. More...
 
PvResult SetGeometry (PvTapGeometryEnum aValue)
 Sets the tap geometry for tap reconstruction. More...
 
PvTapGeometryEnum GetGeometry () const
 Returns the tap geometry currently used by the filter. More...
 
- Public Member Functions inherited from IPvFilter
 IPvFilter ()
 Constructor.
 
virtual ~IPvFilter ()
 Destructor.
 

Static Public Member Functions

static uint32_t GetSupportedGeometryCount ()
 Static method returning how many tap geometries are supported by the filter. More...
 
static PvTapGeometryEnum GetSupportedGeometryValue (uint32_t aIndex)
 Static method returning the value of a tap geometry indexed in a zero-based supported geometries array. More...
 
static const PvStringGetSupportedGeometryName (uint32_t aIndex)
 Static method returning the name of a tap geometry indexed in a zero-based supported geometries array. More...
 
static PvPixelType GetOutputPixelTypeFor (const PvBuffer *aBuffer)
 Static method used to query the output pixel type for an input image of a specific pixel type. More...
 
static uint32_t GetTapCountFor (PvTapGeometryEnum aValue)
 Utility method returning how many taps are used to a specific tap geometry. More...
 
static uint32_t GetTapCountFor (const PvString &aValue)
 Utility method returning how many taps are used to a specific tap geometry. More...
 

Detailed Description

Filter used for tap reconstruction.

Member Function Documentation

PvResult PvTapFilter::Execute ( const PvBuffer aIn,
PvBuffer aOut 
)
virtual

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

Parameters
[in]aInThe input buffer where data is read from. Must be a PvImage.
[out]aOutThe 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
Includes:

Implements IPvFilter.

PvTapGeometryEnum PvTapFilter::GetGeometry ( ) const

Returns the tap geometry currently used by the filter.

Returns
Tap geometry currently used by the filter.
PvPixelType PvTapFilter::GetOutputPixelTypeFor ( const PvBuffer aBuffer)
static

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

This method can be used if the output buffer provided to Execute is attached and not allocated. The filter can re-allocate an allocated buffer if needed (mismatch on width, height or pixel format) but attached external buffers must be properly formatted before calling Execute.

To properly prepare the output buffer, use the same width and height as the input buffer. For the pixel format, use this static method with the input buffer in aBuffer to query the required pixel type of the output buffer.

Parameters
[in]aBuffer
Returns
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.)
uint32_t PvTapFilter::GetSupportedGeometryCount ( )
static

Static method returning how many tap geometries are supported by the filter.

Can be used with GetSupportedGeometryValue and GetSupportedGeometryName to populate UI combo boxes allowing tap geometry selection.

Returns
Count of supported tap geometries.
const PvString & PvTapFilter::GetSupportedGeometryName ( uint32_t  aIndex)
static

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

Can be used with GetSupportedGeometryCount and GetSupportedGeometryValue to populate UI combo boxes allowing tap geometry selection.

Parameters
[in]aIndexZero-based index, maximum is GetSupportedGeometryCount - 1.
Returns
Human understandable tap geometry name.
PvTapGeometryEnum PvTapFilter::GetSupportedGeometryValue ( uint32_t  aIndex)
static

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

Can be used with GetSupportedGeometryCount and GetSupportedGeometryName to populate UI combo boxes allowing tap geometry selection.

Parameters
[in]aIndexZero-based index, maximum is GetSupportedGeometryCount - 1.
Returns
PvTapGeometryEnum value.
uint32_t PvTapFilter::GetTapCountFor ( PvTapGeometryEnum  aValue)
static

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

Parameters
[in]aValueTap geometry enum.
Returns
Tap count.
uint32_t PvTapFilter::GetTapCountFor ( const PvString aValue)
static

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

Parameters
[in]aValueSFNC compliant tap geometry name.
Returns
Tap count.
uint32_t PvTapFilter::GetThreadCount ( ) const
virtual

Gets the maximum number of threads the filter can use.

Returns
The maximum number of threads the filter can use.

Implements IPvFilter.

PvResult PvTapFilter::SetGeometry ( PvTapGeometryEnum  aValue)

Sets the tap geometry for tap reconstruction.

Parameters
[in]aValueNew tap geometry used by the filter.
Returns
Includes:
PvResult PvTapFilter::SetThreadCount ( uint32_t  aCount)
virtual

Sets the thread count to be used by the filter.

Parameters
[in]aCountThe maximum number of threads that can be used by this filter.
Returns
Includes:

Implements IPvFilter.


The documentation for this class was generated from the following files:

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com