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... | |
![]() | |
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 PvString & | GetSupportedGeometryName (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... | |
Filter used for tap reconstruction.
Executes the filter: performs tap reconstruction on aIn, writing into aOut.
[in] | aIn | The input buffer where data is read from. Must be a PvImage. |
[out] | 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. |
Implements IPvFilter.
PvTapGeometryEnum PvTapFilter::GetGeometry | ( | ) | const |
Returns the tap geometry currently used by the filter.
|
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.
[in] | aBuffer |
|
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.
|
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.
[in] | aIndex | Zero-based index, maximum is GetSupportedGeometryCount - 1. |
|
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.
[in] | aIndex | Zero-based index, maximum is GetSupportedGeometryCount - 1. |
|
static |
Utility method returning how many taps are used to a specific tap geometry.
[in] | aValue | SFNC compliant tap geometry name. |
|
static |
Utility method returning how many taps are used to a specific tap geometry.
[in] | aValue | Tap geometry enum. |
|
virtual |
Gets the maximum number of threads the filter can use.
Implements IPvFilter.
PvResult PvTapFilter::SetGeometry | ( | PvTapGeometryEnum | aValue | ) |
Sets the tap geometry for tap reconstruction.
[in] | aValue | New tap geometry used by the filter. |
|
virtual |
Sets the thread count to be used by the filter.
[in] | aCount | The maximum number of threads that can be used by this filter. |
Implements IPvFilter.
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com