Cvb::Foundation::Bitwise Namespace Reference

Namespace for collection of bitwise image functions from the Foundation package. More...

Functions
std::unique_ptr< Image >	And (const Image &image1, const Image &image2)
	Performs a bit-wise AND operation between the pixels of the two input images.
template<class RANGE>
TypedRange< std::unique_ptr< Image >, int, RANGE >::type	And (const Image &image, const RANGE &values)
	Bit-wise AND operation on the input image with a constant value or values.
std::unique_ptr< Image >	And (const Image &image, int value)
	Bit-wise AND operation on the input image with a constant value.
std::unique_ptr< Image >	Or (const Image &image1, const Image &image2)
	Performs a bit-wise OR operation between the pixels of the two input images.
template<class RANGE>
TypedRange< std::unique_ptr< Image >, int, RANGE >::type	Or (const Image &image, const RANGE &values)
	Bit-wise OR operation on the input image with a constant value or values.
std::unique_ptr< Image >	Or (const Image &image, int value)
	Bit-wise OR operation on the input image with a constant value.
std::unique_ptr< Image >	Xor (const Image &image1, const Image &image2)
	Performs a bit-wise XOR operation between the pixels of the two input images.
template<class RANGE>
TypedRange< std::unique_ptr< Image >, int, RANGE >::type	Xor (const Image &image, const RANGE &values)
	Bit-wise XOR operation on the input image with constant values.
std::unique_ptr< Image >	Xor (const Image &image, int value)
	Bit-wise XOR operation on the input image with a constant value.
std::unique_ptr< Image >	Negate (const Image &image)
	Performs a bit-wise NOT operation on the pixels of the input image to create the output image.
template<class RANGE>
TypedRange< std::unique_ptr< Image >, int, RANGE >::type	UpShift (const Image &image, const RANGE &values)
	Bit-wise shift the input image with constant values.
std::unique_ptr< Image >	UpShift (const Image &image, int value)
	Bit-wise shift the input image with a constant value.
template<class RANGE>
TypedRange< std::unique_ptr< Image >, int, RANGE >::type	DownShift (const Image &image, const RANGE &values)
	Bit-wise shift the input image with constant values.
std::unique_ptr< Image >	DownShift (const Image &image, int value)
	Bit-wise shift the input image with a constant value.

Detailed Description

Namespace for collection of bitwise image functions from the Foundation package.

Remarks

CMake users: Link to imported target CVB::CvbFoundationBayerBitwise

Function Documentation

And() [1/3]

template<class RANGE>

TypedRange< std::unique_ptr< Image >, int, RANGE >::type And ( const Image & image, const RANGE & values )

inline

Bit-wise AND operation on the input image with a constant value or values.

Parameters

[in]	image	Input image.
[in]	values	Values to AND the image with (at least one per plane in image).

Returns

The result image.

Exceptions

Any	exception derived from std::exception including CvbException.

And() [2/3]

std::unique_ptr< Image > And ( const Image & image, int value )

inline

Bit-wise AND operation on the input image with a constant value.

Parameters

[in]	image	Input image.
[in]	value	Value to AND each plane with.

Returns

The result image.

Exceptions

Any	exception derived from std::exception including CvbException.

And() [3/3]

std::unique_ptr< Image > And ( const Image & image1, const Image & image2 )

inline

Performs a bit-wise AND operation between the pixels of the two input images.

Parameters

[in]	image1	Input image 1.
[in]	image2	Input image 2.

Returns

The result image.

Exceptions

Any	exception derived from std::exception including CvbException.

If the sizes of the two input images differ, the result image will contain the biggest rectangle common to both input images.

DownShift() [1/2]

template<class RANGE>

TypedRange< std::unique_ptr< Image >, int, RANGE >::type DownShift ( const Image & image, const RANGE & values )

inline

Bit-wise shift the input image with constant values.

Parameters

[in]	image	Input image.
[in]	values	Values to shift the image with (at least one per plane in image).

Returns

The result image.

Exceptions

Any	exception derived from std::exception including CvbException.

DownShift() [2/2]

std::unique_ptr< Image > DownShift ( const Image & image, int value )

inline

Bit-wise shift the input image with a constant value.

Parameters

[in]	image	Input image.
[in]	value	Value to shift each plane with.

Returns

The result image.

Exceptions

Any	exception derived from std::exception including CvbException.

Negate()

std::unique_ptr< Image > Negate ( const Image & image )

inline

Performs a bit-wise NOT operation on the pixels of the input image to create the output image.

Parameters

[in]

image

Input image.

Returns

The result image.

Exceptions

Any	exception derived from std::exception including CvbException.

Or() [1/3]

template<class RANGE>

TypedRange< std::unique_ptr< Image >, int, RANGE >::type Or ( const Image & image, const RANGE & values )

inline

Bit-wise OR operation on the input image with a constant value or values.

Parameters

[in]	image	Input image.
[in]	values	Values to OR the image with (at least one per plane in image).

Returns

The result image.

Exceptions

Any	exception derived from std::exception including CvbException.

Or() [2/3]

std::unique_ptr< Image > Or ( const Image & image, int value )

inline

Bit-wise OR operation on the input image with a constant value.

Parameters

[in]	image	Input image.
[in]	value	Value to OR each plane with.

Returns

The result image.

Exceptions

Any	exception derived from std::exception including CvbException.

Or() [3/3]

std::unique_ptr< Image > Or ( const Image & image1, const Image & image2 )

inline

Performs a bit-wise OR operation between the pixels of the two input images.

Parameters

[in]	image1	Input image 1.
[in]	image2	Input image 2.

Returns

The result image.

Exceptions

Any	exception derived from std::exception including CvbException.

If the sizes of the two input images differ, the result image will contain the biggest rectangle common to both input images.

UpShift() [1/2]

template<class RANGE>

TypedRange< std::unique_ptr< Image >, int, RANGE >::type UpShift ( const Image & image, const RANGE & values )

inline

Bit-wise shift the input image with constant values.

Parameters

[in]	image	Input image.
[in]	values	Values to shift the image with (at least one per plane in image).

Returns

The result image.

Exceptions

Any	exception derived from std::exception including CvbException.

UpShift() [2/2]

std::unique_ptr< Image > UpShift ( const Image & image, int value )

inline

Bit-wise shift the input image with a constant value.

Parameters

[in]	image	Input image.
[in]	value	Value to shift each plane with.

Returns

The result image.

Exceptions

Any	exception derived from std::exception including CvbException.

Xor() [1/3]

template<class RANGE>

TypedRange< std::unique_ptr< Image >, int, RANGE >::type Xor ( const Image & image, const RANGE & values )

inline

Bit-wise XOR operation on the input image with constant values.

Parameters

[in]	image	Input image.
[in]	values	Values to XOR the image with (at least one per plane in image).

Returns

The result image.

Exceptions

Any	exception derived from std::exception including CvbException.

Xor() [2/3]

std::unique_ptr< Image > Xor ( const Image & image, int value )

inline

Bit-wise XOR operation on the input image with a constant value.

Parameters

[in]	image	Input image.
[in]	value	Value to XOR each plane with.

Returns

The result image.

Exceptions

Any	exception derived from std::exception including CvbException.

Xor() [3/3]

std::unique_ptr< Image > Xor ( const Image & image1, const Image & image2 )

inline

Performs a bit-wise XOR operation between the pixels of the two input images.

Parameters

[in]	image1	Input image 1.
[in]	image2	Input image 2.

Returns

The result image.

Exceptions

Any	exception derived from std::exception including CvbException.

If the sizes of the two input images differ, the result image will contain the biggest rectangle common to both input images.