Class PvDecompressionFilter

Filter used for image decompression.

Inheritance
object
IPvFilter
PvDecompressionFilter
Implements
Inherited Members
Namespace: eBUSDotNet
Assembly: eBUSDotNet.dll
Syntax
public class PvDecompressionFilter : IPvFilter, IDisposable

Constructors

View Source

PvDecompressionFilter()

Constructor.

Declaration
public PvDecompressionFilter()

Properties

View Source

ThreadCount

ThreadCount property of PvDecompressionFilter.

Declaration
public override uint ThreadCount { get; set; }
Property Value
Type Description
uint
Overrides

Methods

View Source

Dispose(bool)

Dispose

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing
Overrides
View Source

Execute(PvBuffer, ref PvBuffer)

Decompresses aIn into aOut.

Declaration
public override PvResult Execute(PvBuffer aIn, ref PvBuffer aOut)
Parameters
Type Name Description
PvBuffer aIn

Input buffer.
PvBuffer aOut

Output buffer.
Returns
Type Description
PvResult

Includes: - #PvResult::Code::OK - #PvResult::Code::INVALID_PARAMETER - #PvResult::Code::NOT_SUPPORTED if the compression algorithm is not supported by this version of the software. - #PvResult::Code::IMAGE_ERROR if the input buffer seems corrupted or contains unexpected information.
Overrides
View Source

GetOutputFormatFor(PvBuffer, out PvPixelType, out uint, out uint)

Returns the output format for a compressed buffer.

Declaration
public static PvResult GetOutputFormatFor(PvBuffer aIn, out PvPixelType aPixelType, out uint aWidth, out uint aHeight)
Parameters
Type Name Description
PvBuffer aIn

Buffer to inspect.
PvPixelType aPixelType

Pixel type the buffer is uncompressed to.
uint aWidth

Width of the uncompressed buffer, in pixels.
uint aHeight

Height of the uncompressed buffer, in pixels.
Returns
Type Description
PvResult

Includes: - #PvResult::Code::OK - #PvResult::Code::NOT_SUPPORTED if the buffer is not a compatible compressed buffer.
View Source

GetThreadsPriority(out uint)

Gets the thread priority of the filter's worker threads.

Declaration
public override PvResult GetThreadsPriority(out uint aPriority)
Parameters
Type Name Description
uint aPriority

Output reference to the worker threads priority.
Returns
Type Description
PvResult

Includes: - #PvResult::Code::OK - #PvResult::Code::NOT_SUPPORTED if the filter does not support multi-threading.
Overrides
View Source

IsCompressed(PvBuffer)

Returns true if the buffer can be decompressed using an object of this class.

Declaration
public static bool IsCompressed(PvBuffer aIn)
Parameters
Type Name Description
PvBuffer aIn

Buffer to inspect.
Returns
Type Description
bool

True if the buffer can be decompressed.
View Source

SetThreadsPriority(uint)

Sets the thread priority of the filter's worker threads.

Declaration
public override PvResult SetThreadsPriority(uint aPriority)
Parameters
Type Name Description
uint aPriority

Priority to set the worker threads to.
Returns
Type Description
PvResult

Includes: - #PvResult::Code::OK - #PvResult::Code::NOT_SUPPORTED if the filter does not support multi-threading. - #PvResult::Code::INVALID_PARAMETER if aPriority maps to nothing on the target system.
Overrides

Implements