pcl::ComplexPixelTraits Class Reference

32-bit IEEE 754 normalized floating point complex pixel traits. More...

#include <PixelTraits.h>

Inheritance diagram for pcl::ComplexPixelTraits:

Public Types
using	component = sample::component
using	sample = traits_type::sample
using	traits_type = GenericPixelTraits< Complex< float > >
Public Types inherited from pcl::GenericPixelTraits< Complex< float > >
using	sample = Complex< float >

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
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
static void	FromSampl (int8 &a, sample b) 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 (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 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 sample	LowestSampleValue () noexcept
template<typename T >
static void	Max (sample &a, T b) noexcept
static 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
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
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 sample	ToSample (int8 x) noexcept
static sample	ToSample (uint16 x) noexcept
static sample	ToSample (uint32 x) noexcept
static sample	ToSample (uint8 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< Complex< float > >
static constexpr int	BitsPerSample () noexcept
static constexpr int	BytesPerSample () noexcept
static constexpr sample	MinSampleValue () noexcept

Detailed Description

ComplexPixelTraits is a template instantiation of GenericPixelTraits for the Complex<float> type. It defines the characteristic properties and functionality of 32-bit IEEE 754 floating point complex pixel samples.

See also

GenericPixelTraits, GenericImage, ComplexImage

Definition at line 1556 of file PixelTraits.h.

Member Typedef Documentation

component

using pcl::ComplexPixelTraits::component = sample::component

Represents a component of a complex pixel sample. For ComplexPixelTraits, this is equivalent to float.

Definition at line 1574 of file PixelTraits.h.

sample

using pcl::ComplexPixelTraits::sample = traits_type::sample

Represents a pixel sample value.

Definition at line 1568 of file PixelTraits.h.

traits_type

using pcl::ComplexPixelTraits::traits_type = GenericPixelTraits<Complex<float> >

Represents this template instantiation.

Definition at line 1563 of file PixelTraits.h.

Member Function Documentation

Add()

template<typename T >

static void pcl::ComplexPixelTraits::Add ( sample &  a, T  b  )

inlinestaticnoexcept

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

Definition at line 1834 of file PixelTraits.h.

And()

template<typename T >

static void pcl::ComplexPixelTraits::And ( sample &  a, T  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 both operands to 8-bit unsigned integers, then the result is converted to the pixel sample type and assigned to a.

Definition at line 1944 of file PixelTraits.h.

ColorBurn()

template<typename T >

static void pcl::ComplexPixelTraits::ColorBurn ( sample &  a, T  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 2023 of file PixelTraits.h.

ColorDodge()

template<typename T >

static void pcl::ComplexPixelTraits::ColorDodge ( sample &  a, T  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 2098 of file PixelTraits.h.

Dif()

template<typename T >

static void pcl::ComplexPixelTraits::Dif ( sample &  a, T  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 1884 of file PixelTraits.h.

Div()

template<typename T >

static void pcl::ComplexPixelTraits::Div ( sample &  a, T  b  )

inlinestaticnoexcept

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

Definition at line 1864 of file PixelTraits.h.

Exclusion()

template<typename T >

static void pcl::ComplexPixelTraits::Exclusion ( sample &  a, T  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 2273 of file PixelTraits.h.

FloatToSample()

template<typename T >

static sample pcl::ComplexPixelTraits::FloatToSample ( T  x )

inlinestaticnoexcept

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

Definition at line 1646 of file PixelTraits.h.

FromSampl()

static void pcl::ComplexPixelTraits::FromSampl ( int8 &  a, sample  b  )

inlinestaticnoexcept

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

Definition at line 1757 of file PixelTraits.h.

FromSample() [1/8]

template<typename T >

static void pcl::ComplexPixelTraits::FromSample ( Complex< T > &  a, sample  b  )

inlinestaticnoexcept

Conversion of a pixel sample value to any complex type.

Definition at line 1814 of file PixelTraits.h.

FromSample() [2/8]

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

inlinestaticnoexcept

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

Definition at line 1805 of file PixelTraits.h.

FromSample() [3/8]

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

inlinestaticnoexcept

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

Definition at line 1797 of file PixelTraits.h.

FromSample() [4/8]

static void pcl::ComplexPixelTraits::FromSample ( int16 &  a, sample  b  )

inlinestaticnoexcept

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

Definition at line 1773 of file PixelTraits.h.

FromSample() [5/8]

static void pcl::ComplexPixelTraits::FromSample ( int32 &  a, sample  b  )

inlinestaticnoexcept

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

Definition at line 1789 of file PixelTraits.h.

FromSample() [6/8]

static void pcl::ComplexPixelTraits::FromSample ( uint16 &  a, sample  b  )

inlinestaticnoexcept

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

Definition at line 1765 of file PixelTraits.h.

FromSample() [7/8]

static void pcl::ComplexPixelTraits::FromSample ( uint32 &  a, sample  b  )

inlinestaticnoexcept

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

Definition at line 1781 of file PixelTraits.h.

FromSample() [8/8]

static void pcl::ComplexPixelTraits::FromSample ( uint8 &  a, sample  b  )

inlinestaticnoexcept

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

Definition at line 1749 of file PixelTraits.h.

HardLight()

template<typename T >

static void pcl::ComplexPixelTraits::HardLight ( sample &  a, T  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 2173 of file PixelTraits.h.

HighestSampleValue()

static sample pcl::ComplexPixelTraits::HighestSampleValue ( )

inlinestaticnoexcept

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

For ComplexPixelTraits, this member function returns {std::numeric_limits<double>::max(), 0.0F}.

Definition at line 1637 of file PixelTraits.h.

IsComplexSample()

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

IsFloatSample()

static constexpr bool pcl::ComplexPixelTraits::IsFloatSample ( )

inlinestaticconstexprnoexcept

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

Definition at line 1585 of file PixelTraits.h.

LinearBurn()

template<typename T >

static void pcl::ComplexPixelTraits::LinearBurn ( sample &  a, T  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 2048 of file PixelTraits.h.

LinearLight()

template<typename T >

static void pcl::ComplexPixelTraits::LinearLight ( sample &  a, T  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 2223 of file PixelTraits.h.

LowestSampleValue()

static sample pcl::ComplexPixelTraits::LowestSampleValue ( )

inlinestaticnoexcept

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

For ComplexPixelTraits, this member function returns {std::numeric_limits<double>::lowest(), 0.0F}.

Definition at line 1626 of file PixelTraits.h.

Max()

template<typename T >

static void pcl::ComplexPixelTraits::Max ( sample &  a, T  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 1904 of file PixelTraits.h.

MaxSampleValue()

static sample pcl::ComplexPixelTraits::MaxSampleValue ( )

inlinestaticnoexcept

Returns the maximum valid pixel sample value.

For ComplexPixelTraits, this member function returns {1.0F, 0.0F}.

Definition at line 1615 of file PixelTraits.h.

Min()

template<typename T >

static void pcl::ComplexPixelTraits::Min ( sample &  a, T  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 1894 of file PixelTraits.h.

Mov()

template<typename T >

static void pcl::ComplexPixelTraits::Mov ( sample &  a, T  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 1824 of file PixelTraits.h.

Mul()

template<typename T >

static void pcl::ComplexPixelTraits::Mul ( sample &  a, T  b  )

inlinestaticnoexcept

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

Definition at line 1854 of file PixelTraits.h.

Nand()

template<typename T >

static void pcl::ComplexPixelTraits::Nand ( sample &  a, T  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 both operands to 8-bit unsigned integers, then the result is converted to the pixel sample type and assigned to a.

Definition at line 1982 of file PixelTraits.h.

Nor()

template<typename T >

static void pcl::ComplexPixelTraits::Nor ( sample &  a, T  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 both operands to 8-bit unsigned integers, then the result is converted to the pixel sample type and assigned to a.

Definition at line 1930 of file PixelTraits.h.

Not() [1/2]

static void pcl::ComplexPixelTraits::Not ( sample &  a )

inlinestaticnoexcept

Negates (bitwise NOT operation) a pixel sample variable a. Negation is performed after converting the operand to an 8-bit unsigned integer, then the result is converted to the pixel sample type before assignment.

Definition at line 1956 of file PixelTraits.h.

Not() [2/2]

template<typename T >

static void pcl::ComplexPixelTraits::Not ( sample &  a, T  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 both operands to 8-bit unsigned integers, then the result is converted to the pixel sample type and assigned to a.

Definition at line 1969 of file PixelTraits.h.

Or()

template<typename T >

static void pcl::ComplexPixelTraits::Or ( sample &  a, T  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 both operands to 8-bit unsigned integers, then the result is converted to the pixel sample type and assigned to a.

Definition at line 1916 of file PixelTraits.h.

Overlay()

template<typename T >

static void pcl::ComplexPixelTraits::Overlay ( sample &  a, T  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 2123 of file PixelTraits.h.

PinLight()

template<typename T >

static void pcl::ComplexPixelTraits::PinLight ( sample &  a, T  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 2248 of file PixelTraits.h.

Pow()

template<typename T >

static void pcl::ComplexPixelTraits::Pow ( sample &  a, T  b  )

inlinestaticnoexcept

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

Definition at line 1874 of file PixelTraits.h.

SampleFormat()

static constexpr const char* pcl::ComplexPixelTraits::SampleFormat ( )

inlinestaticconstexprnoexcept

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

For ComplexPixelTraits, this member function returns "Complex32".

Definition at line 1605 of file PixelTraits.h.

Screen()

template<typename T >

static void pcl::ComplexPixelTraits::Screen ( sample &  a, T  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 2073 of file PixelTraits.h.

SoftLight()

template<typename T >

static void pcl::ComplexPixelTraits::SoftLight ( sample &  a, T  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 2148 of file PixelTraits.h.

Sub()

template<typename T >

static void pcl::ComplexPixelTraits::Sub ( sample &  a, T  b  )

inlinestaticnoexcept

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

Definition at line 1844 of file PixelTraits.h.

ToSample() [1/9]

template<typename T >

static sample pcl::ComplexPixelTraits::ToSample ( const Complex< T > &  x )

inlinestaticnoexcept

Conversion of any complex value to a pixel sample value.

Definition at line 1741 of file PixelTraits.h.

ToSample() [2/9]

static sample pcl::ComplexPixelTraits::ToSample ( double  x )

inlinestaticnoexcept

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

Definition at line 1732 of file PixelTraits.h.

ToSample() [3/9]

static sample pcl::ComplexPixelTraits::ToSample ( float  x )

inlinestaticnoexcept

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

Definition at line 1724 of file PixelTraits.h.

ToSample() [4/9]

static sample pcl::ComplexPixelTraits::ToSample ( int16  x )

inlinestaticnoexcept

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

Definition at line 1696 of file PixelTraits.h.

References int16_min, and uint16_max.

ToSample() [5/9]

static sample pcl::ComplexPixelTraits::ToSample ( int32  x )

inlinestaticnoexcept

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

Definition at line 1716 of file PixelTraits.h.

References int32_min, and uint32_max.

ToSample() [6/9]

static sample pcl::ComplexPixelTraits::ToSample ( int8  x )

inlinestaticnoexcept

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

Definition at line 1672 of file PixelTraits.h.

References int8_min, and uint8_max.

ToSample() [7/9]

static sample pcl::ComplexPixelTraits::ToSample ( uint16  x )

inlinestaticnoexcept

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

Definition at line 1684 of file PixelTraits.h.

References uint16_max.

ToSample() [8/9]

static sample pcl::ComplexPixelTraits::ToSample ( uint32  x )

inlinestaticnoexcept

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

Definition at line 1708 of file PixelTraits.h.

References uint32_max.

ToSample() [9/9]

static sample pcl::ComplexPixelTraits::ToSample ( uint8  x )

inlinestaticnoexcept

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

Definition at line 1660 of file PixelTraits.h.

References uint8_max.

VividLight()

template<typename T >

static void pcl::ComplexPixelTraits::VividLight ( sample &  a, T  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 2198 of file PixelTraits.h.

Xnor()

template<typename T >

static void pcl::ComplexPixelTraits::Xnor ( sample &  a, T  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 both operands to 8-bit unsigned integers, then the result is converted to the pixel sample type and assigned to a.

Definition at line 2010 of file PixelTraits.h.

Xor()

template<typename T >

static void pcl::ComplexPixelTraits::Xor ( sample &  a, T  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 both operands to 8-bit unsigned integers, then the result is converted to the pixel sample type and assigned to a.

Definition at line 1996 of file PixelTraits.h.

---

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

• PixelTraits.h