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

#include <PixelTraits.h>

Inheritance diagram for pcl::FloatPixelTraits:

Public Types
using	component = sample

using	sample = traits_type::sample

using	traits_type = GenericPixelTraits< float >

Public Types inherited from pcl::GenericPixelTraits< float >
using	sample = 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 constexpr 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

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 constexpr sample	ToSample (const Complex< T > &x) noexcept

static constexpr sample	ToSample (double x) noexcept

static constexpr 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

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< float >
static constexpr int	BitsPerSample () noexcept

static constexpr int	BytesPerSample () noexcept

static constexpr sample	MinSampleValue () noexcept

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

Member Typedef Documentation

◆ component

using pcl::FloatPixelTraits::component = sample

Represents a component of a complex pixel sample, or a pixel sample value for real pixel sample types. For FloatPixelTraits, this is equivalent to float.

Definition at line 387 of file PixelTraits.h.

◆ sample

using pcl::FloatPixelTraits::sample = traits_type::sample

Represents a pixel sample value.

Definition at line 380 of file PixelTraits.h.

◆ traits_type

using pcl::FloatPixelTraits::traits_type = GenericPixelTraits<float>

Represents this template instantiation.

Definition at line 375 of file PixelTraits.h.

Member Function Documentation

◆ Add()

template<typename T >

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

◆ And()

template<typename T >

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

◆ ColorBurn()

template<typename T >

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

◆ ColorDodge()

template<typename T >

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

◆ Dif()

template<typename T >

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

◆ Div()

template<typename T >

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

◆ Exclusion()

template<typename T >

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

◆ FloatToSample()

template<typename T >

static constexpr sample pcl::FloatPixelTraits::FloatToSample ( T x )

inlinestaticconstexprnoexcept

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

Definition at line 454 of file PixelTraits.h.

◆ FromSample() [1/9]

template<typename T >

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

inlinestaticnoexcept

Conversion of a pixel sample value to any complex type.

Definition at line 616 of file PixelTraits.h.

◆ FromSample() [2/9]

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

inlinestaticnoexcept

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

Definition at line 607 of file PixelTraits.h.

◆ FromSample() [3/9]

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

inlinestaticnoexcept

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

Definition at line 599 of file PixelTraits.h.

◆ FromSample() [4/9]

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

inlinestaticnoexcept

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

Definition at line 575 of file PixelTraits.h.

◆ FromSample() [5/9]

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

inlinestaticnoexcept

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

Definition at line 591 of file PixelTraits.h.

◆ FromSample() [6/9]

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

inlinestaticnoexcept

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

Definition at line 559 of file PixelTraits.h.

◆ FromSample() [7/9]

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

inlinestaticnoexcept

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

Definition at line 567 of file PixelTraits.h.

◆ FromSample() [8/9]

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

inlinestaticnoexcept

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

Definition at line 583 of file PixelTraits.h.

◆ FromSample() [9/9]

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

inlinestaticnoexcept

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

Definition at line 551 of file PixelTraits.h.

◆ HardLight()

template<typename T >

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

◆ HighestSampleValue()

static constexpr sample pcl::FloatPixelTraits::HighestSampleValue ( )

inlinestaticconstexprnoexcept

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

For FloatPixelTraits, this member function returns std::numeric_limits<float>::max().

Definition at line 445 of file PixelTraits.h.

◆ IsComplexSample()

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

◆ IsFloatSample()

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

inlinestaticconstexprnoexcept

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

Definition at line 393 of file PixelTraits.h.

◆ LinearBurn()

template<typename T >

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

◆ LinearLight()

template<typename T >

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

◆ LowestSampleValue()

static constexpr sample pcl::FloatPixelTraits::LowestSampleValue ( )

inlinestaticconstexprnoexcept

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

For FloatPixelTraits, this member function returns std::numeric_limits<float>::lowest().

Definition at line 434 of file PixelTraits.h.

◆ Max()

template<typename T >

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

◆ MaxSampleValue()

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

inlinestaticconstexprnoexcept

Returns the maximum valid pixel sample value.

For FloatPixelTraits, this member function returns 1.0F.

Definition at line 423 of file PixelTraits.h.

◆ Min()

template<typename T >

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

◆ Mov()

template<typename T >

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

◆ Mul()

template<typename T >

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

◆ Nand()

template<typename T >

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

◆ Nor()

template<typename T >

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

◆ Not() [1/2]

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

◆ Not() [2/2]

template<typename T >

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

◆ Or()

template<typename T >

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

◆ Overlay()

template<typename T >

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

◆ PinLight()

template<typename T >

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

◆ Pow()

template<typename T >

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

◆ SampleFormat()

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

inlinestaticconstexprnoexcept

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

◆ Screen()

template<typename T >

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

◆ SoftLight()

template<typename T >

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

◆ Sub()

template<typename T >

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

◆ ToSample() [1/9]

template<typename T >

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

inlinestaticconstexprnoexcept

Conversion of any complex value to a pixel sample value.

Definition at line 543 of file PixelTraits.h.

References pcl::Abs().

◆ ToSample() [2/9]

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

inlinestaticconstexprnoexcept

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

Definition at line 534 of file PixelTraits.h.

◆ ToSample() [3/9]

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

inlinestaticconstexprnoexcept

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

Definition at line 526 of file PixelTraits.h.

◆ ToSample() [4/9]

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

inlinestaticnoexcept

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

Definition at line 498 of file PixelTraits.h.

References int16_min, and uint16_max.

◆ ToSample() [5/9]

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

inlinestaticconstexprnoexcept

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

Definition at line 518 of file PixelTraits.h.

References int32_min, and uint32_max.

◆ ToSample() [6/9]

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

inlinestaticnoexcept

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

Definition at line 474 of file PixelTraits.h.

References int8_min, and uint8_max.

◆ ToSample() [7/9]

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

inlinestaticnoexcept

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

Definition at line 486 of file PixelTraits.h.

References uint16_max.

◆ ToSample() [8/9]

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

inlinestaticconstexprnoexcept

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

Definition at line 510 of file PixelTraits.h.

References uint32_max.

◆ ToSample() [9/9]

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

inlinestaticnoexcept

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

Definition at line 462 of file PixelTraits.h.

References uint8_max.

◆ VividLight()

template<typename T >

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

◆ Xnor()

template<typename T >

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

◆ Xor()

template<typename T >

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

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

PixelTraits.h

Public Types

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ component

◆ sample

◆ traits_type

Member Function Documentation

◆ Add()

◆ And()

◆ ColorBurn()

◆ ColorDodge()

◆ Dif()

◆ Div()

◆ Exclusion()

◆ FloatToSample()

◆ FromSample() [1/9]

◆ FromSample() [2/9]

◆ FromSample() [3/9]

◆ FromSample() [4/9]

◆ FromSample() [5/9]

◆ FromSample() [6/9]

◆ FromSample() [7/9]

◆ FromSample() [8/9]

◆ FromSample() [9/9]

◆ HardLight()

◆ HighestSampleValue()

◆ IsComplexSample()

◆ IsFloatSample()

◆ LinearBurn()

◆ LinearLight()

◆ LowestSampleValue()

◆ Max()

◆ MaxSampleValue()

◆ Min()

◆ Mov()

◆ Mul()

◆ Nand()

◆ Nor()

◆ Not() [1/2]

◆ Not() [2/2]

◆ Or()

◆ Overlay()

◆ PinLight()

◆ Pow()

◆ SampleFormat()

◆ Screen()

◆ SoftLight()

◆ Sub()

◆ ToSample() [1/9]

◆ ToSample() [2/9]

◆ ToSample() [3/9]

◆ ToSample() [4/9]

◆ ToSample() [5/9]

◆ ToSample() [6/9]

◆ ToSample() [7/9]

◆ ToSample() [8/9]

◆ ToSample() [9/9]

◆ VividLight()

◆ Xnor()

◆ Xor()