Pylon Logo Basler Logo
Namespaces | Enumerations | Functions
PixelType.h File Reference

Definition of types of helper functions concerning image format and pixel type. More...

#include <pylon/Platform.h>
#include <pylon/PylonBase.h>

Namespaces

 Pylon
 Contains definitions of pylon types.
 

Enumerations

Functions

bool Pylon::IsMonoPacked (EPixelType pixelType)
 Returns true if the pixel type is Mono and the pixel values are not byte aligned.
 
bool Pylon::IsBayerPacked (EPixelType pixelType)
 Returns true if the pixel type is Bayer and the pixel values are not byte aligned.
 
bool Pylon::IsRGBPacked (EPixelType pixelType)
 Returns true if the pixel type is RGB and the pixel values are not byte aligned.
 
bool Pylon::IsBGRPacked (EPixelType pixelType)
 Returns true if the pixel type is BGR and the pixel values are not byte aligned.
 
bool Pylon::IsPacked (EPixelType pixelType)
 Returns true if the pixels of the given pixel type are not byte aligned.
 
bool Pylon::IsPackedInLsbFormat (EPixelType pixelType)
 
uint32_t Pylon::PlaneCount (EPixelType pixelType)
 Returns number of planes in the image composed of the pixel type.
 
EPixelType Pylon::GetPlanePixelType (EPixelType pixelType)
 Returns the pixel type of a plane.
 
bool Pylon::IsPlanar (EPixelType pixelType)
 Returns true if images of the pixel type are divided into multiple planes.
 
EPixelColorFilter Pylon::GetPixelColorFilter (EPixelType pixelType)
 Returns the Bayer color filter type.
 
uint32_t Pylon::BitPerPixel (EPixelType pixelType)
 Returns the bits needed to store a pixel. More...
 
uint32_t Pylon::SamplesPerPixel (EPixelType pixelType)
 Returns the number of measured values per pixel. More...
 
bool Pylon::IsYUV (EPixelType pixelType)
 Returns true when the pixel type represents a YUV format.
 
bool Pylon::IsRGBA (EPixelType pixelType)
 Returns true when the pixel type represents an RGBA format.
 
bool Pylon::IsRGB (EPixelType pixelType)
 Returns true when the pixel type represents an RGB or RGBA format.
 
bool Pylon::IsBGRA (EPixelType pixelType)
 Returns true when the pixel type represents a BGRA format.
 
bool Pylon::IsBGR (EPixelType pixelType)
 Returns true when the pixel type represents a BGR or BGRA format.
 
bool Pylon::IsBayer (EPixelType pixelType)
 Returns true when the pixel type represents a Bayer format.
 
bool Pylon::IsMono (EPixelType pixelType)
 Returns true when a given pixel is monochrome, e.g. PixelType_Mono8 or PixelType_BayerGR8.
 
bool Pylon::IsMonoImage (EPixelType pixelType)
 Returns true when an image using the given pixel type is monochrome, e.g. PixelType_Mono8.
 
bool Pylon::IsColorImage (EPixelType pixelType)
 Returns true when an image using the given pixel type is a color image (RGB/BGR/RGBA/BGRA/ etc or Bayer.
 
bool Pylon::HasAlpha (EPixelType pixelType)
 Returns true when an the image using the given pixel type has an alpha channel.
 
uint32_t Pylon::GetPixelIncrementX (EPixelType pixelType)
 Returns the minimum step size expressed in pixels for extracting an AOI.
 
uint32_t Pylon::GetPixelIncrementY (EPixelType pixelType)
 Returns the minimum step size expressed in pixels for extracting an AOI.
 
uint32_t Pylon::BitDepth (EPixelType pixelType)
 Returns the bit depth of a value of the pixel in bits. More...
 
bool Pylon::ComputeStride (size_t &strideBytes, EPixelType pixelType, uint32_t width, size_t paddingX=0)
 Computes the stride in byte. More...
 
size_t Pylon::ComputePaddingX (size_t strideBytes, EPixelType pixelType, uint32_t width)
 Computes the padding value from row stride in byte. More...
 
size_t Pylon::ComputeBufferSize (EPixelType pixelType, uint32_t width, uint32_t height, size_t paddingX=0)
 Computes the buffer size in byte. More...
 
bool Pylon::GetPixelTypesForUnpacking (EPixelType pixelTypeSource, EPixelType &pixelTypeToImpose, EPixelType &pixelTypeTarget)
 Returns the pixel types needed for conversion from packed to unpacked image formats using the CImageFormatConverter class. More...
 

Detailed Description

Definition of types of helper functions concerning image format and pixel type.


pylon 6.1.0
Copyright (c) 2006-2020 Basler AG (Mon Mar 16 2020 10:56:52)