Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvTruesenseConverter Class Reference

Converts images from TRUESENSE(TM) to RGB. More...

Public Member Functions

 PvTruesenseConverter ()
 Constructor.
 
virtual ~PvTruesenseConverter ()
 Destructor.
 
PvResult Convert (const PvImage *aSource, PvImage *aDestination, bool aReallocIfNeeded=true)
 Convert a buffer from one format to another. More...
 
uint32_t GetDarkfloor () const
 Returns the dark floor of the raw image. More...
 
float GetRedGain () const
 Returns the red gain of white balance. More...
 
float GetGreenGain () const
 Returns the green gain of white balance. More...
 
float GetBlueGain () const
 Returns the blue gain of white balance. More...
 
float GetPanGain () const
 Returns the panchromatic gain of white balance. More...
 
float GetGlobalGain () const
 Returns the global gain of white balance. More...
 
float GetSharpenParam () const
 Returns the sharp parameter. More...
 
float GetMaxSharpen () const
 Returns the sharp maximal threshold. More...
 
float GetHighLumaNoise () const
 Returns the high noise threshold. More...
 
float GetLowLumaNoise () const
 Returns the low noise threshold. More...
 
PvResult SetDarkfloor (uint32_t aValue)
 Sets the dark floor of the raw image. More...
 
PvResult SetRedGain (float aValue)
 Sets the red gain of white balance. More...
 
PvResult SetGreenGain (float aValue)
 Sets the green gain of white balance. More...
 
PvResult SetBlueGain (float aValue)
 Sets the blue gain of white balance. More...
 
PvResult SetPanGain (float aValue)
 Sets the panchromatic gain of white balance. More...
 
PvResult SetGlobalGain (float aValue)
 Sets the global gain of white balance. More...
 
PvResult SetSharpenParam (float aValue)
 Sets the sharp parameter. More...
 
PvResult SetMaxSharpen (float aValue)
 Sets the sharp maximal threshold. More...
 
PvResult SetHighLumaNoise (float aValue)
 Sets the high noise threshold. More...
 
PvResult SetLowLumaNoise (float aValue)
 Sets the low noise threshold. More...
 

Static Public Member Functions

static bool IsConversionSupported (PvPixelType aSource, PvPixelType aDestination)
 Returns true if this converter class can be used for a source-to-destination conversion. More...
 

Detailed Description

Converts images from TRUESENSE(TM) to RGB.

This class can be used to convert Sparse Color Filter TRUESENSE(TM) images (SCF1) into RGB8 or RGBa8. The image quality is expected to be much better than SCF1 conversion performed using PvBufferConverter.

The intense image processing algorithms used to obtain this high quality yields much higher processing times. Various gain and filtering parameters can be used to tweak the image conversion.

SCF1 12-unpacked is recommended as input pixel type for slightly better processing times. Other SCF1 pixel types are also supported but must internally be converted to 12-unpacked before being converted to RGB.

Member Function Documentation

PvResult PvTruesenseConverter::Convert ( const PvImage aSource,
PvImage aDestination,
bool  aReallocIfNeeded = true 
)

Convert a buffer from one format to another.

Parameters
[in]aSourceThe original image.
[out]aDestinationThe new image.
[in]aReallocIfNeededDepending on the conversion, the memory footprint of the new image may be greater than aDestination current size. By setting this parameter to true, the buffer is re-allocated if aDestination is too small. If aDestination memory buffer is not owned by the PvBuffer and is too small, Convert fails.
Returns
Includes:
float PvTruesenseConverter::GetBlueGain ( ) const

Returns the blue gain of white balance.

Returns
Blue gain of white balance.
uint32_t PvTruesenseConverter::GetDarkfloor ( ) const

Returns the dark floor of the raw image.

Returns
Dark floor of the raw image.
float PvTruesenseConverter::GetGlobalGain ( ) const

Returns the global gain of white balance.

Returns
Global gain of white balance.
float PvTruesenseConverter::GetGreenGain ( ) const

Returns the green gain of white balance.

Returns
Red green of white balance.
float PvTruesenseConverter::GetHighLumaNoise ( ) const

Returns the high noise threshold.

Returns
High noise threshold.
float PvTruesenseConverter::GetLowLumaNoise ( ) const

Returns the low noise threshold.

Returns
Low noise threshold.
float PvTruesenseConverter::GetMaxSharpen ( ) const

Returns the sharp maximal threshold.

Returns
Sharp maximal threshold.
float PvTruesenseConverter::GetPanGain ( ) const

Returns the panchromatic gain of white balance.

Returns
Panchromatic gain of white balance.
float PvTruesenseConverter::GetRedGain ( ) const

Returns the red gain of white balance.

Returns
Red gain of white balance.
float PvTruesenseConverter::GetSharpenParam ( ) const

Returns the sharp parameter.

Returns
Sharp parameter.
bool PvTruesenseConverter::IsConversionSupported ( PvPixelType  aSource,
PvPixelType  aDestination 
)
static

Returns true if this converter class can be used for a source-to-destination conversion.

Parameters
[in]aSourcePixel type of the source buffer.
[out]aDestinationPixel type of the destination buffer.
Returns
True if the conversion is supported, false if not.
PvResult PvTruesenseConverter::SetBlueGain ( float  aValue)

Sets the blue gain of white balance.

Parameters
[in]aValueNew value for the parameter.
Returns
Includes:
PvResult PvTruesenseConverter::SetDarkfloor ( uint32_t  aValue)

Sets the dark floor of the raw image.

Parameters
[in]aValueNew value for the parameter.
Returns
Includes:
PvResult PvTruesenseConverter::SetGlobalGain ( float  aValue)

Sets the global gain of white balance.

Parameters
[in]aValueNew value for the parameter.
Returns
Includes:
PvResult PvTruesenseConverter::SetGreenGain ( float  aValue)

Sets the green gain of white balance.

Parameters
[in]aValueNew value for the parameter.
Returns
Includes:
PvResult PvTruesenseConverter::SetHighLumaNoise ( float  aValue)

Sets the high noise threshold.

Parameters
[in]aValueNew value for the parameter.
Returns
Includes:
PvResult PvTruesenseConverter::SetLowLumaNoise ( float  aValue)

Sets the low noise threshold.

Parameters
[in]aValueNew value for the parameter.
Returns
Includes:
PvResult PvTruesenseConverter::SetMaxSharpen ( float  aValue)

Sets the sharp maximal threshold.

Parameters
[in]aValueNew value for the parameter.
Returns
Includes:
PvResult PvTruesenseConverter::SetPanGain ( float  aValue)

Sets the panchromatic gain of white balance.

Parameters
[in]aValueNew value for the parameter.
Returns
Includes:
PvResult PvTruesenseConverter::SetRedGain ( float  aValue)

Sets the red gain of white balance.

Parameters
[in]aValueNew value for the parameter.
Returns
Includes:
PvResult PvTruesenseConverter::SetSharpenParam ( float  aValue)

Sets the sharp parameter.

Parameters
[in]aValueNew value for the parameter.
Returns
Includes:

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

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