IplImage (JavaCPP Presets for OpenCV 4.3.0-1.5.3 API)

java.lang.Object
- org.bytedeco.javacpp.Pointer
- - org.bytedeco.opencv.opencv_core.AbstractArray
  - - org.bytedeco.opencv.opencv_core.CvArr
    - - org.bytedeco.opencv.opencv_core.AbstractIplImage
      - org.bytedeco.opencv.opencv_core.IplImage

All Implemented Interfaces:

AutoCloseable, Indexable

Direct Known Subclasses:

AbstractIplImage.HeaderReleaseDeallocator, AbstractIplImage.ReleaseDeallocator
```
@Properties(inherit=opencv_core.class)
public class IplImage
extends AbstractIplImage
```
The IplImage is taken from the Intel Image Processing Library, in which the format is native. OpenCV only supports a subset of possible IplImage formats, as outlined in the parameter list above.
In addition to the above restrictions, OpenCV handles ROIs differently. OpenCV functions require that the image size or ROI size of all source and destination images match exactly. On the other hand, the Intel Image Processing Library processes the area of intersection between the source and destination images (or ROIs), allowing them to vary independently.

Nested Class Summary
- Nested classes/interfaces inherited from class org.bytedeco.opencv.opencv_core.AbstractIplImage
  AbstractIplImage.HeaderReleaseDeallocator, AbstractIplImage.ReleaseDeallocator
- Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer
  Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary
- Fields inherited from class org.bytedeco.opencv.opencv_core.AbstractIplImage
  pointer
- Fields inherited from class org.bytedeco.javacpp.Pointer
  address, capacity, limit, position

Constructor Summary

Constructors
Constructor and Description

IplImage()
Default native constructor.

IplImage(long size)
Native array allocator.

IplImage(Pointer p)
Pointer cast constructor.

Constructors
Constructor and Description
`IplImage()` Default native constructor.
`IplImage(long size)` Native array allocator.
`IplImage(Pointer p)` Pointer cast constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`align()` Alignment of image rows (4 or 8).
`IplImage`	`align(int setter)`
`int`	`alphaChannel()` Ignored by OpenCV
`IplImage`	`alphaChannel(int setter)`
`IntPointer`	`BorderConst()`
`int`	`BorderConst(int i)` Ditto.
`IplImage`	`BorderConst(int i, int setter)`
`IntPointer`	`BorderMode()`
`int`	`BorderMode(int i)` Ignored by OpenCV.
`IplImage`	`BorderMode(int i, int setter)`
`BytePointer`	`channelSeq()`
`byte`	`channelSeq(int i)` ditto
`IplImage`	`channelSeq(int i, byte setter)`
`BytePointer`	`colorModel()`
`byte`	`colorModel(int i)` Ignored by OpenCV
`IplImage`	`colorModel(int i, byte setter)`
`int`	`dataOrder()` 0 - interleaved color channels, 1 - separate color channels.
`IplImage`	`dataOrder(int setter)`
`int`	`depth()` Pixel depth in bits: IPL_DEPTH_8U, IPL_DEPTH_8S, IPL_DEPTH_16S, IPL_DEPTH_32S, IPL_DEPTH_32F and IPL_DEPTH_64F are supported.
`IplImage`	`depth(int setter)`
`int`	`height()` Image height in pixels.
`IplImage`	`height(int setter)`
`int`	`ID()` version (=0)
`IplImage`	`ID(int setter)`
`BytePointer`	`imageData()` Pointer to aligned image data.
`IplImage`	`imageData(BytePointer setter)`
`BytePointer`	`imageDataOrigin()` Pointer to very origin of image data (not necessarily aligned) - needed for correct deallocation
`IplImage`	`imageDataOrigin(BytePointer setter)`
`Pointer`	`imageId()` " "
`IplImage`	`imageId(Pointer setter)`
`int`	`imageSize()` Image data size in bytes (==image->height*image->widthStep in case of interleaved data)
`IplImage`	`imageSize(int setter)`
`IplImage`	`maskROI()` Must be NULL.
`IplImage`	`maskROI(IplImage setter)`
`int`	`nChannels()` Most of OpenCV functions support 1,2,3 or 4 channels
`IplImage`	`nChannels(int setter)`
`int`	`nSize()` sizeof(IplImage)
`IplImage`	`nSize(int setter)`
`int`	`origin()` 0 - top-left origin, 1 - bottom-left origin (Windows bitmaps style).
`IplImage`	`origin(int setter)`
`IplImage`	`position(long position)`
`IplROI`	`roi()` Image ROI.
`IplImage`	`roi(IplROI setter)`
`IplTileInfo`	`tileInfo()` " "
`IplImage`	`tileInfo(IplTileInfo setter)`
`int`	`width()` Image width in pixels.
`IplImage`	`width(int setter)`
`int`	`widthStep()` Size of aligned image row in bytes.
`IplImage`	`widthStep(int setter)`

Methods inherited from class org.bytedeco.opencv.opencv_core.AbstractIplImage
arrayChannels, arrayData, arrayDepth, arrayHeight, arrayOrigin, arrayOrigin, arrayROI, arraySize, arrayStep, arrayWidth, asCvMat, clone, create, create, create, create, create, createCompatible, createHeader, createHeader, createHeader, createHeader, createIfNotCompatible, release

Methods inherited from class org.bytedeco.opencv.opencv_core.AbstractArray
createBuffer, createBuffer, createIndexer, createIndexer, cvSize, getByteBuffer, getByteBuffer, getDoubleBuffer, getDoubleBuffer, getFloatBuffer, getFloatBuffer, getIntBuffer, getIntBuffer, getShortBuffer, getShortBuffer, highValue, toString

Methods inherited from class org.bytedeco.javacpp.Pointer
address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IplImage
```
public IplImage()
```
    Default native constructor.
  - IplImage
```
public IplImage(long size)
```
    Native array allocator. Access with Pointer.position(long).
  - IplImage
```
public IplImage(Pointer p)
```
    Pointer cast constructor. Invokes Pointer.Pointer(Pointer).
- Method Detail
  - position
```
public IplImage position(long position)
```
    Overrides:
    
    position in class Pointer
  - nSize
```
public int nSize()
```
    sizeof(IplImage)
  - nSize
```
public IplImage nSize(int setter)
```
  - ID
```
public int ID()
```
    version (=0)
  - ID
```
public IplImage ID(int setter)
```
  - nChannels
```
public int nChannels()
```
    Most of OpenCV functions support 1,2,3 or 4 channels
    
    Specified by:
    
    nChannels in class AbstractIplImage
  - nChannels
```
public IplImage nChannels(int setter)
```
  - alphaChannel
```
public int alphaChannel()
```
    Ignored by OpenCV
  - alphaChannel
```
public IplImage alphaChannel(int setter)
```
  - depth
```
public int depth()
```
    Pixel depth in bits: IPL_DEPTH_8U, IPL_DEPTH_8S, IPL_DEPTH_16S, IPL_DEPTH_32S, IPL_DEPTH_32F and IPL_DEPTH_64F are supported.
    
    Specified by:
    
    depth in class AbstractIplImage
  - depth
```
public IplImage depth(int setter)
```
  - colorModel
```
@Cast(value="char")
public byte colorModel(int i)
```
    Ignored by OpenCV
  - colorModel
```
public IplImage colorModel(int i,
                           byte setter)
```
  - colorModel
```
@MemberGetter
 @Cast(value="char*")
public BytePointer colorModel()
```
  - channelSeq
```
@Cast(value="char")
public byte channelSeq(int i)
```
    ditto
  - channelSeq
```
public IplImage channelSeq(int i,
                           byte setter)
```
  - channelSeq
```
@MemberGetter
 @Cast(value="char*")
public BytePointer channelSeq()
```
  - dataOrder
```
public int dataOrder()
```
    0 - interleaved color channels, 1 - separate color channels. cvCreateImage can only create interleaved images
  - dataOrder
```
public IplImage dataOrder(int setter)
```
  - origin
```
public int origin()
```
    0 - top-left origin, 1 - bottom-left origin (Windows bitmaps style).
    
    Specified by:
    
    origin in class AbstractIplImage
  - origin
```
public IplImage origin(int setter)
```
    Specified by:
    
    origin in class AbstractIplImage
  - align
```
public int align()
```
    Alignment of image rows (4 or 8). OpenCV ignores it and uses widthStep instead.
  - align
```
public IplImage align(int setter)
```
  - width
```
public int width()
```
    Image width in pixels.
    
    Specified by:
    
    width in class AbstractIplImage
  - width
```
public IplImage width(int setter)
```
  - height
```
public int height()
```
    Image height in pixels.
    
    Specified by:
    
    height in class AbstractIplImage
  - height
```
public IplImage height(int setter)
```
  - roi
```
public IplROI roi()
```
    Image ROI. If NULL, the whole image is selected.
    
    Specified by:
    
    roi in class AbstractIplImage
  - roi
```
public IplImage roi(IplROI setter)
```
  - maskROI
```
public IplImage maskROI()
```
    Must be NULL.
  - maskROI
```
public IplImage maskROI(IplImage setter)
```
  - imageId
```
public Pointer imageId()
```
    " "
  - imageId
```
public IplImage imageId(Pointer setter)
```
  - tileInfo
```
public IplTileInfo tileInfo()
```
    " "
  - tileInfo
```
public IplImage tileInfo(IplTileInfo setter)
```
  - imageSize
```
public int imageSize()
```
    Image data size in bytes (==image->height*image->widthStep in case of interleaved data)
    
    Specified by:
    
    imageSize in class AbstractIplImage
  - imageSize
```
public IplImage imageSize(int setter)
```
  - imageData
```
@Cast(value="char*")
public BytePointer imageData()
```
    Pointer to aligned image data.
    
    Specified by:
    
    imageData in class AbstractIplImage
  - imageData
```
public IplImage imageData(BytePointer setter)
```
  - widthStep
```
public int widthStep()
```
    Size of aligned image row in bytes.
    
    Specified by:
    
    widthStep in class AbstractIplImage
  - widthStep
```
public IplImage widthStep(int setter)
```
  - BorderMode
```
public int BorderMode(int i)
```
    Ignored by OpenCV.
  - BorderMode
```
public IplImage BorderMode(int i,
                           int setter)
```
  - BorderMode
```
@MemberGetter
public IntPointer BorderMode()
```
  - BorderConst
```
public int BorderConst(int i)
```
    Ditto.
  - BorderConst
```
public IplImage BorderConst(int i,
                            int setter)
```
  - BorderConst
```
@MemberGetter
public IntPointer BorderConst()
```
  - imageDataOrigin
```
@Cast(value="char*")
public BytePointer imageDataOrigin()
```
    Pointer to very origin of image data (not necessarily aligned) - needed for correct deallocation
  - imageDataOrigin
```
public IplImage imageDataOrigin(BytePointer setter)
```

Class IplImage

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.opencv.opencv_core.AbstractIplImage

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Field Summary

Fields inherited from class org.bytedeco.opencv.opencv_core.AbstractIplImage

Fields inherited from class org.bytedeco.javacpp.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.bytedeco.opencv.opencv_core.AbstractIplImage

Methods inherited from class org.bytedeco.opencv.opencv_core.AbstractArray

Methods inherited from class org.bytedeco.javacpp.Pointer

Methods inherited from class java.lang.Object

Constructor Detail

IplImage

IplImage

IplImage

Method Detail

position

nSize

nSize

ID

ID

nChannels

nChannels

alphaChannel

alphaChannel

depth

depth

colorModel

colorModel

colorModel

channelSeq

channelSeq

channelSeq

dataOrder

dataOrder

origin

origin

align

align

width

width

height

height

roi

roi

maskROI

maskROI

imageId

imageId

tileInfo

tileInfo

imageSize

imageSize

imageData

imageData

widthStep

widthStep

BorderMode

BorderMode

BorderMode

BorderConst

BorderConst

BorderConst

imageDataOrigin

imageDataOrigin