PCL
pcl::UInt8PixelTraits Class Reference

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

#include <PixelTraits.h>

+ Inheritance diagram for pcl::UInt8PixelTraits:

Public Types

using component = sample
 
using sample = traits_type::sample
 
using traits_type = GenericPixelTraits< uint8 >
 
- Public Types inherited from pcl::GenericPixelTraits< uint8 >
using sample = uint8
 

Static Public Member Functions

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

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 3069 of file PixelTraits.h.

Member Typedef Documentation

◆ component

Represents a component of a complex pixel sample, or a pixel sample value for real pixel sample types. For UInt8PixelTraits, this is equivalent to uint8.

Definition at line 3088 of file PixelTraits.h.

◆ sample

Represents a pixel sample value.

Definition at line 3081 of file PixelTraits.h.

◆ traits_type

Represents this template instantiation.

Definition at line 3076 of file PixelTraits.h.

Member Function Documentation

◆ Add()

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

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

Definition at line 3378 of file PixelTraits.h.

◆ And()

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

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 3584 of file PixelTraits.h.

◆ ColorBurn()

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

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 3647 of file PixelTraits.h.

◆ ColorDodge()

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

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 3722 of file PixelTraits.h.

◆ Dif()

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

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

Definition at line 3530 of file PixelTraits.h.

◆ Div() [1/5]

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

#

Definition at line 3459 of file PixelTraits.h.

◆ Div() [2/5]

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

#

Definition at line 3451 of file PixelTraits.h.

◆ Div() [3/5]

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

#

Definition at line 3475 of file PixelTraits.h.

◆ Div() [4/5]

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

#

Definition at line 3467 of file PixelTraits.h.

◆ Div() [5/5]

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

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

Definition at line 3444 of file PixelTraits.h.

◆ Exclusion()

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

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 3897 of file PixelTraits.h.

◆ FloatToSample()

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

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

Definition at line 3153 of file PixelTraits.h.

◆ FromSample() [1/9]

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

Conversion of a pixel sample value to any complex type.

Definition at line 3356 of file PixelTraits.h.

◆ FromSample() [2/9]

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

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

Definition at line 3343 of file PixelTraits.h.

◆ FromSample() [3/9]

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

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

Definition at line 3331 of file PixelTraits.h.

◆ FromSample() [4/9]

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

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

Definition at line 3295 of file PixelTraits.h.

◆ FromSample() [5/9]

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

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

Definition at line 3319 of file PixelTraits.h.

◆ FromSample() [6/9]

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

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

Definition at line 3275 of file PixelTraits.h.

◆ FromSample() [7/9]

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

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

Definition at line 3283 of file PixelTraits.h.

◆ FromSample() [8/9]

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

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

Definition at line 3307 of file PixelTraits.h.

◆ FromSample() [9/9]

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

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

Definition at line 3267 of file PixelTraits.h.

◆ HardLight()

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

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 3797 of file PixelTraits.h.

◆ HighestSampleValue()

static constexpr sample pcl::UInt8PixelTraits::HighestSampleValue ( )
inlinestaticconstexprnoexcept

Returns the highest finite value representable by this pixel sample type.

For UInt8PixelTraits, this member function returns 255.

Definition at line 3144 of file PixelTraits.h.

References uint8_max.

◆ IsComplexSample()

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

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 3103 of file PixelTraits.h.

◆ IsFloatSample()

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

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

Definition at line 3094 of file PixelTraits.h.

◆ LinearBurn()

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

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 3672 of file PixelTraits.h.

◆ LinearLight()

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

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 3847 of file PixelTraits.h.

◆ LowestSampleValue()

static constexpr sample pcl::UInt8PixelTraits::LowestSampleValue ( )
inlinestaticconstexprnoexcept

Returns the lowest finite value representable by this pixel sample type.

For UInt8PixelTraits, this member function returns 0.

Definition at line 3134 of file PixelTraits.h.

◆ Max()

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

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 3551 of file PixelTraits.h.

◆ MaxSampleValue()

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

Returns the maximum valid pixel sample value.

For UInt8PixelTraits, this member function returns 255.

Definition at line 3124 of file PixelTraits.h.

References uint8_max.

◆ Min()

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

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 3541 of file PixelTraits.h.

◆ Mov()

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

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 3368 of file PixelTraits.h.

◆ Mul() [1/5]

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

#

Definition at line 3417 of file PixelTraits.h.

◆ Mul() [2/5]

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

#

Definition at line 3409 of file PixelTraits.h.

◆ Mul() [3/5]

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

#

Definition at line 3433 of file PixelTraits.h.

◆ Mul() [4/5]

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

#

Definition at line 3425 of file PixelTraits.h.

◆ Mul() [5/5]

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

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

Definition at line 3400 of file PixelTraits.h.

◆ Nand()

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

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 3614 of file PixelTraits.h.

◆ Nor()

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

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 3573 of file PixelTraits.h.

◆ Not() [1/2]

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

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

Definition at line 3592 of file PixelTraits.h.

◆ Not() [2/2]

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

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 3603 of file PixelTraits.h.

◆ Or()

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

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 3562 of file PixelTraits.h.

◆ Overlay()

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

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 3747 of file PixelTraits.h.

◆ PinLight()

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

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 3872 of file PixelTraits.h.

◆ Pow() [1/5]

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

#

Definition at line 3503 of file PixelTraits.h.

◆ Pow() [2/5]

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

#

Definition at line 3495 of file PixelTraits.h.

◆ Pow() [3/5]

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

#

Definition at line 3519 of file PixelTraits.h.

◆ Pow() [4/5]

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

#

Definition at line 3511 of file PixelTraits.h.

◆ Pow() [5/5]

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

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

Definition at line 3486 of file PixelTraits.h.

◆ SampleFormat()

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

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 3114 of file PixelTraits.h.

◆ Screen()

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

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 3697 of file PixelTraits.h.

◆ SoftLight()

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

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 3772 of file PixelTraits.h.

◆ Sub()

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

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

Definition at line 3389 of file PixelTraits.h.

◆ ToSample() [1/9]

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

Conversion of any complex value to a pixel sample value.

Definition at line 3259 of file PixelTraits.h.

References pcl::Abs().

◆ ToSample() [2/9]

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

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

Definition at line 3240 of file PixelTraits.h.

References uint8_max.

◆ ToSample() [3/9]

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

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

Definition at line 3222 of file PixelTraits.h.

References uint8_max.

◆ ToSample() [4/9]

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

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

Definition at line 3194 of file PixelTraits.h.

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

◆ ToSample() [5/9]

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

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

Definition at line 3214 of file PixelTraits.h.

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

◆ ToSample() [6/9]

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

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

Definition at line 3174 of file PixelTraits.h.

References int8_min.

◆ ToSample() [7/9]

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

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

Definition at line 3182 of file PixelTraits.h.

References pcl::Round(), and uint16_to_uint8.

◆ ToSample() [8/9]

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

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

Definition at line 3206 of file PixelTraits.h.

References pcl::Round(), and uint32_to_uint8.

◆ ToSample() [9/9]

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

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

Definition at line 3166 of file PixelTraits.h.

◆ ToSampleConstrained() [1/2]

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

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 3250 of file PixelTraits.h.

References pcl::Range(), and uint8_max.

◆ ToSampleConstrained() [2/2]

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

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 3232 of file PixelTraits.h.

References pcl::Range(), and uint8_max.

◆ VividLight()

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

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 3822 of file PixelTraits.h.

◆ Xnor()

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

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 3636 of file PixelTraits.h.

◆ Xor()

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

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 3625 of file PixelTraits.h.


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