Pixa (tess-two 9.0.0 API)

java.lang.Object
- com.googlecode.leptonica.android.Pixa

All Implemented Interfaces:

Iterable<Pix>
```
public class Pixa
extends Object
implements Iterable<Pix>
```
Java representation of a native PIXA object. This object contains multiple PIX objects and their associated bounding BOX objects.

Constructor Summary

Constructors
Constructor and Description

Pixa(long nativePixa, int width, int height)
Creates a wrapper for the specified native Pixa pointer.

Constructors
Constructor and Description
`Pixa(long nativePixa, int width, int height)` Creates a wrapper for the specified native Pixa pointer.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Pix pix, Box box, int mode)` Adds a Pix and associated Box to this Pixa.
`void`	`addBox(Box box, int mode)` Adds a Box to this Pixa.
`void`	`addPix(Pix pix, int mode)` Adds a Pix to this Pixa.
`Pixa`	`copy()` Creates a shallow copy of this Pixa.
`static Pixa`	`createPixa(int size)` Creates a new Pixa with the specified minimum capacity.
`static Pixa`	`createPixa(int size, int width, int height)` Creates a new Pixa with the specified minimum capacity.
`protected void`	`finalize()`
`Box`	`getBox(int index)` Returns the Box at the specified index, or `null` on error.
`int[]`	`getBoxGeometry(int index)` Returns a geometry array for the Box at the specified index.
`boolean`	`getBoxGeometry(int index, int[] dimensions)` Fills an array with the geometry of the Box at the specified index.
`Rect`	`getBoxRect(int index)` Returns a bounding Rect for the Box at the specified index.
`ArrayList<Rect>`	`getBoxRects()` Returns an ArrayList of Box bounding Rects.
`int`	`getHeight()` Returns the height of this Pixa, or 0 if one was not set when it was created.
`long`	`getNativePixa()` Returns a pointer to the native PIXA object.
`Pix`	`getPix(int index)` Returns the Pix at the specified index, or `null` on error.
`Rect`	`getRect()` Returns a bounding Rect for this Pixa, which may be (0,0,0,0) if width and height were not specified on creation.
`int`	`getWidth()` Returns the width of this Pixa, or 0 if one was not set when it was created.
`Iterator<Pix>`	`iterator()`
`boolean`	`join(Pixa otherPixa)` Merges the contents of another Pixa into this one.
`void`	`mergeAndReplacePix(int indexA, int indexB)` Merges the Pix at the specified indices and removes the Pix at the second index.
`void`	`recycle()` Recycles this Pixa and frees natively allocated memory.
`void`	`replacePix(int index, Pix pix, Box box)` Replaces the Pix and Box at the specified index with the specified Pix and Box, both of which may be recycled after calling this method.
`int`	`size()` Returns the number of elements in this Pixa.
`Pixa`	`sort(int field, int order)` Sorts this Pixa using the specified field and order.
`boolean`	`writeToFileRandomCmap(File file)` Writes the components of this Pix to a bitmap-formatted file using a random color map.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Pixa
```
public Pixa(long nativePixa,
            int width,
            int height)
```
    Creates a wrapper for the specified native Pixa pointer.
    
    Parameters:
    
    nativePixa - Native pointer to a PIXA object.
    
    width - The width of the PIXA.
    
    height - The height of the PIXA.
- Method Detail
  - createPixa
```
public static Pixa createPixa(int size)
```
    Creates a new Pixa with the specified minimum capacity. The Pixa will expand automatically as new Pix are added.
    
    Parameters:
    
    size - The minimum capacity of this Pixa.
    
    Returns:
    
    a new Pixa or null on error
  - createPixa
```
public static Pixa createPixa(int size,
                              int width,
                              int height)
```
    Creates a new Pixa with the specified minimum capacity. The Pixa will expand automatically as new Pix are added.
    If non-zero, the specified width and height will be used to specify the bounds of output images. *
    
    Parameters:
    
    size - The minimum capacity of this Pixa.
    
    width - (Optional) The width of this Pixa, use 0 for default.
    
    height - (Optional) The height of this Pixa, use 0 for default.
    
    Returns:
    
    a new Pixa or null on error
  - getNativePixa
```
public long getNativePixa()
```
    Returns a pointer to the native PIXA object. This is used by native code.
    
    Returns:
    
    a pointer to the native PIXA object
  - copy
```
public Pixa copy()
```
    Creates a shallow copy of this Pixa. Contained Pix are cloned, and the resulting Pixa may be recycled separately from the original.
    
    Returns:
    
    a shallow copy of this Pixa
  - sort
```
public Pixa sort(int field,
                 int order)
```
    Sorts this Pixa using the specified field and order. See Constants.L_SORT_BY_* and Constants.L_SORT_INCREASING or Constants.L_SORT_DECREASING.
    
    Parameters:
    
    field - The field to sort by. See Constants.L_SORT_BY_*.
    
    order - The order in which to sort. Must be either Constants.L_SORT_INCREASING or Constants.L_SORT_DECREASING.
    
    Returns:
    
    a sorted copy of this Pixa
  - size
```
public int size()
```
    Returns the number of elements in this Pixa.
    
    Returns:
    
    the number of elements in this Pixa
  - recycle
```
public void recycle()
```
    Recycles this Pixa and frees natively allocated memory. You may not access or modify the Pixa after calling this method.
    Any Pix obtained from this Pixa or copies of this Pixa will still be accessible until they are explicitly recycled or finalized by the garbage collector.
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - join
```
public boolean join(Pixa otherPixa)
```
    Merges the contents of another Pixa into this one.
    
    Parameters:
    
    otherPixa - The Pix to merge.
    
    Returns:
    
    true on success
  - addPix
```
public void addPix(Pix pix,
                   int mode)
```
    Adds a Pix to this Pixa.
    
    Parameters:
    
    pix - The Pix to add.
    
    mode - The mode in which to add this Pix, typically Constants.L_CLONE.
  - addBox
```
public void addBox(Box box,
                   int mode)
```
    Adds a Box to this Pixa.
    
    Parameters:
    
    box - The Box to add.
    
    mode - The mode in which to add this Box, typically Constants.L_CLONE.
  - add
```
public void add(Pix pix,
                Box box,
                int mode)
```
    Adds a Pix and associated Box to this Pixa.
    
    Parameters:
    
    pix - The Pix to add.
    
    box - The Box to add.
    
    mode - The mode in which to add this Pix and Box, typically Constants.L_CLONE.
  - getBox
```
public Box getBox(int index)
```
    Returns the Box at the specified index, or null on error.
    
    Parameters:
    
    index - The index of the Box to return.
    
    Returns:
    
    the Box at the specified index, or null on error
  - getPix
```
public Pix getPix(int index)
```
    Returns the Pix at the specified index, or null on error.
    
    Parameters:
    
    index - The index of the Pix to return.
    
    Returns:
    
    the Pix at the specified index, or null on error
  - getWidth
```
public int getWidth()
```
    Returns the width of this Pixa, or 0 if one was not set when it was created.
    
    Returns:
    
    the width of this Pixa, or 0 if one was not set when it was created
  - getHeight
```
public int getHeight()
```
    Returns the height of this Pixa, or 0 if one was not set when it was created.
    
    Returns:
    
    the height of this Pixa, or 0 if one was not set when it was created
  - getRect
```
public Rect getRect()
```
    Returns a bounding Rect for this Pixa, which may be (0,0,0,0) if width and height were not specified on creation.
    
    Returns:
    
    a bounding Rect for this Pixa
  - getBoxGeometry
```
public int[] getBoxGeometry(int index)
```
    Returns a geometry array for the Box at the specified index. See Box.INDEX_* for indices.
    
    Parameters:
    
    index - The index of the Box to get the geometry of.
    
    Returns:
    
    a bounding Rect for the Box at the specified index
  - getBoxGeometry
```
public boolean getBoxGeometry(int index,
                              int[] dimensions)
```
    Fills an array with the geometry of the Box at the specified index. See Box.INDEX_* for indices.
    
    Parameters:
    
    index - The index of the Box to get the geometry of.
    
    dimensions - The array to fill with Box geometry. Must be at least 4 elements.
    
    Returns:
    
    true on success
  - getBoxRect
```
public Rect getBoxRect(int index)
```
    Returns a bounding Rect for the Box at the specified index.
    
    Parameters:
    
    index - The index of the Box to get the bounding Rect of.
    
    Returns:
    
    a bounding Rect for the Box at the specified index
  - getBoxRects
```
public ArrayList<Rect> getBoxRects()
```
    Returns an ArrayList of Box bounding Rects.
    
    Returns:
    
    an ArrayList of Box bounding Rects
  - replacePix
```
public void replacePix(int index,
                       Pix pix,
                       Box box)
```
    Replaces the Pix and Box at the specified index with the specified Pix and Box, both of which may be recycled after calling this method.
    
    Parameters:
    
    index - The index of the Pix to replace.
    
    pix - The Pix to replace the existing Pix.
    
    box - The Box to replace the existing Box.
  - mergeAndReplacePix
```
public void mergeAndReplacePix(int indexA,
                               int indexB)
```
    Merges the Pix at the specified indices and removes the Pix at the second index.
    
    Parameters:
    
    indexA - The index of the first Pix.
    
    indexB - The index of the second Pix, which will be removed after merging.
  - writeToFileRandomCmap
```
public boolean writeToFileRandomCmap(File file)
```
    Writes the components of this Pix to a bitmap-formatted file using a random color map.
    
    Parameters:
    
    file - The file to write to.
    
    Returns:
    
    true on success
  - iterator
```
public Iterator<Pix> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Pix>

Class Pixa

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Pixa

Method Detail

createPixa

createPixa

getNativePixa

copy

sort

size

recycle

finalize

join

addPix

addBox

add

getBox

getPix

getWidth

getHeight

getRect

getBoxGeometry

getBoxGeometry

getBoxRect

getBoxRects

replacePix

mergeAndReplacePix

writeToFileRandomCmap

iterator