PCL
pcl::UInt32PixelTraits Class Reference

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

#include <PixelTraits.h>

+ Inheritance diagram for pcl::UInt32PixelTraits:

Public Types

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

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 constexpr sample ToSample (int32 x) noexcept
 
static sample ToSample (int8 x) noexcept
 
static sample ToSample (uint16 x) noexcept
 
static constexpr sample ToSample (uint32 x) noexcept
 
static 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< uint32 >
static constexpr int BitsPerSample () noexcept
 
static constexpr int BytesPerSample () noexcept
 
static constexpr sample MinSampleValue () noexcept
 

Detailed Description

UInt32PixelTraits is a template instantiation of GenericPixelTraits for the uint32 type. It defines the characteristic properties and functionality of 32-bit unsigned integer pixel samples.

See also
GenericPixelTraits, GenericImage, UInt32Image

Definition at line 4797 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 UInt32PixelTraits, this is equivalent to uint32.

Definition at line 4816 of file PixelTraits.h.

◆ sample

Represents a pixel sample value.

Definition at line 4809 of file PixelTraits.h.

◆ traits_type

Represents this template instantiation.

Definition at line 4804 of file PixelTraits.h.

Member Function Documentation

◆ Add()

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

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

Definition at line 5090 of file PixelTraits.h.

◆ And()

template<typename T >
static void pcl::UInt32PixelTraits::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 5296 of file PixelTraits.h.

◆ ColorBurn()

template<typename T >
static void pcl::UInt32PixelTraits::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 5359 of file PixelTraits.h.

◆ ColorDodge()

template<typename T >
static void pcl::UInt32PixelTraits::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 5434 of file PixelTraits.h.

◆ Dif()

template<typename T >
static void pcl::UInt32PixelTraits::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 5242 of file PixelTraits.h.

◆ Div() [1/5]

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

#

Definition at line 5171 of file PixelTraits.h.

◆ Div() [2/5]

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

#

Definition at line 5163 of file PixelTraits.h.

◆ Div() [3/5]

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

#

Definition at line 5187 of file PixelTraits.h.

◆ Div() [4/5]

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

#

Definition at line 5179 of file PixelTraits.h.

◆ Div() [5/5]

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

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

Definition at line 5156 of file PixelTraits.h.

◆ Exclusion()

template<typename T >
static void pcl::UInt32PixelTraits::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 5614 of file PixelTraits.h.

◆ FloatToSample()

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

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

Definition at line 4881 of file PixelTraits.h.

◆ FromSample() [1/9]

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

Conversion of a pixel sample value to any complex type.

Definition at line 5068 of file PixelTraits.h.

◆ FromSample() [2/9]

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

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

Definition at line 5059 of file PixelTraits.h.

◆ FromSample() [3/9]

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

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

Definition at line 5051 of file PixelTraits.h.

◆ FromSample() [4/9]

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

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

Definition at line 5027 of file PixelTraits.h.

◆ FromSample() [5/9]

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

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

Definition at line 5043 of file PixelTraits.h.

◆ FromSample() [6/9]

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

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

Definition at line 5011 of file PixelTraits.h.

◆ FromSample() [7/9]

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

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

Definition at line 5019 of file PixelTraits.h.

◆ FromSample() [8/9]

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

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

Definition at line 5035 of file PixelTraits.h.

◆ FromSample() [9/9]

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

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

Definition at line 5003 of file PixelTraits.h.

◆ HardLight()

template<typename T >
static void pcl::UInt32PixelTraits::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 5510 of file PixelTraits.h.

◆ HighestSampleValue()

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

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

For UInt32PixelTraits, this member function returns 4294967295.

Definition at line 4872 of file PixelTraits.h.

References uint32_max.

◆ IsComplexSample()

static constexpr bool pcl::UInt32PixelTraits::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 4831 of file PixelTraits.h.

◆ IsFloatSample()

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

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

Definition at line 4822 of file PixelTraits.h.

◆ LinearBurn()

template<typename T >
static void pcl::UInt32PixelTraits::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 5384 of file PixelTraits.h.

◆ LinearLight()

template<typename T >
static void pcl::UInt32PixelTraits::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 5562 of file PixelTraits.h.

◆ LowestSampleValue()

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

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

For UInt32PixelTraits, this member function returns 0.

Definition at line 4862 of file PixelTraits.h.

◆ Max()

template<typename T >
static void pcl::UInt32PixelTraits::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 5263 of file PixelTraits.h.

◆ MaxSampleValue()

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

Returns the maximum valid pixel sample value.

For UInt32PixelTraits, this member function returns 4294967295.

Definition at line 4852 of file PixelTraits.h.

References uint32_max.

◆ Min()

template<typename T >
static void pcl::UInt32PixelTraits::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 5253 of file PixelTraits.h.

◆ Mov()

template<typename T >
static void pcl::UInt32PixelTraits::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 5080 of file PixelTraits.h.

◆ Mul() [1/5]

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

#

Definition at line 5129 of file PixelTraits.h.

◆ Mul() [2/5]

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

#

Definition at line 5121 of file PixelTraits.h.

◆ Mul() [3/5]

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

#

Definition at line 5145 of file PixelTraits.h.

◆ Mul() [4/5]

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

#

Definition at line 5137 of file PixelTraits.h.

◆ Mul() [5/5]

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

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

Definition at line 5112 of file PixelTraits.h.

◆ Nand()

template<typename T >
static void pcl::UInt32PixelTraits::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 5326 of file PixelTraits.h.

◆ Nor()

template<typename T >
static void pcl::UInt32PixelTraits::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 5285 of file PixelTraits.h.

◆ Not() [1/2]

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

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

Definition at line 5304 of file PixelTraits.h.

◆ Not() [2/2]

template<typename T >
static void pcl::UInt32PixelTraits::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 5315 of file PixelTraits.h.

◆ Or()

template<typename T >
static void pcl::UInt32PixelTraits::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 5274 of file PixelTraits.h.

◆ Overlay()

template<typename T >
static void pcl::UInt32PixelTraits::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 5459 of file PixelTraits.h.

◆ PinLight()

template<typename T >
static void pcl::UInt32PixelTraits::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 5588 of file PixelTraits.h.

◆ Pow() [1/5]

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

#

Definition at line 5215 of file PixelTraits.h.

◆ Pow() [2/5]

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

#

Definition at line 5207 of file PixelTraits.h.

◆ Pow() [3/5]

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

#

Definition at line 5231 of file PixelTraits.h.

◆ Pow() [4/5]

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

#

Definition at line 5223 of file PixelTraits.h.

◆ Pow() [5/5]

template<typename T >
static void pcl::UInt32PixelTraits::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 5198 of file PixelTraits.h.

◆ SampleFormat()

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

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

For UInt32PixelTraits, this member function returns "UInt32".

Definition at line 4842 of file PixelTraits.h.

◆ Screen()

template<typename T >
static void pcl::UInt32PixelTraits::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 5409 of file PixelTraits.h.

◆ SoftLight()

template<typename T >
static void pcl::UInt32PixelTraits::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 5484 of file PixelTraits.h.

◆ Sub()

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

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

Definition at line 5101 of file PixelTraits.h.

◆ ToSample() [1/9]

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

Conversion of any complex value to a pixel sample value.

Definition at line 4995 of file PixelTraits.h.

References pcl::Abs().

◆ ToSample() [2/9]

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

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

Definition at line 4976 of file PixelTraits.h.

References uint32_max.

◆ ToSample() [3/9]

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

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

Definition at line 4958 of file PixelTraits.h.

References uint32_max.

◆ ToSample() [4/9]

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

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

Definition at line 4930 of file PixelTraits.h.

References int16_min, and uint16_to_uint32.

◆ ToSample() [5/9]

static constexpr sample pcl::UInt32PixelTraits::ToSample ( int32  x)
inlinestaticconstexprnoexcept

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

Definition at line 4950 of file PixelTraits.h.

References int32_min.

◆ ToSample() [6/9]

static sample pcl::UInt32PixelTraits::ToSample ( int8  x)
inlinestaticnoexcept

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

Definition at line 4906 of file PixelTraits.h.

References int8_min, and uint8_to_uint32.

◆ ToSample() [7/9]

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

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

Definition at line 4918 of file PixelTraits.h.

References uint16_to_uint32.

◆ ToSample() [8/9]

static constexpr sample pcl::UInt32PixelTraits::ToSample ( uint32  x)
inlinestaticconstexprnoexcept

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

Definition at line 4942 of file PixelTraits.h.

◆ ToSample() [9/9]

static sample pcl::UInt32PixelTraits::ToSample ( uint8  x)
inlinestaticnoexcept

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

Definition at line 4894 of file PixelTraits.h.

References uint8_to_uint32.

◆ ToSampleConstrained() [1/2]

static sample pcl::UInt32PixelTraits::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 4986 of file PixelTraits.h.

References pcl::Range(), and uint32_max.

◆ ToSampleConstrained() [2/2]

static sample pcl::UInt32PixelTraits::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 4968 of file PixelTraits.h.

References pcl::Range(), and uint32_max.

◆ VividLight()

template<typename T >
static void pcl::UInt32PixelTraits::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 5536 of file PixelTraits.h.

◆ Xnor()

template<typename T >
static void pcl::UInt32PixelTraits::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 5348 of file PixelTraits.h.

◆ Xor()

template<typename T >
static void pcl::UInt32PixelTraits::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 5337 of file PixelTraits.h.


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