PCL
pcl::UInt8PixelTraits Class Reference

8-bit unsigned integer pixel traits. More...

#include <PixelTraits.h>

+ Inheritance diagram for pcl::UInt8PixelTraits:

Public Types

typedef traits_type::sample sample
 
typedef GenericPixelTraits< uint8traits_type
 
- Public Types inherited from pcl::GenericPixelTraits< uint8 >
typedef uint8 sample
 

Static Public Member Functions

template<typename T >
static void Add (sample &a, T b)
 
template<typename T >
static void And (sample &a, T b)
 
template<typename T >
static void ColorBurn (sample &a, T b)
 
template<typename T >
static void ColorDodge (sample &a, T b)
 
template<typename T >
static void Dif (sample &a, T b)
 
template<typename T >
static void Div (sample &a, T b)
 
static void Div (sample &a, float b)
 
static void Div (sample &a, double b)
 
static void Div (sample &a, pcl::Complex< float > b)
 
static void Div (sample &a, pcl::Complex< double > b)
 
template<typename T >
static void Exclusion (sample &a, T b)
 
template<typename T >
static sample FloatToSample (T x)
 
static void FromSample (uint8 &a, sample b)
 
static void FromSample (int8 &a, sample b)
 
static void FromSample (uint16 &a, sample b)
 
static void FromSample (int16 &a, sample b)
 
static void FromSample (uint32 &a, sample b)
 
static void FromSample (int32 &a, sample b)
 
static void FromSample (float &a, sample b)
 
static void FromSample (double &a, sample b)
 
template<typename T >
static void FromSample (Complex< T > &a, sample b)
 
template<typename T >
static void HardLight (sample &a, T b)
 
static constexpr bool IsComplexSample ()
 
static constexpr bool IsFloatSample ()
 
template<typename T >
static void LinearBurn (sample &a, T b)
 
template<typename T >
static void LinearLight (sample &a, T b)
 
template<typename T >
static void Max (sample &a, T b)
 
static constexpr sample MaxSampleValue ()
 
template<typename T >
static void Min (sample &a, T b)
 
template<typename T >
static void Mov (sample &a, T b)
 
template<typename T >
static void Mul (sample &a, T b)
 
static void Mul (sample &a, float b)
 
static void Mul (sample &a, double b)
 
static void Mul (sample &a, pcl::Complex< float > b)
 
static void Mul (sample &a, pcl::Complex< double > b)
 
template<typename T >
static void Nand (sample &a, T b)
 
template<typename T >
static void Nor (sample &a, T b)
 
static void Not (sample &a)
 
template<typename T >
static void Not (sample &a, T b)
 
template<typename T >
static void Or (sample &a, T b)
 
template<typename T >
static void Overlay (sample &a, T b)
 
template<typename T >
static void PinLight (sample &a, T b)
 
template<typename T >
static void Pow (sample &a, T b)
 
static void Pow (sample &a, float b)
 
static void Pow (sample &a, double b)
 
static void Pow (sample &a, pcl::Complex< float > b)
 
static void Pow (sample &a, pcl::Complex< double > b)
 
static constexpr const char * SampleFormat ()
 
template<typename T >
static void Screen (sample &a, T b)
 
template<typename T >
static void SoftLight (sample &a, T b)
 
template<typename T >
static void Sub (sample &a, T b)
 
static constexpr sample ToSample (uint8 x)
 
static constexpr sample ToSample (int8 x)
 
static sample ToSample (uint16 x)
 
static sample ToSample (int16 x)
 
static sample ToSample (uint32 x)
 
static sample ToSample (int32 x)
 
static sample ToSample (float x)
 
static sample ToSample (double x)
 
template<typename T >
static sample ToSample (const Complex< T > &x)
 
static sample ToSampleConstrained (float x)
 
static sample ToSampleConstrained (double x)
 
template<typename T >
static void VividLight (sample &a, T b)
 
template<typename T >
static void Xnor (sample &a, T b)
 
template<typename T >
static void Xor (sample &a, T b)
 
- Static Public Member Functions inherited from pcl::GenericPixelTraits< uint8 >
static constexpr int BitsPerSample ()
 
static constexpr int BytesPerSample ()
 
static constexpr sample MinSampleValue ()
 

Detailed Description

UInt8PixelTraits is a template instantiation of GenericPixelTraits for the uint8 type. It defines the characteristic properties and functionality of 8-bit unsigned integer pixel samples.

See also
GenericPixelTraits, GenericImage, UInt8Image

Definition at line 2949 of file PixelTraits.h.

Member Typedef Documentation

◆ sample

Represents a pixel sample value.

Definition at line 2961 of file PixelTraits.h.

◆ traits_type

Represents this template instantiation.

Definition at line 2956 of file PixelTraits.h.

Member Function Documentation

◆ Add()

template<typename T >
static void pcl::UInt8PixelTraits::Add ( sample a,
b 
)
inlinestatic

Adds a T value b to a pixel sample variable a, with implicit data type conversion.

Definition at line 3231 of file PixelTraits.h.

◆ And()

template<typename T >
static void pcl::UInt8PixelTraits::And ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the bitwise AND operation with a T value b. The bitwise AND operation is performed after converting the right-hand side operand b to the pixel sample type.

Definition at line 3437 of file PixelTraits.h.

◆ ColorBurn()

template<typename T >
static void pcl::UInt8PixelTraits::ColorBurn ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the color burn standard composition operation of its current value and a T value b, with implicit data type conversion.

Definition at line 3500 of file PixelTraits.h.

◆ ColorDodge()

template<typename T >
static void pcl::UInt8PixelTraits::ColorDodge ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the color dodge standard composition operation of its current value and a T value b, with implicit data type conversion.

Definition at line 3575 of file PixelTraits.h.

◆ Dif()

template<typename T >
static void pcl::UInt8PixelTraits::Dif ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a its absolute difference with a T value b, with implicit data type conversion.

Definition at line 3383 of file PixelTraits.h.

◆ Div() [1/5]

template<typename T >
static void pcl::UInt8PixelTraits::Div ( sample a,
b 
)
inlinestatic

Divides a pixel sample variable a by a T value b, with implicit data type conversion.

Definition at line 3297 of file PixelTraits.h.

◆ Div() [2/5]

static void pcl::UInt8PixelTraits::Div ( sample a,
float  b 
)
inlinestatic

#

Definition at line 3304 of file PixelTraits.h.

◆ Div() [3/5]

static void pcl::UInt8PixelTraits::Div ( sample a,
double  b 
)
inlinestatic

#

Definition at line 3312 of file PixelTraits.h.

◆ Div() [4/5]

static void pcl::UInt8PixelTraits::Div ( sample a,
pcl::Complex< float >  b 
)
inlinestatic

#

Definition at line 3320 of file PixelTraits.h.

◆ Div() [5/5]

static void pcl::UInt8PixelTraits::Div ( sample a,
pcl::Complex< double >  b 
)
inlinestatic

#

Definition at line 3328 of file PixelTraits.h.

◆ Exclusion()

template<typename T >
static void pcl::UInt8PixelTraits::Exclusion ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the exclusion standard composition operation of its current value and a T value b, with implicit data type conversion.

Definition at line 3750 of file PixelTraits.h.

◆ FloatToSample()

template<typename T >
static sample pcl::UInt8PixelTraits::FloatToSample ( x)
inlinestatic

Conversion of any floating point value to a pixel sample value.

Definition at line 3006 of file PixelTraits.h.

◆ FromSample() [1/9]

static void pcl::UInt8PixelTraits::FromSample ( uint8 a,
sample  b 
)
inlinestatic

Conversion of a pixel sample value to an 8-bit unsigned integer.

Definition at line 3120 of file PixelTraits.h.

◆ FromSample() [2/9]

static void pcl::UInt8PixelTraits::FromSample ( int8 a,
sample  b 
)
inlinestatic

Conversion of a pixel sample value to an 8-bit signed integer.

Definition at line 3128 of file PixelTraits.h.

◆ FromSample() [3/9]

static void pcl::UInt8PixelTraits::FromSample ( uint16 a,
sample  b 
)
inlinestatic

Conversion of a pixel sample value to a 16-bit unsigned integer.

Definition at line 3136 of file PixelTraits.h.

◆ FromSample() [4/9]

static void pcl::UInt8PixelTraits::FromSample ( int16 a,
sample  b 
)
inlinestatic

Conversion of a pixel sample value to a 16-bit signed integer.

Definition at line 3148 of file PixelTraits.h.

◆ FromSample() [5/9]

static void pcl::UInt8PixelTraits::FromSample ( uint32 a,
sample  b 
)
inlinestatic

Conversion of a pixel sample value to a 32-bit unsigned integer.

Definition at line 3160 of file PixelTraits.h.

◆ FromSample() [6/9]

static void pcl::UInt8PixelTraits::FromSample ( int32 a,
sample  b 
)
inlinestatic

Conversion of a pixel sample value to a 32-bit signed integer.

Definition at line 3172 of file PixelTraits.h.

◆ FromSample() [7/9]

static void pcl::UInt8PixelTraits::FromSample ( float &  a,
sample  b 
)
inlinestatic

Conversion of a pixel sample value to a 32-bit floating point real.

Definition at line 3184 of file PixelTraits.h.

◆ FromSample() [8/9]

static void pcl::UInt8PixelTraits::FromSample ( double &  a,
sample  b 
)
inlinestatic

Conversion of a pixel sample value to a 64-bit floating point real.

Definition at line 3196 of file PixelTraits.h.

◆ FromSample() [9/9]

template<typename T >
static void pcl::UInt8PixelTraits::FromSample ( Complex< T > &  a,
sample  b 
)
inlinestatic

Conversion of a pixel sample value to any complex type.

Definition at line 3209 of file PixelTraits.h.

◆ HardLight()

template<typename T >
static void pcl::UInt8PixelTraits::HardLight ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the hard light standard composition operation of its current value and a T value b, with implicit data type conversion.

Definition at line 3650 of file PixelTraits.h.

◆ IsComplexSample()

static constexpr bool pcl::UInt8PixelTraits::IsComplexSample ( )
inlinestatic

Returns true if this pixel traits class corresponds to a complex pixel sample type; false if it represents a real pixel sample type.

Definition at line 2976 of file PixelTraits.h.

◆ IsFloatSample()

static constexpr bool pcl::UInt8PixelTraits::IsFloatSample ( )
inlinestatic

Returns true iff this pixel traits class corresponds to a floating point real pixel sample type.

Definition at line 2967 of file PixelTraits.h.

◆ LinearBurn()

template<typename T >
static void pcl::UInt8PixelTraits::LinearBurn ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the linear burn standard composition operation of its current value and a T value b, with implicit data type conversion.

Definition at line 3525 of file PixelTraits.h.

◆ LinearLight()

template<typename T >
static void pcl::UInt8PixelTraits::LinearLight ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the linear light standard composition operation of its current value and a T value b, with implicit data type conversion.

Definition at line 3700 of file PixelTraits.h.

◆ Max()

template<typename T >
static void pcl::UInt8PixelTraits::Max ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the maximum of its current value and a T value b, with implicit data type conversion.

Definition at line 3404 of file PixelTraits.h.

◆ MaxSampleValue()

static constexpr sample pcl::UInt8PixelTraits::MaxSampleValue ( )
inlinestatic

Returns the maximum valid pixel sample value.

For UInt8PixelTraits, this member function returns 255.

Definition at line 2997 of file PixelTraits.h.

References uint8_max.

◆ Min()

template<typename T >
static void pcl::UInt8PixelTraits::Min ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the minimum of its current value and a T value b, with implicit data type conversion.

Definition at line 3394 of file PixelTraits.h.

◆ Mov()

template<typename T >
static void pcl::UInt8PixelTraits::Mov ( sample a,
b 
)
inlinestatic

Copies a T value b to a pixel sample variable a, with implicit conversion from the source data type T to the pixel sample type.

Definition at line 3221 of file PixelTraits.h.

◆ Mul() [1/5]

template<typename T >
static void pcl::UInt8PixelTraits::Mul ( sample a,
b 
)
inlinestatic

Multiplies a pixel sample variable a by a T value b, with implicit data type conversion.

Definition at line 3253 of file PixelTraits.h.

◆ Mul() [2/5]

static void pcl::UInt8PixelTraits::Mul ( sample a,
float  b 
)
inlinestatic

#

Definition at line 3262 of file PixelTraits.h.

◆ Mul() [3/5]

static void pcl::UInt8PixelTraits::Mul ( sample a,
double  b 
)
inlinestatic

#

Definition at line 3270 of file PixelTraits.h.

◆ Mul() [4/5]

static void pcl::UInt8PixelTraits::Mul ( sample a,
pcl::Complex< float >  b 
)
inlinestatic

#

Definition at line 3278 of file PixelTraits.h.

◆ Mul() [5/5]

static void pcl::UInt8PixelTraits::Mul ( sample a,
pcl::Complex< double >  b 
)
inlinestatic

#

Definition at line 3286 of file PixelTraits.h.

◆ Nand()

template<typename T >
static void pcl::UInt8PixelTraits::Nand ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the bitwise NAND operation with a T value b. The bitwise NAND operation is performed after converting the right-hand side operand b to the pixel sample type.

Definition at line 3467 of file PixelTraits.h.

◆ Nor()

template<typename T >
static void pcl::UInt8PixelTraits::Nor ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the bitwise inclusive NOR operation with a T value b. The bitwise NOR operation is performed after converting the right-hand side operand b to the pixel sample type.

Definition at line 3426 of file PixelTraits.h.

◆ Not() [1/2]

static void pcl::UInt8PixelTraits::Not ( sample a)
inlinestatic

Negates (bitwise NOT operation) a pixel sample variable a.

Definition at line 3445 of file PixelTraits.h.

◆ Not() [2/2]

template<typename T >
static void pcl::UInt8PixelTraits::Not ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the bitwise negation (NOT operation) of a T value b. Bitwise negation is performed after converting the right-hand side operand b to the pixel sample type.

Definition at line 3456 of file PixelTraits.h.

◆ Or()

template<typename T >
static void pcl::UInt8PixelTraits::Or ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the bitwise inclusive OR operation with a T value b. The bitwise OR operation is performed after converting the right-hand side operand b to the pixel sample type.

Definition at line 3415 of file PixelTraits.h.

◆ Overlay()

template<typename T >
static void pcl::UInt8PixelTraits::Overlay ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the overlay standard composition operation of its current value and a T value b, with implicit data type conversion.

Definition at line 3600 of file PixelTraits.h.

◆ PinLight()

template<typename T >
static void pcl::UInt8PixelTraits::PinLight ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the pin light standard composition operation of its current value and a T value b, with implicit data type conversion.

Definition at line 3725 of file PixelTraits.h.

◆ Pow() [1/5]

template<typename T >
static void pcl::UInt8PixelTraits::Pow ( sample a,
b 
)
inlinestatic

Raises a pixel sample variable a to a T exponent value b, with implicit data type conversion.

Definition at line 3339 of file PixelTraits.h.

◆ Pow() [2/5]

static void pcl::UInt8PixelTraits::Pow ( sample a,
float  b 
)
inlinestatic

#

Definition at line 3348 of file PixelTraits.h.

◆ Pow() [3/5]

static void pcl::UInt8PixelTraits::Pow ( sample a,
double  b 
)
inlinestatic

#

Definition at line 3356 of file PixelTraits.h.

◆ Pow() [4/5]

static void pcl::UInt8PixelTraits::Pow ( sample a,
pcl::Complex< float >  b 
)
inlinestatic

#

Definition at line 3364 of file PixelTraits.h.

◆ Pow() [5/5]

static void pcl::UInt8PixelTraits::Pow ( sample a,
pcl::Complex< double >  b 
)
inlinestatic

#

Definition at line 3372 of file PixelTraits.h.

◆ SampleFormat()

static constexpr const char* pcl::UInt8PixelTraits::SampleFormat ( )
inlinestatic

Returns the address of a static null-terminated string identifying the sample data type represented by this pixel traits class.

For UInt8PixelTraits, this member function returns "UInt8".

Definition at line 2987 of file PixelTraits.h.

◆ Screen()

template<typename T >
static void pcl::UInt8PixelTraits::Screen ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the screen standard composition operation of its current value and a T value b, with implicit data type conversion.

Definition at line 3550 of file PixelTraits.h.

◆ SoftLight()

template<typename T >
static void pcl::UInt8PixelTraits::SoftLight ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the soft light standard composition operation of its current value and a T value b, with implicit data type conversion.

Definition at line 3625 of file PixelTraits.h.

◆ Sub()

template<typename T >
static void pcl::UInt8PixelTraits::Sub ( sample a,
b 
)
inlinestatic

Subtracts a T value b from a pixel sample variable a, with implicit data type conversion.

Definition at line 3242 of file PixelTraits.h.

◆ ToSample() [1/9]

static constexpr sample pcl::UInt8PixelTraits::ToSample ( uint8  x)
inlinestatic

Conversion of an 8-bit unsigned integer value to a pixel sample value.

Definition at line 3019 of file PixelTraits.h.

◆ ToSample() [2/9]

static constexpr sample pcl::UInt8PixelTraits::ToSample ( int8  x)
inlinestatic

Conversion of an 8-bit signed integer value to a pixel sample value.

Definition at line 3027 of file PixelTraits.h.

References int8_min.

◆ ToSample() [3/9]

static sample pcl::UInt8PixelTraits::ToSample ( uint16  x)
inlinestatic

Conversion of a 16-bit unsigned integer value to a pixel sample value.

Definition at line 3035 of file PixelTraits.h.

References pcl::Round(), and uint16_to_uint8.

◆ ToSample() [4/9]

static sample pcl::UInt8PixelTraits::ToSample ( int16  x)
inlinestatic

Conversion of a 16-bit signed integer value to a pixel sample value.

Definition at line 3047 of file PixelTraits.h.

References int16_min, pcl::Round(), and uint16_to_uint8.

◆ ToSample() [5/9]

static sample pcl::UInt8PixelTraits::ToSample ( uint32  x)
inlinestatic

Conversion of a 32-bit unsigned integer value to a pixel sample value.

Definition at line 3059 of file PixelTraits.h.

References pcl::Round(), and uint32_to_uint8.

◆ ToSample() [6/9]

static sample pcl::UInt8PixelTraits::ToSample ( int32  x)
inlinestatic

Conversion of a 32-bit signed integer value to a pixel sample value.

Definition at line 3067 of file PixelTraits.h.

References int32_min, pcl::Round(), and uint32_to_uint8.

◆ ToSample() [7/9]

static sample pcl::UInt8PixelTraits::ToSample ( float  x)
inlinestatic

Conversion of a 32-bit floating point value to a pixel sample value.

Definition at line 3075 of file PixelTraits.h.

References uint8_max.

◆ ToSample() [8/9]

static sample pcl::UInt8PixelTraits::ToSample ( double  x)
inlinestatic

Conversion of a 64-bit floating point value to a pixel sample value.

Definition at line 3093 of file PixelTraits.h.

References uint8_max.

◆ ToSample() [9/9]

template<typename T >
static sample pcl::UInt8PixelTraits::ToSample ( const Complex< T > &  x)
inlinestatic

Conversion of any complex value to a pixel sample value.

Definition at line 3112 of file PixelTraits.h.

References pcl::Abs().

◆ ToSampleConstrained() [1/2]

static sample pcl::UInt8PixelTraits::ToSampleConstrained ( float  x)
inlinestatic

Conversion of a 32-bit floating point value to a pixel sample value. This function guarantees that the result will never overflow as a result of an out-of-range argument value.

Definition at line 3085 of file PixelTraits.h.

References pcl::Range().

◆ ToSampleConstrained() [2/2]

static sample pcl::UInt8PixelTraits::ToSampleConstrained ( double  x)
inlinestatic

Conversion of a 64-bit floating point value to a pixel sample value. This function guarantees that the result will never overflow as a result of an out-of-range argument value.

Definition at line 3103 of file PixelTraits.h.

References pcl::Range(), and uint8_max.

◆ VividLight()

template<typename T >
static void pcl::UInt8PixelTraits::VividLight ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the vivid light standard composition operation of its current value and a T value b, with implicit data type conversion.

Definition at line 3675 of file PixelTraits.h.

◆ Xnor()

template<typename T >
static void pcl::UInt8PixelTraits::Xnor ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the bitwise exclusive NOR (XNOR) operation with a T value b. The bitwise XNOR operation is performed after converting the right-hand side operand b to the pixel sample type.

Definition at line 3489 of file PixelTraits.h.

◆ Xor()

template<typename T >
static void pcl::UInt8PixelTraits::Xor ( sample a,
b 
)
inlinestatic

Assigns to a pixel sample variable a the bitwise exclusive OR (XOR) operation with a T value b. The bitwise XOR operation is performed after converting the right-hand side operand b to the pixel sample type.

Definition at line 3478 of file PixelTraits.h.


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