PCL
pcl::UInt16PixelTraits Class Reference

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

#include <PixelTraits.h>

+ Inheritance diagram for pcl::UInt16PixelTraits:

Public Types

typedef traits_type::sample sample
 
typedef GenericPixelTraits< uint16traits_type
 
- Public Types inherited from pcl::GenericPixelTraits< uint16 >
typedef uint16 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 sample ToSample (uint8 x)
 
static sample ToSample (int8 x)
 
static constexpr sample ToSample (uint16 x)
 
static constexpr 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 constexpr 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< uint16 >
static constexpr int BitsPerSample ()
 
static constexpr int BytesPerSample ()
 
static constexpr sample MinSampleValue ()
 

Detailed Description

UInt16PixelTraits is a template instantiation of GenericPixelTraits for the uint16 type. It defines the characteristic properties and functionality of 16-bit unsigned integer pixel samples.

See also
GenericPixelTraits, GenericImage, UInt16Image

Definition at line 3786 of file PixelTraits.h.

Member Typedef Documentation

◆ sample

Represents a pixel sample value.

Definition at line 3798 of file PixelTraits.h.

◆ traits_type

Represents this template instantiation.

Definition at line 3793 of file PixelTraits.h.

Member Function Documentation

◆ Add()

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

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

Definition at line 4068 of file PixelTraits.h.

◆ And()

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

◆ ColorBurn()

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

◆ ColorDodge()

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

◆ Dif()

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

◆ Div() [1/5]

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

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

Definition at line 4134 of file PixelTraits.h.

◆ Div() [2/5]

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

#

Definition at line 4141 of file PixelTraits.h.

◆ Div() [3/5]

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

#

Definition at line 4149 of file PixelTraits.h.

◆ Div() [4/5]

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

#

Definition at line 4157 of file PixelTraits.h.

◆ Div() [5/5]

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

#

Definition at line 4165 of file PixelTraits.h.

◆ Exclusion()

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

◆ FloatToSample()

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

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

Definition at line 3843 of file PixelTraits.h.

◆ FromSample() [1/9]

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

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

Definition at line 3957 of file PixelTraits.h.

◆ FromSample() [2/9]

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

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

Definition at line 3969 of file PixelTraits.h.

◆ FromSample() [3/9]

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

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

Definition at line 3981 of file PixelTraits.h.

◆ FromSample() [4/9]

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

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

Definition at line 3989 of file PixelTraits.h.

◆ FromSample() [5/9]

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

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

Definition at line 3997 of file PixelTraits.h.

◆ FromSample() [6/9]

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

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

Definition at line 4009 of file PixelTraits.h.

◆ FromSample() [7/9]

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

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

Definition at line 4021 of file PixelTraits.h.

◆ FromSample() [8/9]

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

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

Definition at line 4033 of file PixelTraits.h.

◆ FromSample() [9/9]

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

Conversion of a pixel sample value to any complex type.

Definition at line 4046 of file PixelTraits.h.

◆ HardLight()

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

◆ IsComplexSample()

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

◆ IsFloatSample()

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

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

Definition at line 3804 of file PixelTraits.h.

◆ LinearBurn()

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

◆ LinearLight()

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

◆ Max()

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

◆ MaxSampleValue()

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

Returns the maximum valid pixel sample value.

For UInt16PixelTraits, this member function returns 65535.

Definition at line 3834 of file PixelTraits.h.

References uint16_max.

◆ Min()

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

◆ Mov()

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

◆ Mul() [1/5]

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

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

Definition at line 4090 of file PixelTraits.h.

◆ Mul() [2/5]

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

#

Definition at line 4099 of file PixelTraits.h.

◆ Mul() [3/5]

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

#

Definition at line 4107 of file PixelTraits.h.

◆ Mul() [4/5]

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

#

Definition at line 4115 of file PixelTraits.h.

◆ Mul() [5/5]

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

#

Definition at line 4123 of file PixelTraits.h.

◆ Nand()

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

◆ Nor()

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

◆ Not() [1/2]

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

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

Definition at line 4282 of file PixelTraits.h.

◆ Not() [2/2]

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

◆ Or()

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

◆ Overlay()

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

◆ PinLight()

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

◆ Pow() [1/5]

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

◆ Pow() [2/5]

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

#

Definition at line 4185 of file PixelTraits.h.

◆ Pow() [3/5]

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

#

Definition at line 4193 of file PixelTraits.h.

◆ Pow() [4/5]

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

#

Definition at line 4201 of file PixelTraits.h.

◆ Pow() [5/5]

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

#

Definition at line 4209 of file PixelTraits.h.

◆ SampleFormat()

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

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

For UInt16PixelTraits, this member function returns "UInt16".

Definition at line 3824 of file PixelTraits.h.

◆ Screen()

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

◆ SoftLight()

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

◆ Sub()

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

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

Definition at line 4079 of file PixelTraits.h.

◆ ToSample() [1/9]

static sample pcl::UInt16PixelTraits::ToSample ( uint8  x)
inlinestatic

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

Definition at line 3856 of file PixelTraits.h.

References uint8_to_uint16.

◆ ToSample() [2/9]

static sample pcl::UInt16PixelTraits::ToSample ( int8  x)
inlinestatic

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

Definition at line 3868 of file PixelTraits.h.

References int8_min, and uint8_to_uint16.

◆ ToSample() [3/9]

static constexpr sample pcl::UInt16PixelTraits::ToSample ( uint16  x)
inlinestatic

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

Definition at line 3880 of file PixelTraits.h.

◆ ToSample() [4/9]

static constexpr sample pcl::UInt16PixelTraits::ToSample ( int16  x)
inlinestatic

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

Definition at line 3888 of file PixelTraits.h.

References int16_min.

◆ ToSample() [5/9]

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

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

Definition at line 3896 of file PixelTraits.h.

References pcl::Round(), and uint32_to_uint16.

◆ ToSample() [6/9]

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

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

Definition at line 3904 of file PixelTraits.h.

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

◆ ToSample() [7/9]

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

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

Definition at line 3912 of file PixelTraits.h.

References uint16_max.

◆ ToSample() [8/9]

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

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

Definition at line 3930 of file PixelTraits.h.

References uint16_max.

◆ ToSample() [9/9]

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

Conversion of any complex value to a pixel sample value.

Definition at line 3949 of file PixelTraits.h.

References pcl::Abs().

◆ ToSampleConstrained() [1/2]

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

References pcl::Range().

◆ ToSampleConstrained() [2/2]

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

References pcl::Range(), and uint16_max.

◆ VividLight()

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

◆ Xnor()

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

◆ Xor()

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


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