PCL
Public Types | Static Public Member Functions | List of all members
pcl::DComplexPixelTraits Class Reference

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

#include <PixelTraits.h>

+ Inheritance diagram for pcl::DComplexPixelTraits:

Public Types

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

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
 
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 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< double > >
static constexpr int BitsPerSample () noexcept
 
static constexpr int BytesPerSample () noexcept
 
static constexpr sample MinSampleValue () noexcept
 

Detailed Description

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

See also
GenericPixelTraits, GenericImage, DComplexImage

Definition at line 2309 of file PixelTraits.h.

Member Typedef Documentation

◆ component

using pcl::DComplexPixelTraits::component = sample::component

Represents a component of a complex pixel sample. For DComplexPixelTraits, this is equivalent to double.

Definition at line 2327 of file PixelTraits.h.

◆ sample

using pcl::DComplexPixelTraits::sample = traits_type::sample

Represents a pixel sample value.

Definition at line 2321 of file PixelTraits.h.

◆ traits_type

using pcl::DComplexPixelTraits::traits_type = GenericPixelTraits<Complex<double> >

Represents this template instantiation.

Definition at line 2316 of file PixelTraits.h.

Member Function Documentation

◆ Add()

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

◆ And()

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

◆ ColorBurn()

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

◆ ColorDodge()

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

◆ Dif()

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

◆ Div()

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

◆ Exclusion()

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

◆ FloatToSample()

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

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

Definition at line 2401 of file PixelTraits.h.

◆ FromSample() [1/9]

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

Conversion of a pixel sample value to any complex type.

Definition at line 2569 of file PixelTraits.h.

◆ FromSample() [2/9]

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

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

Definition at line 2560 of file PixelTraits.h.

◆ FromSample() [3/9]

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

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

Definition at line 2552 of file PixelTraits.h.

◆ FromSample() [4/9]

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

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

Definition at line 2528 of file PixelTraits.h.

◆ FromSample() [5/9]

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

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

Definition at line 2544 of file PixelTraits.h.

◆ FromSample() [6/9]

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

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

Definition at line 2512 of file PixelTraits.h.

◆ FromSample() [7/9]

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

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

Definition at line 2520 of file PixelTraits.h.

◆ FromSample() [8/9]

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

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

Definition at line 2536 of file PixelTraits.h.

◆ FromSample() [9/9]

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

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

Definition at line 2504 of file PixelTraits.h.

◆ HardLight()

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

◆ HighestSampleValue()

static sample pcl::DComplexPixelTraits::HighestSampleValue ( )
inlinestaticnoexcept

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

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

Definition at line 2392 of file PixelTraits.h.

◆ IsComplexSample()

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

◆ IsFloatSample()

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

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

Definition at line 2340 of file PixelTraits.h.

◆ LinearBurn()

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

◆ LinearLight()

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

◆ LowestSampleValue()

static sample pcl::DComplexPixelTraits::LowestSampleValue ( )
inlinestaticnoexcept

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

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

Definition at line 2381 of file PixelTraits.h.

◆ Max()

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

◆ MaxSampleValue()

static sample pcl::DComplexPixelTraits::MaxSampleValue ( )
inlinestaticnoexcept

Returns the maximum valid pixel sample value.

For DComplexPixelTraits, this member function returns {1.0, 0.0}.

Definition at line 2370 of file PixelTraits.h.

◆ Min()

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

◆ Mov()

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

◆ Mul()

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

◆ Nand()

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

◆ Nor()

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

◆ Not() [1/2]

static void pcl::DComplexPixelTraits::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 2711 of file PixelTraits.h.

◆ Not() [2/2]

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

◆ Or()

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

◆ Overlay()

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

◆ PinLight()

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

◆ Pow()

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

◆ SampleFormat()

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

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

For DComplexPixelTraits, this member function returns "Complex64".

Definition at line 2360 of file PixelTraits.h.

◆ Screen()

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

◆ SoftLight()

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

◆ Sub()

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

◆ ToSample() [1/9]

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

Conversion of any complex value to a pixel sample value.

Definition at line 2496 of file PixelTraits.h.

◆ ToSample() [2/9]

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

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

Definition at line 2487 of file PixelTraits.h.

◆ ToSample() [3/9]

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

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

Definition at line 2479 of file PixelTraits.h.

◆ ToSample() [4/9]

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

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

Definition at line 2451 of file PixelTraits.h.

References int16_min, and uint16_max.

◆ ToSample() [5/9]

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

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

Definition at line 2471 of file PixelTraits.h.

References int32_min, and uint32_max.

◆ ToSample() [6/9]

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

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

Definition at line 2427 of file PixelTraits.h.

References int8_min, and uint8_max.

◆ ToSample() [7/9]

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

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

Definition at line 2439 of file PixelTraits.h.

References uint16_max.

◆ ToSample() [8/9]

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

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

Definition at line 2463 of file PixelTraits.h.

References uint32_max.

◆ ToSample() [9/9]

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

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

Definition at line 2415 of file PixelTraits.h.

References uint8_max.

◆ VividLight()

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

◆ Xnor()

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

◆ Xor()

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

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