CVB++ 14.0
Cvb::Foundation::Bitwise Namespace Reference

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

Functions

std::unique_ptr< ImageAnd (const Image &image1, const Image &image2)
 Performs a bit-wise AND operation between the pixels of the two input images. More...
 
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. More...
 
std::unique_ptr< ImageAnd (const Image &image, int value)
 Bit-wise AND operation on the input image with a constant value. More...
 
std::unique_ptr< ImageOr (const Image &image1, const Image &image2)
 Performs a bit-wise OR operation between the pixels of the two input images. More...
 
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. More...
 
std::unique_ptr< ImageOr (const Image &image, int value)
 Bit-wise OR operation on the input image with a constant value. More...
 
std::unique_ptr< ImageXor (const Image &image1, const Image &image2)
 Performs a bit-wise XOR operation between the pixels of the two input images. More...
 
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. More...
 
std::unique_ptr< ImageXor (const Image &image, int value)
 Bit-wise XOR operation on the input image with a constant value. More...
 
std::unique_ptr< ImageNegate (const Image &image)
 Performs a bit-wise NOT operation on the pixels of the input image to create the output image. More...
 
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. More...
 
std::unique_ptr< ImageUpShift (const Image &image, int value)
 Bit-wise shift the input image with a constant value. More...
 
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. More...
 
std::unique_ptr< ImageDownShift (const Image &image, int value)
 Bit-wise shift the input image with a constant value. More...
 

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]

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]imageInput image.
[in]valuesValues to AND the image with (at least one per plane in image).
Returns
The result image.
Exceptions
Anyexception 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]imageInput image.
[in]valueValue to AND each plane with.
Returns
The result image.
Exceptions
Anyexception 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]image1Input image 1.
[in]image2Input image 2.
Returns
The result image.
Exceptions
Anyexception 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]

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]imageInput image.
[in]valuesValues to shift the image with (at least one per plane in image).
Returns
The result image.
Exceptions
Anyexception 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]imageInput image.
[in]valueValue to shift each plane with.
Returns
The result image.
Exceptions
Anyexception 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]imageInput image.
Returns
The result image.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ Or() [1/3]

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]imageInput image.
[in]valuesValues to OR the image with (at least one per plane in image).
Returns
The result image.
Exceptions
Anyexception 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]imageInput image.
[in]valueValue to OR each plane with.
Returns
The result image.
Exceptions
Anyexception 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]image1Input image 1.
[in]image2Input image 2.
Returns
The result image.
Exceptions
Anyexception 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]

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]imageInput image.
[in]valuesValues to shift the image with (at least one per plane in image).
Returns
The result image.
Exceptions
Anyexception 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]imageInput image.
[in]valueValue to shift each plane with.
Returns
The result image.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ Xor() [1/3]

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]imageInput image.
[in]valuesValues to XOR the image with (at least one per plane in image).
Returns
The result image.
Exceptions
Anyexception 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]imageInput image.
[in]valueValue to XOR each plane with.
Returns
The result image.
Exceptions
Anyexception 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]image1Input image 1.
[in]image2Input image 2.
Returns
The result image.
Exceptions
Anyexception 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.