Class IplImage

Represents an IPL image header.

Inheritance

Object

CVHandle

Arr

IplImage

Inherited Members

Arr.ElementType

Arr.Size

Arr.GetRow(Int32)

Arr.GetRows(Int32, Int32, Int32)

Arr.GetCol(Int32)

Arr.GetCols(Int32, Int32)

Arr.GetDiag(Int32)

Arr.GetDims(Int32[])

Arr.GetDimSize(Int32)

Arr.Ptr(Int32)

Arr.Ptr(Int32, Int32)

Arr.Ptr(Int32, Int32, Int32)

Arr.Ptr(Int32, Int32, Int32, Int32)

Arr.Ptr(Int32[])

Arr.Ptr(Int32[], Int32, Boolean)

Arr.Item[Int32]

Arr.Item[Int32, Int32]

Arr.Item[Int32, Int32, Int32]

Arr.Item[Int32[]]

Arr.GetReal(Int32)

Arr.GetReal(Int32, Int32)

Arr.GetReal(Int32, Int32, Int32)

Arr.GetReal(Int32[])

Arr.SetReal(Int32, Double)

Arr.SetReal(Int32, Int32, Double)

Arr.SetReal(Int32, Int32, Int32, Double)

Arr.SetReal(Int32[], Double)

Arr.ClearND(Int32[])

Arr.GetMat(Boolean)

Arr.GetImage()

Arr.Reshape(Int32, Int32)

Arr.SetData(IntPtr, Int32)

Arr.GetRawData(IntPtr)

Arr.GetRawData(IntPtr, Int32)

Arr.GetRawData(IntPtr, Int32, Size)

Arr.Set(Scalar, Arr)

Arr.SetZero()

Arr.CheckRange(CheckArrayFlags, Double, Double)

Namespace: OpenCV.Net

Assembly: OpenCV.Net.dll

Syntax

public class IplImage : Arr

Constructors

| Improve this Doc View Source

IplImage(Size, IplDepth, Int32)

Initializes a new instance of the IplImage class with the specified size, pixel bit depth and channels per element.

Declaration

public IplImage(Size size, IplDepth depth, int channels)

Parameters

Type	Name	Description
Size	size	The pixel-accurate size of the IplImage.
IplDepth	depth	The bit depth of image pixels.
Int32	channels	The number of channels per pixel.

| Improve this Doc View Source

IplImage(Size, IplDepth, Int32, IntPtr)

Initializes a new instance of the IplImage class with the specified size, pixel bit depth and channels per element. A pointer to the image raw data is provided.

Declaration

public IplImage(Size size, IplDepth depth, int channels, IntPtr data)

Parameters

Type	Name	Description
Size	size	The pixel-accurate size of the IplImage.
IplDepth	depth	The bit depth of image pixels.
Int32	channels	The number of channels per pixel.
IntPtr	data	A pointer to the image raw pixel data.

Properties

| Improve this Doc View Source

ChannelOfInterest

Gets or sets the image channel of interest. Only a few functions support COI.

Declaration

public int ChannelOfInterest { get; set; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

Channels

Gets the number of channels per image pixel.

Declaration

public int Channels { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

Depth

Gets the bit depth of image pixels.

Declaration

public IplDepth Depth { get; }

Property Value

Type	Description
IplDepth

| Improve this Doc View Source

Height

Gets the height of the image in pixels.

Declaration

public int Height { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

ImageData

Gets a pointer to the aligned image data.

Declaration

public IntPtr ImageData { get; }

Property Value

Type	Description
IntPtr

| Improve this Doc View Source

RegionOfInterest

Gets or sets the image region of interest.

Declaration

public Rect RegionOfInterest { get; set; }

Property Value

Type	Description
Rect

| Improve this Doc View Source

Width

Gets the width of the image in pixels.

Declaration

public int Width { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

WidthStep

Gets the size of the aligned image row in bytes.

Declaration

public int WidthStep { get; }

Property Value

Type	Description
Int32

Methods

| Improve this Doc View Source

Clone()

Creates a new IplImage that is a copy of the current instance.

Declaration

public IplImage Clone()

Returns

Type	Description
IplImage	A new IplImage that is a copy of this instance. WidthStep may differ.

| Improve this Doc View Source

GetSubRect(Rect)

Creates a new IplImage from a subrectangle of the current instance. No data is copied.

Declaration

public IplImage GetSubRect(Rect rect)

Parameters

Type	Name	Description
Rect	rect	Zero-based coordinates of the rectangle of interest.

Returns

Type	Description
IplImage	A new IplImage that corresponds to the specified rectangle of the current image.

| Improve this Doc View Source

ReleaseHandle()

Executes the code required to free the native IplImage handle.

Declaration

protected override bool ReleaseHandle()

Returns

Type	Description
Boolean	true if the handle is released successfully; otherwise, in the event of a catastrophic failure, false.

| Improve this Doc View Source

ResetRegionOfInterest()

Resets the image region and channel of interest.

Declaration

public void ResetRegionOfInterest()

| Improve this Doc View Source

ToString()

Creates a representation of this IplImage instance.

Declaration

public override string ToString()

Returns

Type	Description
String	A containing the width, height, depth and number of channels of this IplImage instance.

Operators

| Improve this Doc View Source

Addition(IplImage, IplImage)

Calculates the per-element sum of two IplImage values.

Declaration

public static IplImage operator +(IplImage left, IplImage right)

Parameters

Type	Name	Description
IplImage	left	The first value to add.
IplImage	right	The second value to add.

Returns

Type	Description
IplImage	The result of adding `left` and `right`.

| Improve this Doc View Source

Addition(IplImage, Scalar)

Calculates the per-element sum of a IplImage and a Scalar.

Declaration

public static IplImage operator +(IplImage left, Scalar right)

Parameters

Type	Name	Description
IplImage	left	The image to add.
Scalar	right	The scalar to add.

Returns

Type	Description
IplImage	The result of adding `left` and `right`.

| Improve this Doc View Source

Addition(IplImage, Double)

Calculates the per-element sum of a IplImage and a value.

Declaration

public static IplImage operator +(IplImage left, double right)

Parameters

Type	Name	Description
IplImage	left	The image to add.
Double	right	The scalar value to add.

Returns

Type	Description
IplImage	The result of adding `left` and `right`.

| Improve this Doc View Source

Addition(Scalar, IplImage)

Calculates the per-element sum of a Scalar and a IplImage.

Declaration

public static IplImage operator +(Scalar left, IplImage right)

Parameters

Type	Name	Description
Scalar	left	The scalar to add.
IplImage	right	The image to add.

Returns

Type	Description
IplImage	The result of adding `left` and `right`.

| Improve this Doc View Source

Addition(Double, IplImage)

Calculates the per-element sum of a value and a IplImage.

Declaration

public static IplImage operator +(double left, IplImage right)

Parameters

Type	Name	Description
Double	left	The scalar value to add.
IplImage	right	The image to add.

Returns

Type	Description
IplImage	The result of adding `left` and `right`.

| Improve this Doc View Source

BitwiseAnd(IplImage, IplImage)

Performs per-element bit-wise conjunction of two IplImage values.

Declaration

public static IplImage operator &(IplImage left, IplImage right)

Parameters

Type	Name	Description
IplImage	left	The first image value.
IplImage	right	The second image value.

Returns

Type	Description
IplImage	The result of performing the bit-wise conjunction of `left` and `right`.

| Improve this Doc View Source

BitwiseAnd(IplImage, Scalar)

Performs per-element bit-wise conjunction of a IplImage and a Scalar.

Declaration

public static IplImage operator &(IplImage left, Scalar right)

Parameters

Type	Name	Description
IplImage	left	The image value.
Scalar	right	The scalar value.

Returns

Type	Description
IplImage	The result of performing the bit-wise conjunction of `left` and `right`.

| Improve this Doc View Source

BitwiseAnd(IplImage, Double)

Performs per-element bit-wise conjunction of a IplImage and a value.

Declaration

public static IplImage operator &(IplImage left, double right)

Parameters

Type	Name	Description
IplImage	left	The image value.
Double	right	The scalar value.

Returns

Type	Description
IplImage	The result of performing the bit-wise conjunction of `left` and `right`.

| Improve this Doc View Source

BitwiseAnd(Scalar, IplImage)

Performs per-element bit-wise conjunction of a Scalar and a IplImage.

Declaration

public static IplImage operator &(Scalar left, IplImage right)

Parameters

Type	Name	Description
Scalar	left	The scalar value.
IplImage	right	The image value.

Returns

Type	Description
IplImage	The result of performing the bit-wise conjunction of `left` and `right`.

| Improve this Doc View Source

BitwiseAnd(Double, IplImage)

Performs per-element bit-wise conjunction of a value and a IplImage.

Declaration

public static IplImage operator &(double left, IplImage right)

Parameters

Type	Name	Description
Double	left	The scalar value.
IplImage	right	The image value.

Returns

Type	Description
IplImage	The result of performing the bit-wise conjunction of `left` and `right`.

| Improve this Doc View Source

BitwiseOr(IplImage, IplImage)

Performs per-element bit-wise disjunction of two IplImage values.

Declaration

public static IplImage operator |(IplImage left, IplImage right)

Parameters

Type	Name	Description
IplImage	left	The first image value.
IplImage	right	The second image value.

Returns

Type	Description
IplImage	The result of performing the bit-wise disjunction of `left` and `right`.

| Improve this Doc View Source

BitwiseOr(IplImage, Scalar)

Performs per-element bit-wise disjunction of a IplImage and a Scalar.

Declaration

public static IplImage operator |(IplImage left, Scalar right)

Parameters

Type	Name	Description
IplImage	left	The image value.
Scalar	right	The scalar value.

Returns

Type	Description
IplImage	The result of performing the bit-wise disjunction of `left` and `right`.

| Improve this Doc View Source

BitwiseOr(IplImage, Double)

Performs per-element bit-wise disjunction of a IplImage and a value.

Declaration

public static IplImage operator |(IplImage left, double right)

Parameters

Type	Name	Description
IplImage	left	The image value.
Double	right	The scalar value.

Returns

Type	Description
IplImage	The result of performing the bit-wise disjunction of `left` and `right`.

| Improve this Doc View Source

BitwiseOr(Scalar, IplImage)

Performs per-element bit-wise disjunction of a Scalar and a IplImage.

Declaration

public static IplImage operator |(Scalar left, IplImage right)

Parameters

Type	Name	Description
Scalar	left	The scalar value.
IplImage	right	The image value.

Returns

Type	Description
IplImage	The result of performing the bit-wise disjunction of `left` and `right`.

| Improve this Doc View Source

BitwiseOr(Double, IplImage)

Performs per-element bit-wise disjunction of a value and a IplImage.

Declaration

public static IplImage operator |(double left, IplImage right)

Parameters

Type	Name	Description
Double	left	The scalar value.
IplImage	right	The image value.

Returns

Type	Description
IplImage	The result of performing the bit-wise disjunction of `left` and `right`.

| Improve this Doc View Source

Division(IplImage, IplImage)

Calculates the per-element division of two IplImage values.

Declaration

public static IplImage operator /(IplImage left, IplImage right)

Parameters

Type	Name	Description
IplImage	left	The dividend.
IplImage	right	The divisor.

Returns

Type	Description
IplImage	The result of dividing `left` by `right`.

| Improve this Doc View Source

Division(IplImage, Double)

Calculates the per-element division of a IplImage by a scalar value.

Declaration

public static IplImage operator /(IplImage left, double right)

Parameters

Type	Name	Description
IplImage	left	The image dividend.
Double	right	The scalar divisor.

Returns

Type	Description
IplImage	The result of dividing `left` by `right`.

| Improve this Doc View Source

Division(Double, IplImage)

Calculates the per-element division of a scalar value by a IplImage.

Declaration

public static IplImage operator /(double left, IplImage right)

Parameters

Type	Name	Description
Double	left	The scalar dividend.
IplImage	right	The image divisor.

Returns

Type	Description
IplImage	The result of dividing `left` by `right`.

| Improve this Doc View Source

ExclusiveOr(IplImage, IplImage)

Performs per-element bit-wise "exclusive or" operation on two IplImage values.

Declaration

public static IplImage operator ^(IplImage left, IplImage right)

Parameters

Type	Name	Description
IplImage	left	The first image value.
IplImage	right	The second image value.

Returns

Type	Description
IplImage	The result of performing the bit-wise "exclusive or" operation of `left` and `right`.

| Improve this Doc View Source

ExclusiveOr(IplImage, Scalar)

Performs per-element bit-wise "exclusive or" operation of a IplImage and a Scalar.

Declaration

public static IplImage operator ^(IplImage left, Scalar right)

Parameters

Type	Name	Description
IplImage	left	The image value.
Scalar	right	The scalar value.

Returns

Type	Description
IplImage	The result of performing the bit-wise "exclusive or" operation of `left` and `right`.

| Improve this Doc View Source

ExclusiveOr(IplImage, Double)

Performs per-element bit-wise "exclusive or" operation of a IplImage and a value.

Declaration

public static IplImage operator ^(IplImage left, double right)

Parameters

Type	Name	Description
IplImage	left	The image value.
Double	right	The scalar value.

Returns

Type	Description
IplImage	The result of performing the bit-wise "exclusive or" operation of `left` and `right`.

| Improve this Doc View Source

ExclusiveOr(Scalar, IplImage)

Performs per-element bit-wise "exclusive or" operation of a Scalar and a IplImage.

Declaration

public static IplImage operator ^(Scalar left, IplImage right)

Parameters

Type	Name	Description
Scalar	left	The scalar value.
IplImage	right	The image value.

Returns

Type	Description
IplImage	The result of performing the bit-wise "exclusive or" operation of `left` and `right`.

| Improve this Doc View Source

ExclusiveOr(Double, IplImage)

Performs per-element bit-wise "exclusive or" operation of a value and a IplImage.

Declaration

public static IplImage operator ^(double left, IplImage right)

Parameters

Type	Name	Description
Double	left	The scalar value.
IplImage	right	The image value.

Returns

Type	Description
IplImage	The result of performing the bit-wise "exclusive or" operation of `left` and `right`.

| Improve this Doc View Source

Explicit(IplImage to Mat)

Converts a IplImage value to a Mat.

Declaration

public static explicit operator Mat(IplImage image)

Parameters

Type	Name	Description
IplImage	image	The image to convert.

Returns

Type	Description
Mat	A Mat value of the same size and element type.

| Improve this Doc View Source

Multiply(IplImage, IplImage)

Calculates the per-element product of two IplImage values.

Declaration

public static IplImage operator *(IplImage left, IplImage right)

Parameters

Type	Name	Description
IplImage	left	The first value to multiply.
IplImage	right	The second value to multiply.

Returns

Type	Description
IplImage	The result of multiplying `left` by `right`.

| Improve this Doc View Source

Multiply(IplImage, Double)

Calculates the per-element product of a IplImage by a scalar value.

Declaration

public static IplImage operator *(IplImage left, double right)

Parameters

Type	Name	Description
IplImage	left	The image to multiply.
Double	right	The scalar value to multiply.

Returns

Type	Description
IplImage	The result of multiplying `left` by `right`.

| Improve this Doc View Source

Multiply(Double, IplImage)

Calculates the per-element product of a scalar value by a IplImage.

Declaration

public static IplImage operator *(double left, IplImage right)

Parameters

Type	Name	Description
Double	left	The scalar value to multiply.
IplImage	right	The image to multiply.

Returns

Type	Description
IplImage	The result of multiplying `left` by `right`.

| Improve this Doc View Source

OnesComplement(IplImage)

Performs per-element bit-wise inversion of the specified IplImage value.

Declaration

public static IplImage operator ~(IplImage image)

Parameters

Type	Name	Description
IplImage	image	The image to invert.

Returns

Type	Description
IplImage	The result of bitwise inverting `image`.

| Improve this Doc View Source

Subtraction(IplImage, IplImage)

Calculates the per-element difference between two IplImage values.

Declaration

public static IplImage operator -(IplImage left, IplImage right)

Parameters

Type	Name	Description
IplImage	left	The minuend.
IplImage	right	The subtrahend.

Returns

Type	Description
IplImage	The result of subtracting `right` from `left`.

| Improve this Doc View Source

Subtraction(IplImage, Scalar)

Calculates the per-element difference between a IplImage and a Scalar.

Declaration

public static IplImage operator -(IplImage left, Scalar right)

Parameters

Type	Name	Description
IplImage	left	The image minuend.
Scalar	right	The scalar subtrahend.

Returns

Type	Description
IplImage	The result of subtracting `right` from `left`.

| Improve this Doc View Source

Subtraction(IplImage, Double)

Calculates the per-element difference between a IplImage and a value.

Declaration

public static IplImage operator -(IplImage left, double right)

Parameters

Type	Name	Description
IplImage	left	The image minuend.
Double	right	The scalar subtrahend.

Returns

Type	Description
IplImage	The result of subtracting `right` from `left`.

| Improve this Doc View Source

Subtraction(Scalar, IplImage)

Subtracts every element of the specified IplImage value from a Scalar.

Declaration

public static IplImage operator -(Scalar left, IplImage right)

Parameters

Type	Name	Description
Scalar	left	The scalar minuend.
IplImage	right	The image subtrahend.

Returns

Type	Description
IplImage	The result of subtracting `right` from `left`.

| Improve this Doc View Source

Subtraction(Double, IplImage)

Subtracts every element of the specified IplImage value from a value.

Declaration

public static IplImage operator -(double left, IplImage right)

Parameters

Type	Name	Description
Double	left	The scalar minuend.
IplImage	right	The image subtrahend.

Returns

Type	Description
IplImage	The result of subtracting `right` from `left`.

| Improve this Doc View Source

UnaryNegation(IplImage)

Negates the specified IplImage value.

Declaration

public static IplImage operator -(IplImage image)

Parameters

Type	Name	Description
IplImage	image	The image to negate.

Returns

Type	Description
IplImage	The result of `image` multiplied by negative one (-1).

| Improve this Doc View Source

UnaryPlus(IplImage)

Returns the IplImage value (the sign is unchanged).

Declaration

public static IplImage operator +(IplImage image)

Parameters

Type	Name	Description
IplImage	image	The image to return.

Returns

Type	Description
IplImage	The image `image`.