PCL
pcl::FloatPixelTraits Class Reference

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

#include <PixelTraits.h>

+ Inheritance diagram for pcl::FloatPixelTraits:

Public Types

typedef traits_type::sample sample
 
typedef GenericPixelTraits< float > traits_type
 
- Public Types inherited from pcl::GenericPixelTraits< float >
typedef float 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)
 
template<typename T >
static void Exclusion (sample &a, T b)
 
template<typename T >
static constexpr 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)
 
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 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 sample ToSample (uint16 x)
 
static sample ToSample (int16 x)
 
static constexpr sample ToSample (uint32 x)
 
static constexpr sample ToSample (int32 x)
 
static constexpr sample ToSample (float x)
 
static constexpr sample ToSample (double x)
 
template<typename T >
static constexpr sample ToSample (const Complex< T > &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< float >
static constexpr int BitsPerSample ()
 
static constexpr int BytesPerSample ()
 
static constexpr sample MinSampleValue ()
 

Detailed Description

FloatPixelTraits is a template instantiation of GenericPixelTraits for the float type. It defines the characteristic properties and functionality of 32-bit IEEE 754 floating point real pixel samples.

See also
GenericPixelTraits, GenericImage, Image

Definition at line 352 of file PixelTraits.h.

Member Typedef Documentation

◆ sample

Represents a pixel sample value.

Definition at line 364 of file PixelTraits.h.

◆ traits_type

Represents this template instantiation.

Definition at line 359 of file PixelTraits.h.

Member Function Documentation

◆ Add()

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

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

Definition at line 591 of file PixelTraits.h.

◆ And()

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

Definition at line 701 of file PixelTraits.h.

◆ ColorBurn()

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

◆ ColorDodge()

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

◆ Dif()

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

◆ Div()

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

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

Definition at line 621 of file PixelTraits.h.

◆ Exclusion()

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

◆ FloatToSample()

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

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

Definition at line 409 of file PixelTraits.h.

◆ FromSample() [1/9]

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

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

Definition at line 506 of file PixelTraits.h.

◆ FromSample() [2/9]

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

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

Definition at line 514 of file PixelTraits.h.

◆ FromSample() [3/9]

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

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

Definition at line 522 of file PixelTraits.h.

◆ FromSample() [4/9]

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

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

Definition at line 530 of file PixelTraits.h.

◆ FromSample() [5/9]

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

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

Definition at line 538 of file PixelTraits.h.

◆ FromSample() [6/9]

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

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

Definition at line 546 of file PixelTraits.h.

◆ FromSample() [7/9]

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

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

Definition at line 554 of file PixelTraits.h.

◆ FromSample() [8/9]

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

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

Definition at line 562 of file PixelTraits.h.

◆ FromSample() [9/9]

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

Conversion of a pixel sample value to any complex type.

Definition at line 571 of file PixelTraits.h.

◆ HardLight()

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

◆ IsComplexSample()

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

◆ IsFloatSample()

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

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

Definition at line 370 of file PixelTraits.h.

◆ LinearBurn()

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

◆ LinearLight()

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

◆ Max()

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

◆ MaxSampleValue()

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

Returns the maximum valid pixel sample value.

For FloatPixelTraits, this member function returns 1.0F.

Definition at line 400 of file PixelTraits.h.

◆ Min()

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

◆ Mov()

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

◆ Mul()

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

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

Definition at line 611 of file PixelTraits.h.

◆ Nand()

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

Definition at line 739 of file PixelTraits.h.

◆ Nor()

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

Definition at line 687 of file PixelTraits.h.

◆ Not() [1/2]

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

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

◆ Not() [2/2]

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

Definition at line 726 of file PixelTraits.h.

◆ Or()

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

Definition at line 673 of file PixelTraits.h.

◆ Overlay()

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

◆ PinLight()

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

◆ Pow()

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

◆ SampleFormat()

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

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

For FloatPixelTraits, this member function returns "Float32".

Definition at line 390 of file PixelTraits.h.

◆ Screen()

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

◆ SoftLight()

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

◆ Sub()

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

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

Definition at line 601 of file PixelTraits.h.

◆ ToSample() [1/9]

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

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

Definition at line 417 of file PixelTraits.h.

References uint8_max.

◆ ToSample() [2/9]

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

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

Definition at line 429 of file PixelTraits.h.

References int8_min, and uint8_max.

◆ ToSample() [3/9]

static sample pcl::FloatPixelTraits::ToSample ( uint16  x)
inlinestatic

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

Definition at line 441 of file PixelTraits.h.

References uint16_max.

◆ ToSample() [4/9]

static sample pcl::FloatPixelTraits::ToSample ( int16  x)
inlinestatic

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

Definition at line 453 of file PixelTraits.h.

References int16_min, and uint16_max.

◆ ToSample() [5/9]

static constexpr sample pcl::FloatPixelTraits::ToSample ( uint32  x)
inlinestatic

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

Definition at line 465 of file PixelTraits.h.

References uint32_max.

◆ ToSample() [6/9]

static constexpr sample pcl::FloatPixelTraits::ToSample ( int32  x)
inlinestatic

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

Definition at line 473 of file PixelTraits.h.

References int32_min, and uint32_max.

◆ ToSample() [7/9]

static constexpr sample pcl::FloatPixelTraits::ToSample ( float  x)
inlinestatic

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

Definition at line 481 of file PixelTraits.h.

◆ ToSample() [8/9]

static constexpr sample pcl::FloatPixelTraits::ToSample ( double  x)
inlinestatic

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

Definition at line 489 of file PixelTraits.h.

◆ ToSample() [9/9]

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

Conversion of any complex value to a pixel sample value.

Definition at line 498 of file PixelTraits.h.

References pcl::Abs().

◆ VividLight()

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

◆ Xnor()

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

Definition at line 767 of file PixelTraits.h.

◆ Xor()

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

Definition at line 753 of file PixelTraits.h.


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