Pylon::CCameraPixelTypeMapperT#

A camera specific pixeltypemapper (maps device specific pixelformats contained in the generated camera classes to pylon pixeltypes by their name). More…

#include <pylon/PixelTypeMapper.h>

Inherits from Pylon::CPixelTypeMapper

Public Functions#

	Name
	CCameraPixelTypeMapperT(void ) Create an empty mapper. Before calling any non-static function.
	CCameraPixelTypeMapperT(GenApi::IEnumerationT< EnumT > * pEnumT) create a mapper by using the enum node passed.
virtual	~CCameraPixelTypeMapperT(void )
bool	IsValid() const Checks the objects validity.
void	SetPixelFormatEnumNode(GenApi::IEnumerationT< EnumT > * pEnumT) Lazy initialization of the object.
EPixelType	GetPylonPixelTypeFromPixelFormatEnum(EnumT pixelFormatEnumValue) const Converts a enumeration node value to a Pylon::EPixelType enum.
EPixelType	GetPylonPixelTypeByName(const char * pszSymbolicName) Returns a Pylon::EPixelType for a given symbolic name.
EPixelType	GetPylonPixelTypeByName(const String_t & symbolicName) Returns a Pylon::EPixelType for a given symbolic name.
const char *	GetNameByPixelType(EPixelType pixelType, SFNCVersion sfncVer =SFNCVersion_pre2_0) Static function that returns a string representation of the given EPixelType.
void	SetPixelFormatEnumNode(GenApi::IEnumeration * pEnum) Lazy initialization of the object.
EPixelType	GetPylonPixelTypeFromNodeValue(int64_t nodeValue) const Converts an enumeration node value to a Pylon::EPixelType enum.

Additional inherited members#

Public Functions inherited from Pylon::CPixelTypeMapper

	Name
	CPixelTypeMapper(void )
	CPixelTypeMapper(GenApi::IEnumeration * pEnum) create and initialize a mapper by using the enum node passed.
virtual	~CPixelTypeMapper(void ) default d'tor

Detailed Description#

template <typename EnumT >
class Pylon::CCameraPixelTypeMapperT;

A camera specific pixeltypemapper (maps device specific pixelformats contained in the generated camera classes to pylon pixeltypes by their name).

Use this mapper to convert a PixelTypeEnums or ChunkPixelFormatEnums enum values to a Pylon_PixelType used for PixelTypeConverter creation. When passing the symbolic name of the pixeltype you can use the static version GetPylonPixelTypeByName. This function will do the lookup everytime you call it. The non-static member function GetPylonPixelTypeFromPixelFormatEnum uses caching to speed up subsequent calls.

The template parameter EnumT is the enumeration type from the camera class (typically Basler_GigECamera::PixelFormatEnums for GigE cameras or Basler_IIDC1394CameraParams::PixelFormatEnums for 1394 cameras)

Public Functions Documentation#

CCameraPixelTypeMapperT#

inline CCameraPixelTypeMapperT(
    void 
)

Create an empty mapper. Before calling any non-static function.

CCameraPixelTypeMapperT#

inline explicit CCameraPixelTypeMapperT(
    GenApi::IEnumerationT< EnumT > * pEnumT
)

create a mapper by using the enum node passed.

~CCameraPixelTypeMapperT#

inline virtual ~CCameraPixelTypeMapperT(
    void 
)

IsValid#

inline bool IsValid() const

Checks the objects validity.

Return: Returns true if the object is initialized properly.

Essentially this function checks whether you've called SetPixelFormatEnumNode.

SetPixelFormatEnumNode#

inline void SetPixelFormatEnumNode(
    GenApi::IEnumerationT< EnumT > * pEnumT
)

Lazy initialization of the object.

Parameters:

pEnumT Pointer to the enumeration node containing the PixelFormats.

Call this function initialize the mapper when using the default c'tor.

GetPylonPixelTypeFromPixelFormatEnum#

inline EPixelType GetPylonPixelTypeFromPixelFormatEnum(
    EnumT pixelFormatEnumValue
) const

Converts a enumeration node value to a Pylon::EPixelType enum.

Parameters:

pixelFormatEnumValue enumeration value to convert. You obtain this value by calling GenApi::IEnumerationT::GetValue.

Return: Returns the Pylon::EPixelType for a given pixelformat enum value defined in the enum node passed in c'tor

Converts a enumeration node value to a Pylon::EPixelType enum. You must have initialized the mapper before you can call this function.

GetPylonPixelTypeByName#

static inline EPixelType GetPylonPixelTypeByName(
    const char * pszSymbolicName
)

Returns a Pylon::EPixelType for a given symbolic name.

Parameters:

pszSymbolicName pointer to the symbolic name. Note: Symbolic names are case sensitive. You can obtain the symbolic name by calling GenApi::IEnumEntry::GetSymbolic()

Return: Returns the Pylon_PixelType for a given symbolic name.

Static version which does the lookup soley by symbolic string comparison. Passing "Mono16" will return Pylon::PixelType_Mono16. If the name is not found Pylon::PixelType_Undefined will be returned.

GetPylonPixelTypeByName#

static inline EPixelType GetPylonPixelTypeByName(
    const String_t & symbolicName
)

Returns a Pylon::EPixelType for a given symbolic name.

Parameters:

symbolicName The symbolic name. Note: Symbolic names are case sensitive. You can obtain the symbolic name by calling GenApi::IEnumEntry::GetSymbolic()

Return: Returns the Pylon_PixelType for a given symbolic name.

Static version which does the lookup solely by symbolic string comparison. Passing "Mono16" will return Pylon::PixelType_Mono16. If the name is not found Pylon::PixelType_Undefined will be returned.

GetNameByPixelType#

static inline const char * GetNameByPixelType(
    EPixelType pixelType,
    SFNCVersion sfncVer =SFNCVersion_pre2_0
)

Static function that returns a string representation of the given EPixelType.

Parameters:

pixelType The pixel type to return the name for.
sfncVer SFNC Version to use when doing the mapping. Some names have been changed in SFNC 2.0

Return: Returns the pointer to a null terminated string representing the symbolic name of the pixel type.

Note: The returned name cannot be used to parameterize the pixel format of a camera device, because the camera's pixel format name can be different. The camera's pixel format name depends on the used standard feature naming convention (SFNC).

Passing Pylon::PixelType_Mono16 will return "Mono16" will be returned. If the pixel type is not known an empty string is returned.

SetPixelFormatEnumNode#

void SetPixelFormatEnumNode(
    GenApi::IEnumeration * pEnum
)

Lazy initialization of the object.

Parameters:

pEnum Pointer to the enumeration node containing the PixelFormats.

Call this function initialize the mapper when using the default c'tor.

GetPylonPixelTypeFromNodeValue#

EPixelType GetPylonPixelTypeFromNodeValue(
    int64_t nodeValue
) const

Converts an enumeration node value to a Pylon::EPixelType enum.

Parameters:

nodeValue node value to convert. You can obtain this value by calling GenApi::IEnumeration::GetIntValue.

Return: Returns the Pylon::EPixelType for a given pixelformat enum value defined in the Enum passed in c'tor

Converts a enumeration node value to a Pylon::EPixelType enum. You must have initialized the mapper before you can call this function.

Updated on 5 July 2022 at 15:30:00