mln::value Namespace Reference

Namespace of materials related to pixel value types. More...

Namespaces
namespace	impl
	Implementation namespace of value namespace.
Classes
class	float01
	Class for floating values restricted to the interval [0. More...
struct	float01_f
	Class for floating values restricted to the interval [0..1]. More...
struct	graylevel
	General gray-level class on n bits. More...
struct	graylevel_f
	General gray-level class on n bits. More...
struct	int_s
	Signed integer value class. More...
struct	int_u
	Unsigned integer value class. More...
struct	int_u_sat
	Unsigned integer value class with saturation behavior. More...
struct	Integer
	Concept of integer. More...
struct	Integer< void >
	Category flag type. More...
struct	label
	Label value class. More...
struct	lut_vec
	Class that defines FIXME. More...
class	proxy
	Generic proxy class for an image pixel value. More...
class	proxy< const I >
	Generic proxy class for an image pixel value. More...
struct	rgb
	Color class for red-green-blue where every component is n-bit encoded. More...
struct	set
	Class that defines the set of values of type T. More...
class	sign
	The sign class represents the value type composed by the set (-1, 0, 1) sign value type is a subset of the int value type. More...
struct	stack_image
	Stack image class. More...
struct	super_value< sign >
	Specializations:. More...
Typedefs
typedef float01_< 16 >	float01_16
	Alias for 16 bit float01.
typedef float01_< 8 >	float01_8
	Alias for 8 bit float01.
typedef graylevel< 16 >	gl16
	Alias for 16 bit graylevel.
typedef graylevel< 8 >	gl8
	Alias for 8 bit graylevel.
typedef graylevel_f	glf
	Alias for graylevels encoded by float.
typedef int_s< 16 >	int_s16
	Alias for signed 16-bit integers.
typedef int_s< 32 >	int_s32
	Alias for signed 32-bit integers.
typedef int_s< 8 >	int_s8
	Alias for signed 8-bit integers.
typedef int_u< 12 >	int_u12
	Alias for unsigned 12-bit integers.
typedef int_u< 16 >	int_u16
	Alias for unsigned 16-bit integers.
typedef mln::value::int_u< 32 >	int_u32
	Alias for unsigned 32-bit integers.
typedef mln::value::int_u< 8 >	int_u8
	Alias for unsigned 8-bit integers.
typedef label< 16 >	label_16
	Alias for 16-bit integers.
typedef mln::value::label< 8 >	label_8
	Alias for 8-bit labels.
typedef rgb< 16 >	rgb16
	Color class for red-green-blue where every component is 16-bit encoded.
typedef rgb< 8 >	rgb8
	Color class for red-green-blue where every component is 8-bit encoded.
Functions
template<typename Dest , typename Src >
Dest	cast (const Src &src)
	Cast a value src from type Src to type Dest.
template<typename V >
internal::equiv_< V >::ret	equiv (const mln::Value< V > &v)
	Access to the equivalent value.
template<unsigned n>
rgb< n >::interop	operator+ (const rgb< n > &lhs, const rgb< n > &rhs)
	Addition.
template<typename H , typename S , typename L >
hsl_< H, S, L >	operator+ (const hsl_< H, S, L > &lhs, const hsl_< H, S, L > &rhs)
	Addition.
std::ostream &	operator<< (std::ostream &ostr, const sign &i)
	Print an signed integer i into the output stream ostr.
template<typename T >
std::ostream &	operator<< (std::ostream &ostr, const scalar_< T > &s)
	Print a scalar s in an output stream ostr.
template<unsigned n>
std::ostream &	operator<< (std::ostream &ostr, const rgb< n > &c)
	Print an rgb c into the output stream ostr.
template<typename I >
std::ostream &	operator<< (std::ostream &ostr, const proxy< I > &x)
	Print a value proxy x into the output stream ostr.
template<unsigned n>
std::ostream &	operator<< (std::ostream &ostr, const label< n > &l)
	Print a label l into the output stream ostr.
template<unsigned n>
std::ostream &	operator<< (std::ostream &ostr, const int_u_sat< n > &i)
	Print a saturated unsigned integer i into the output stream ostr.
template<unsigned n>
std::ostream &	operator<< (std::ostream &ostr, const int_u< n > &i)
	Print an unsigned integer i into the output stream ostr.
template<unsigned n>
std::ostream &	operator<< (std::ostream &ostr, const int_s< n > &i)
	Print an signed integer i into the output stream ostr.
template<typename H , typename S , typename L >
std::ostream &	operator<< (std::ostream &ostr, const hsl_< H, S, L > &c)
	Print an hsl c into the output stream ostr.
std::ostream &	operator<< (std::ostream &ostr, const graylevel_f &g)
	Op<<.
template<unsigned n>
std::ostream &	operator<< (std::ostream &ostr, const graylevel< n > &g)
	Op<<.
template<unsigned n>
std::ostream &	operator<< (std::ostream &ostr, const float01_< n > &f)
	Op<<.
bool	operator== (const sign &lhs, const sign &rhs)
	Comparaison operator.
template<typename V >
V	other (const V &val)
	Give an other value than val.
template<unsigned n, typename S >
rgb< n >::interop	operator* (const rgb< n > &lhs, const mln::value::scalar_< S > &s)
	Product.
template<typename H , typename S , typename L , typename S2 >
hsl_< H, S, L >	operator* (const hsl_< H, S, L > &lhs, const mln::value::scalar_< S2 > &s)
	Product.
template<unsigned n>
rgb< n >::interop	operator- (const rgb< n > &lhs, const rgb< n > &rhs)
	Subtraction.
template<typename H , typename S , typename L >
hsl_< H, S, L >	operator- (const hsl_< H, S, L > &lhs, const hsl_< H, S, L > &rhs)
	Subtraction.
template<unsigned n, typename S >
rgb< n >::interop	operator/ (const rgb< n > &lhs, const mln::value::scalar_< S > &s)
	Division.
template<typename H , typename S , typename L , typename S2 >
hsl_< H, S, L >	operator/ (const hsl_< H, S, L > &lhs, const mln::value::scalar_< S2 > &s)
	Division.
template<typename H , typename S , typename L >
bool	operator== (const hsl_< H, S, L > &lhs, const hsl_< H, S, L > &rhs)
	Comparison.
template<typename I >
stack_image< 2, const I >	stack (const Image< I > &ima1, const Image< I > &ima2)
	Shortcut to build a stack with two images.

---

Detailed Description

Namespace of materials related to pixel value types.

---

Typedef Documentation

typedef float01_<16> mln::value::float01_16

Alias for 16 bit float01.

typedef float01_<8> mln::value::float01_8

Alias for 8 bit float01.

typedef graylevel<16> mln::value::gl16

Alias for 16 bit graylevel.

typedef graylevel<8> mln::value::gl8

Alias for 8 bit graylevel.

typedef graylevel_f mln::value::glf

Alias for graylevels encoded by float.

typedef int_s<16> mln::value::int_s16

Alias for signed 16-bit integers.

typedef int_s<32> mln::value::int_s32

Alias for signed 32-bit integers.

typedef int_s<8> mln::value::int_s8

Alias for signed 8-bit integers.

typedef int_u<12> mln::value::int_u12

Alias for unsigned 12-bit integers.

typedef int_u<16> mln::value::int_u16

Alias for unsigned 16-bit integers.

typedef mln::value::int_u<32> mln::value::int_u32

Alias for unsigned 32-bit integers.

typedef mln::value::int_u<8> mln::value::int_u8

Alias for unsigned 8-bit integers.

typedef label<16> mln::value::label_16

Alias for 16-bit integers.

typedef mln::value::label<8> mln::value::label_8

Alias for 8-bit labels.

typedef rgb<16> mln::value::rgb16

Color class for red-green-blue where every component is 16-bit encoded.

typedef rgb<8> mln::value::rgb8

Color class for red-green-blue where every component is 8-bit encoded.

---

Function Documentation

template<typename Dest , typename Src >

Dest mln::value::cast

(

const Src &

src

)

[inline]

Cast a value src from type Src to type Dest.

template<typename V >

internal::equiv_< V >::ret mln::value::equiv

(

const mln::Value< V > &

v

)

[inline]

Access to the equivalent value.

template<unsigned n, typename S >

rgb< n >::interop mln::value::operator*	(	const rgb< n > &	lhs,
		const mln::value::scalar_< S > &	s
	)			[inline]

Product.

template<typename H , typename S , typename L , typename S2 >

hsl_< H, S, L > mln::value::operator*	(	const hsl_< H, S, L > &	lhs,
		const mln::value::scalar_< S2 > &	s
	)			[inline]

Product.

template<unsigned n>

rgb< n >::interop mln::value::operator+	(	const rgb< n > &	lhs,
		const rgb< n > &	rhs
	)			[inline]

Addition.

{

template<typename H , typename S , typename L >

hsl_< H, S, L > mln::value::operator+	(	const hsl_< H, S, L > &	lhs,
		const hsl_< H, S, L > &	rhs
	)			[inline]

Addition.

{

template<unsigned n>

rgb< n >::interop mln::value::operator-	(	const rgb< n > &	lhs,
		const rgb< n > &	rhs
	)			[inline]

Subtraction.

template<typename H , typename S , typename L >

hsl_< H, S, L > mln::value::operator-	(	const hsl_< H, S, L > &	lhs,
		const hsl_< H, S, L > &	rhs
	)			[inline]

Subtraction.

template<unsigned n, typename S >

rgb< n >::interop mln::value::operator/	(	const rgb< n > &	lhs,
		const mln::value::scalar_< S > &	s
	)			[inline]

Division.

template<typename H , typename S , typename L , typename S2 >

hsl_< H, S, L > mln::value::operator/	(	const hsl_< H, S, L > &	lhs,
		const mln::value::scalar_< S2 > &	s
	)			[inline]

Division.

std::ostream & mln::value::operator<<	(	std::ostream &	ostr,
		const sign &	i
	)			[inline]

Print an signed integer i into the output stream ostr.

Parameters:

[in,out]	ostr	An output stream.
[in]	i	An sign value

Returns:

The modified output stream ostr.

References mln::debug::format().

template<typename T >

std::ostream & mln::value::operator<<	(	std::ostream &	ostr,
		const scalar_< T > &	s
	)			[inline]

Print a scalar s in an output stream ostr.

template<unsigned n>

std::ostream & mln::value::operator<<	(	std::ostream &	ostr,
		const rgb< n > &	c
	)			[inline]

Print an rgb c into the output stream ostr.

Parameters:

[in,out]	ostr	An output stream.
[in]	c	An rgb.

Returns:

The modified output stream ostr.

References mln::debug::format().

template<typename I >

std::ostream & mln::value::operator<<	(	std::ostream &	ostr,
		const proxy< I > &	x
	)			[inline]

Print a value proxy x into the output stream ostr.

Parameters:

[in,out]	ostr	An output stream.
[in]	x	A value proxy.

Returns:

The modified output stream ostr.

template<unsigned n>

std::ostream & mln::value::operator<<	(	std::ostream &	ostr,
		const label< n > &	l
	)			[inline]

Print a label l into the output stream ostr.

Parameters:

[in,out]	ostr	An output stream.
[in]	l	A label.

Returns:

The modified output stream ostr.

References mln::debug::format().

template<unsigned n>

std::ostream & mln::value::operator<<	(	std::ostream &	ostr,
		const int_u_sat< n > &	i
	)			[inline]

Print a saturated unsigned integer i into the output stream ostr.

Parameters:

[in,out]	ostr	An output stream.
[in]	i	A saturated unsigned integer.

Returns:

The modified output stream ostr.

References mln::debug::format().

template<unsigned n>

std::ostream & mln::value::operator<<	(	std::ostream &	ostr,
		const int_u< n > &	i
	)			[inline]

Print an unsigned integer i into the output stream ostr.

Parameters:

[in,out]	ostr	An output stream.
[in]	i	An unsigned integer.

Returns:

The modified output stream ostr.

References mln::debug::format().

template<unsigned n>

std::ostream & mln::value::operator<<	(	std::ostream &	ostr,
		const int_s< n > &	i
	)			[inline]

Print an signed integer i into the output stream ostr.

Parameters:

[in,out]	ostr	An output stream.
[in]	i	An signed integer.

Returns:

The modified output stream ostr.

References mln::debug::format().

template<typename H , typename S , typename L >

std::ostream & mln::value::operator<<	(	std::ostream &	ostr,
		const hsl_< H, S, L > &	c
	)			[inline]

Print an hsl c into the output stream ostr.

Parameters:

[in,out]	ostr	An output stream.
[in]	c	An rgb.

Returns:

The modified output stream ostr.

References mln::debug::format().

std::ostream & mln::value::operator<<	(	std::ostream &	ostr,
		const graylevel_f &	g
	)			[inline]

Op<<.

References mln::value::graylevel_f::value().

template<unsigned n>

std::ostream & mln::value::operator<<	(	std::ostream &	ostr,
		const graylevel< n > &	g
	)			[inline]

Op<<.

template<unsigned n>

std::ostream & mln::value::operator<<	(	std::ostream &	ostr,
		const float01_< n > &	f
	)			[inline]

Op<<.

bool mln::value::operator==	(	const sign &	lhs,
		const sign &	rhs
	)			[inline]

Comparaison operator.

template<typename H , typename S , typename L >

bool mln::value::operator==	(	const hsl_< H, S, L > &	lhs,
		const hsl_< H, S, L > &	rhs
	)			[inline]

Comparison.

template<typename V >

V mln::value::other

(

const V &

val

)

[inline]

Give an other value than val.

template<typename I >

stack_image< 2, const I > mln::value::stack	(	const Image< I > &	ima1,
		const Image< I > &	ima2
	)			[inline]

Shortcut to build a stack with two images.