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>
Public Member Functions | |
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. | |
bool | IsValid () const |
Checks the objects validity. More... | |
void | SetPixelFormatEnumNode (GenApi::IEnumerationT< EnumT > *pEnumT) |
Lazy initialization of the object. More... | |
EPixelType | GetPylonPixelTypeFromPixelFormatEnum (EnumT pixelFormatEnumValue) const |
Converts a enumeration node value to a Pylon::EPixelType enum. More... | |
Static Public Member Functions | |
static EPixelType | GetPylonPixelTypeByName (const char *pszSymbolicName) |
Returns a Pylon::EPixelType for a given symbolic name. More... | |
static EPixelType | GetPylonPixelTypeByName (const String_t &symbolicName) |
Returns a Pylon::EPixelType for a given symbolic name. More... | |
static const char * | GetNameByPixelType (EPixelType pixelType, SFNCVersion sfncVer=SFNCVersion_pre2_0) |
Static function that returns a string representation of the given EPixelType. More... | |
Protected Member Functions | |
void | SetPixelFormatEnumNode (GenApi::IEnumeration *pEnum) |
Lazy initialization of the object. More... | |
EPixelType | GetPylonPixelTypeFromNodeValue (int64_t nodeValue) const |
Converts a enumeration node value to a Pylon::EPixelType enum. More... | |
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)
|
inlinestatic |
Static function that returns a string representation of the given EPixelType.
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 |
Passing Pylon::PixelType_Mono16 will return "Mono16" will be returned. If the pixel type is not known an empty string is returned.
|
inlinestatic |
Returns a Pylon::EPixelType for a given symbolic name.
pszSymbolicName | pointer to the symbolic name. Note: Symbolic names are case sensitive. You can obtain the symbolic name by calling GENAPI_NAMESPACE::IEnumEntry::GetSymbolic() |
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.
|
inlinestatic |
Returns a Pylon::EPixelType for a given symbolic name.
symbolicName | The symbolic name. Note: Symbolic names are case sensitive. You can obtain the symbolic name by calling GENAPI_NAMESPACE::IEnumEntry::GetSymbolic() |
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.
|
inherited |
Converts a enumeration node value to a Pylon::EPixelType enum.
nodeValue | node value to convert. You can obtain this value by calling GENAPI_NAMESPACE::IEnumeration::GetIntValue. |
Converts a enumeration node value to a Pylon::EPixelType enum. You must have initialized the mapper before you can call this function.
|
inline |
Converts a enumeration node value to a Pylon::EPixelType enum.
pixelFormatEnumValue | enumeration value to convert. You obtain this value by calling GENAPI_NAMESPACE::IEnumerationT::GetValue. |
Converts a enumeration node value to a Pylon::EPixelType enum. You must have initialized the mapper before you can call this function.
|
inline |
Checks the objects validity.
Essentially this function checks whether you've called SetPixelFormatEnumNode.
|
inherited |
Lazy initialization of the object.
pEnum | Pointer to the enumeration node containing the PixelFormats. |
Call this function initialize the mapper when using the default c'tor.
|
inline |
Lazy initialization of the object.
pEnumT | Pointer to the enumeration node containing the PixelFormats. |
Call this function initialize the mapper when using the default c'tor.