Collection of arithmetic functions from the Foundation Package. More...

Static Public Member Functions
static Image	Add (Image img1, Image img2, PixelOverflow overflow)
	Add the pixel values of both input images to obtain the output image. More...

static Image	Multiply (Image img1, Image img2, PixelOverflow overflow)
	Multiply the pixel values of both input images to obtain the output image. More...

static Image	Subtract (Image img1, Image img2)
	Subtract the pixel values of img2 from img1 to obtain the output image. More...

static Image	SubtractAbs (Image img1, Image img2)
	Subtract the pixel values of img2 from img1 to obtain the output image. More...

static Image	Divide (Image img1, Image img2, int upShift)
	Divide the pixel values of img2 by the pixel values of img2 to obtain the output image and shift them up by upShift bits to preserve information. More...

static Image	Square (Image img, PixelOverflow overflow)
	Squares the pixel values of the input image to obtain the output image. More...

static Image	Sqrt (Image img, SqrtPixelScaling scaling)
	Calculates the square roots of pixel values of a source image and writes them into the destination image. More...

static Image	Absolute (Image img)
	Determines the absolute values of the pixels in the input image img . More...

static Image	Add (Image img, double[] values, PixelOverflow overflow)
	Add constant offsets to the pixel values of the input image. More...

static Image	Add (Image img, double value, PixelOverflow overflow)
	Add constant offsets to the pixel values of the input image. More...

static Image	Multiply (Image img, double[] values, PixelOverflow overflow)
	Multiply constant values to the pixel values of the input image. More...

static Image	Multiply (Image img, double value, PixelOverflow overflow)
	Multiply constant values to the pixel values of the input image. More...

static Image	Subtract (Image img, double[] values)
	Subtract constant offsets from the pixel values of the input image. More...

static Image	SubtractAbs (Image img, double[] values)
	Subtract constant offsets from the pixel values of the input image. More...

static Image	Subtract (Image img, double value)
	Subtract constant offsets from the pixel values of the input image. More...

static Image	SubtractAbs (Image img, double value)
	Subtract constant offsets from the pixel values of the input image. More...

static Image	Divide (Image img, double[] values)
	Divide pixel values from the input image by constant values. More...

static Image	Divide (Image img, double value)
	Divide pixel values from the input image by a constant value. More...

Detailed Description

Collection of arithmetic functions from the Foundation Package.

Member Function Documentation

◆ Absolute()

static Image Absolute ( Image img )

static

Determines the absolute values of the pixels in the input image img .

Of course calling this function on an image with unsigned pixels will have no effect.

Parameters

img	Input image

Returns: Result image

Exceptions

ArgumentNullException	If the input img is null
ObjectDisposedException	If the input img has already been disposed

◆ Add() [1/3]

static Image Add	(	Image	img,
		double	value,
		PixelOverflow	overflow
	)

static

Add constant offsets to the pixel values of the input image.

If the parameter overflow is set to PixelOverflow.Scale, the resulting pixel values are divided to fit the dynamic range of the image (truncated otherwise).

Parameters

img	Input image
value	Value to be added to each plane
overflow	Defines how arithmetic overflow is handled.

Returns: Result image

Exceptions

ArgumentNullException	If the input img is null
ObjectDisposedException	If the input img has already been disposed

◆ Add() [2/3]

static Image Add	(	Image	img,
		double[]	values,
		PixelOverflow	overflow
	)

static

Add constant offsets to the pixel values of the input image.

If the parameter overflow is set to PixelOverflow.Scale, the resulting pixel values are divided to fit the dynamic range of the image (truncated otherwise).

Parameters

img	Input image
values	Values to be added (at least one per plane in img
overflow	Defines how arithmetic overflow is handled.

Returns: Result image

Exceptions

ArgumentNullException	If the input img or values is null.
ObjectDisposedException	If the input img has already been disposed.

◆ Add() [3/3]

static Image Add	(	Image	img1,
		Image	img2,
		PixelOverflow	overflow
	)

static

Add the pixel values of both input images to obtain the output image.

If the parameter overflow is set to PixelOverflow.Scale, the resulting pixel values are divided to fit the dynamic range of the image (truncated otherwise).

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

Parameters

img1	Input image 1
img2	Input image 2
overflow	Defines how arithmetic overflow is handled.

Returns: Result image

Exceptions

ArgumentNullException	If the input img1 /img2 is null.
ObjectDisposedException	If the input img1 /img2 has already been disposed.

◆ Divide() [1/3]

static Image Divide	(	Image	img,
		double	value
	)

static

Divide pixel values from the input image by a constant value.

Parameters

img	Input image
value	Value to divide each plane by

Returns: Transformed image

Exceptions

ArgumentNullException	If the input img is null
ObjectDisposedException	If the input img has already been disposed
CvbException	When value is 0.

◆ Divide() [2/3]

static Image Divide	(	Image	img,
		double[]	values
	)

static

Divide pixel values from the input image by constant values.

Parameters

img	Input image
values	Values to divide by (at least one per plane inimg )

Returns: Result image

Exceptions

ArgumentNullException	If the input img or values is null.
ObjectDisposedException	If the input img has already been disposed
ArgumentException	When values contains less values than the img has planes.
CvbException	When values contains 0.

◆ Divide() [3/3]

static Image Divide	(	Image	img1,
		Image	img2,
		int	upShift
	)

static

Divide the pixel values of img2 by the pixel values of img2 to obtain the output image and shift them up by upShift bits to preserve information.

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

Parameters

img1	Input image 1
img2	Input image 2
upShift	Result shift parameter

Returns: Result image.

Exceptions

ArgumentNullException	If the input img1 /img2 is null.
ObjectDisposedException	If the input img1 /img2 has already been disposed.

◆ Multiply() [1/3]

static Image Multiply	(	Image	img,
		double	value,
		PixelOverflow	overflow
	)

static

Multiply constant values to the pixel values of the input image.

If the parameter overflow is set to PixelOverflow.Scale, the resulting pixel values are divided to fit the dynamic range of the image (truncated otherwise).

Parameters

img	Input image
value	Value to be multiplied to each plane
overflow	Defines how arithmetic overflow is handled.

Returns: Result image

Exceptions

ArgumentNullException	If the input img is null
ObjectDisposedException	If the input img has already been disposed

◆ Multiply() [2/3]

static Image Multiply	(	Image	img,
		double[]	values,
		PixelOverflow	overflow
	)

static

Multiply constant values to the pixel values of the input image.

If the parameter overflow is set to PixelOverflow.Scale, the resulting pixel values are divided to fit the dynamic range of the image (truncated otherwise).

Parameters

img	Input image
values	Values to be multiplied (at least one per plane inimg
overflow	Defines how arithmetic overflow is handled.

Returns: Result image

Exceptions

ArgumentNullException	If the input img or values is null.
ObjectDisposedException	If the input img has already been disposed

◆ Multiply() [3/3]

static Image Multiply	(	Image	img1,
		Image	img2,
		PixelOverflow	overflow
	)

static

Multiply the pixel values of both input images to obtain the output image.

If the parameter overflow is set to PixelOverflow.Scale, the resulting pixel values are divided to fit the dynamic range of the image (truncated otherwise).

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

Parameters

img1	Input image 1
img2	Input image 2
overflow	Defines how arithmetic overflow is handled.

Returns: Result image

Exceptions

ArgumentNullException	If the input img1 /img2 is null.
ObjectDisposedException	If the input img1 /img2 has already been disposed.

◆ Sqrt()

static Image Sqrt	(	Image	img,
		SqrtPixelScaling	scaling
	)

static

Calculates the square roots of pixel values of a source image and writes them into the destination image.

If the parameter scaling is SqrtPixelScaling.AsIs, the resulting image has pixel values as they come out of the calculation. If SqrtPixelScaling.Yes, the results will be multiplied to fit the dynamic range of the image; effectively turning this function into a gamma correction with a gamma value of 1/2.

Parameters

img	Input image
scaling	Whether or not to scale the result.

Returns: Result image

Exceptions

ArgumentNullException	If the input img is null
ObjectDisposedException	If the input img has already been disposed

◆ Square()

static Image Square	(	Image	img,
		PixelOverflow	overflow
	)

static

Squares the pixel values of the input image to obtain the output image.

If the parameter overflow is set to PixelOverflow.Scale, the resulting pixel values are divided to fit the dynamic range of the image (truncated otherwise). Scaling effectively turns this function into a gamma correction with a gamma value of 2.

Parameters

img	Input image
overflow	Defines how arithmetic overflow is handled.

Returns: Result image

Exceptions

ArgumentNullException	If the input img is null
ObjectDisposedException	If the input img has already been disposed

◆ Subtract() [1/3]

static Image Subtract	(	Image	img,
		double	value
	)

static

Subtract constant offsets from the pixel values of the input image.

Negative results are saturated at DataType.MinVal.

Parameters

img	Input image
value	Value to be subtracted to each plane

Returns: Result image

Exceptions

ArgumentNullException	If the input img is null
ObjectDisposedException	If the input img has already been disposed

◆ Subtract() [2/3]

static Image Subtract	(	Image	img,
		double[]	values
	)

static

Subtract constant offsets from the pixel values of the input image.

Negative results are saturated at DataType.MinVal.

Parameters

img	Input image
values	Values to be subtracted (at least one per plane inimg

Returns: Result image

Exceptions

ArgumentNullException	If the input img or values is null.
ObjectDisposedException	If the input img has already been disposed

◆ Subtract() [3/3]

static Image Subtract	(	Image	img1,
		Image	img2
	)

static

Subtract the pixel values of img2 from img1 to obtain the output image.

Negative results are saturated at DataType.MinVal.

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

Parameters

img1	Input image 1
img2	Input image 2

Returns: Result image.

Exceptions

ArgumentNullException	If the input img1 /img2 is null.
ObjectDisposedException	If the input img1 /img2 has already been disposed.

◆ SubtractAbs() [1/3]

static Image SubtractAbs	(	Image	img,
		double	value
	)

static

Subtract constant offsets from the pixel values of the input image.

The stored results are the absolute value (see Math.Abs(double)) of the difference of both pixels.

Parameters

img	Input image
value	Value to be subtracted to each plane

Returns: Result image

Exceptions

ArgumentNullException	If the input img is null
ObjectDisposedException	If the input img has already been disposed

◆ SubtractAbs() [2/3]

static Image SubtractAbs	(	Image	img,
		double[]	values
	)

static

Subtract constant offsets from the pixel values of the input image.

The stored results are the absolute value (see Math.Abs(double)) of the difference of both pixels.

Parameters

img	Input image
values	Values to be subtracted (at least one per plane inimg

Returns: Result image

Exceptions

ArgumentNullException	If the input img or values is null.
ObjectDisposedException	If the input img has already been disposed

◆ SubtractAbs() [3/3]

static Image SubtractAbs	(	Image	img1,
		Image	img2
	)

static

Subtract the pixel values of img2 from img1 to obtain the output image.

The stored results are the absolute value (see Math.Abs(double)) of the difference of both pixels.

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

Parameters

img1	Input image 1
img2	Input image 2

Returns: Result image.

Exceptions

ArgumentNullException	If the input img1 /img2 is null.
ObjectDisposedException	If the input img1 /img2 has already been disposed.

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ Absolute()

◆ Add() [1/3]

◆ Add() [2/3]

◆ Add() [3/3]

◆ Divide() [1/3]

◆ Divide() [2/3]

◆ Divide() [3/3]

◆ Multiply() [1/3]

◆ Multiply() [2/3]

◆ Multiply() [3/3]

◆ Sqrt()

◆ Square()

◆ Subtract() [1/3]

◆ Subtract() [2/3]

◆ Subtract() [3/3]

◆ SubtractAbs() [1/3]

◆ SubtractAbs() [2/3]

◆ SubtractAbs() [3/3]