ImageUtils

java.lang.Object
- com.htmlhifive.pitalium.image.util.ImageUtils

public final class ImageUtils
extends java.lang.Object

画像操作を行うユーティリティクラス

メソッドのサマリー

All Methods Static Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`static double[][]`	`calcIntegralImage(java.awt.image.BufferedImage source)` 元画像の積分画像を生成します。
`static ImageComparedResult`	`compare(java.awt.image.BufferedImage image1, java.awt.Rectangle imageArea1, java.awt.image.BufferedImage image2, java.awt.Rectangle imageArea2, CompareOption[] options)` 2つの画像を比較し、差分を取得します。
`static java.util.List<ObjectGroup>`	`convertDiffPointsToObjectGroups(DiffPoints DP, int group_distance)` convert different points to the list of object groups which are completely merged
`static java.util.List<java.awt.Rectangle>`	`convertObjectGroupsToAreas(java.util.List<ObjectGroup> objectGroups)` cpnvert objectGroups to areas
`static double[]`	`countSubpixel(java.awt.image.BufferedImage bimage)` calculate the features of sub-pixel rendered text image
`static int`	`detectBackgroundColor(java.awt.image.BufferedImage b)` get estimated background color
`static Offset`	`findDominantOffset(java.awt.image.BufferedImage expectedImage, java.awt.image.BufferedImage actualImage, double diffThreshold)` find dominant offset between two images
`static java.awt.image.BufferedImage`	`getDiffImage(java.awt.image.BufferedImage leftImage, java.awt.image.BufferedImage rightImage, DiffPoints diffPoints)` 二つの画像と差分情報から差分確認用画像を取得します。
`static java.awt.image.BufferedImage`	`getDominantImage(java.awt.image.BufferedImage expectedImage, java.awt.image.BufferedImage actualImage, Offset offset)` using dominant offset, extract subImage from given expectedImage the size of subImage will be the same as the size of intersection of two images.
`static java.awt.image.BufferedImage`	`getMarkedImage(java.awt.image.BufferedImage image, DiffPoints diffPoints)` 指定のポイントをマークした画像を作成します。
`static java.awt.image.BufferedImage`	`getMaskedImage(java.awt.image.BufferedImage image, java.util.List<java.awt.Rectangle> maskAreas)` 指定エリアをマスクした画像を生成します。
`static boolean`	`getObjectRectangle(java.awt.image.BufferedImage image, java.awt.Rectangle rectangle)` find object rectangle in given rectangle area if find, replace given rectangle object with object rectangle
`static int[]`	`getRGB(java.awt.image.BufferedImage image, int width, int height)` 指定した画像のRGBベースのピクセル配列を取得します。
`static int`	`getSizeRelationType(int expectedWidth, int expectedHeight, int actualWidth, int actualHeight)` In order to find dominant offset, we have to consider the relationship between two image sizes.
`static java.awt.image.BufferedImage`	`getSubImage(java.awt.image.BufferedImage image, java.awt.Rectangle rectangle)` get sub-image from given image and rectangle
`static java.awt.Rectangle`	`getTightDiffArea(java.awt.Rectangle rectangle, int xLimit, int yLimit)` get tight differences area
`static boolean`	`imageEquals(java.awt.image.BufferedImage image1, java.awt.image.BufferedImage image2)` 画像を比較し、同一であるかどうかを取得します。
`static boolean`	`isContained(java.awt.image.BufferedImage entireImage, java.awt.image.BufferedImage partImage)` 全体画像の中に指定した部分画像が含まれているかどうかを取得します。
`static java.awt.image.BufferedImage`	`merge(java.util.List<java.util.List<java.awt.image.BufferedImage>> images)` 画像を結合し、1枚の画像にします。
`static double`	`norm(int pixel1, int pixel2)` L2 norm between two RGB pixel values
`static void`	`removeOverlappingRectangles(java.util.List<java.awt.Rectangle> rectangles)` remove overlapping rectangles for better UI
`static void`	`removeRedundantRectangles(java.util.List<java.awt.Rectangle> rectangles, int xLimit, int yLimit)` remove redundant rectangles.
`static void`	`reshapeRect(java.awt.Rectangle rectangle, int xLimit, int yLimit)` if the given rectangle may occur raster error, reshape it
`static int[]`	`toARGB(int pixel)` integer pixel value to aRGB array
`static int`	`toPixel(int[] argb)` RGB array to integer pixel value
`static int`	`toPixel(int r, int g, int b)` RGB to integer pixel value (alpha is set as 255)
`static int`	`toPixel(int a, int r, int g, int b)` aRGB to integer pixel value
`static java.awt.image.BufferedImage`	`trim(java.awt.image.BufferedImage image, int trimTop, int trimLeft, int trimBottom, int trimRight)` 画像を指定の値でトリムします。
`static java.awt.image.BufferedImage`	`verticalMerge(java.util.List<java.awt.image.BufferedImage> images)` 画像を縦に結合し、1枚の画像にします。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- メソッドの詳細
  - compare
```
public static ImageComparedResult compare(java.awt.image.BufferedImage image1,
                                          java.awt.Rectangle imageArea1,
                                          java.awt.image.BufferedImage image2,
                                          java.awt.Rectangle imageArea2,
                                          CompareOption[] options)
```
    2つの画像を比較し、差分を取得します。
    
    パラメータ:
    
    image1 - 画像1
    
    imageArea1 - 画像1の比較範囲
    
    image2 - 画像2
    
    imageArea2 - 画像2の比較範囲
    
    options - 比較オプション
    
    戻り値:
    
    比較結果
  - isContained
```
public static boolean isContained(java.awt.image.BufferedImage entireImage,
                                  java.awt.image.BufferedImage partImage)
```
    全体画像の中に指定した部分画像が含まれているかどうかを取得します。
    
    パラメータ:
    
    entireImage - 全体画像
    
    partImage - 部分画像
    
    戻り値:
    
    全体画像の中に部分画像が含まれていればtrue、含まれていなければfalse
  - calcIntegralImage
```
public static double[][] calcIntegralImage(java.awt.image.BufferedImage source)
```
    元画像の積分画像を生成します。
    
    パラメータ:
    
    source - 元画像
    
    戻り値:
    
    積分結果の配列
  - imageEquals
```
public static boolean imageEquals(java.awt.image.BufferedImage image1,
                                  java.awt.image.BufferedImage image2)
```
    画像を比較し、同一であるかどうかを取得します。
    
    パラメータ:
    
    image1 - 一つの画像
    
    image2 - 二つ目のがぞおう
    
    戻り値:
    
    二つの画像が同一である場合true、異なる画像の場合false
  - getMaskedImage
```
public static java.awt.image.BufferedImage getMaskedImage(java.awt.image.BufferedImage image,
                                                          java.util.List<java.awt.Rectangle> maskAreas)
```
    指定エリアをマスクした画像を生成します。
    
    パラメータ:
    
    image - マスクする画像
    
    maskAreas - マスクするエリア
    
    戻り値:
    
    指定エリアをマスクした画像
  - getMarkedImage
```
public static java.awt.image.BufferedImage getMarkedImage(java.awt.image.BufferedImage image,
                                                          DiffPoints diffPoints)
```
    指定のポイントをマークした画像を作成します。
    
    パラメータ:
    
    image - 対象の画像
    
    diffPoints - マークするポイント
    
    戻り値:
    
    マークした画像
  - getDiffImage
```
public static java.awt.image.BufferedImage getDiffImage(java.awt.image.BufferedImage leftImage,
                                                        java.awt.image.BufferedImage rightImage,
                                                        DiffPoints diffPoints)
```
    二つの画像と差分情報から差分確認用画像を取得します。
    
    パラメータ:
    
    leftImage - 左側の画像
    
    rightImage - 右側の画像
    
    diffPoints - 差分データ
    
    戻り値:
    
    差分確認用画像
  - trim
```
public static java.awt.image.BufferedImage trim(java.awt.image.BufferedImage image,
                                                int trimTop,
                                                int trimLeft,
                                                int trimBottom,
                                                int trimRight)
```
    画像を指定の値でトリムします。
    
    パラメータ:
    
    image - 元画像
    
    trimTop - 上方向のトリム値
    
    trimLeft - 左方向のトリム値
    
    trimBottom - 下方向のトリム値
    
    trimRight - 右方向のトリム値
    
    戻り値:
    
    トリム済の画像
  - verticalMerge
```
public static java.awt.image.BufferedImage verticalMerge(java.util.List<java.awt.image.BufferedImage> images)
```
    画像を縦に結合し、1枚の画像にします。
    
    パラメータ:
    
    images - 結合前の画像群
    
    戻り値:
    
    結合後の画像
  - merge
```
public static java.awt.image.BufferedImage merge(java.util.List<java.util.List<java.awt.image.BufferedImage>> images)
```
    画像を結合し、1枚の画像にします。
    
    パラメータ:
    
    images - 結合前の画像群
    
    戻り値:
    
    結合後の画像
  - getRGB
```
public static int[] getRGB(java.awt.image.BufferedImage image,
                           int width,
                           int height)
```
    指定した画像のRGBベースのピクセル配列を取得します。
    
    パラメータ:
    
    image - 対象の画像
    
    width - 読み込む幅
    
    height - 読み込む高さ
    
    戻り値:
    
    ピクセル配列
  - toARGB
```
public static int[] toARGB(int pixel)
```
    integer pixel value to aRGB array
    
    パラメータ:
    
    pixel -
    
    戻り値:
    
    aRGB value array
  - toPixel
```
public static int toPixel(int[] argb)
```
    RGB array to integer pixel value
    
    パラメータ:
    
    argb -
    
    戻り値:
    
    integer pixel value
  - toPixel
```
public static int toPixel(int r,
                          int g,
                          int b)
```
    RGB to integer pixel value (alpha is set as 255)
    
    パラメータ:
    
    r -
    
    g -
    
    b -
    
    戻り値:
    
    integer pixel value
  - toPixel
```
public static int toPixel(int a,
                          int r,
                          int g,
                          int b)
```
    aRGB to integer pixel value
    
    パラメータ:
    
    a -
    
    r -
    
    g -
    
    b -
    
    戻り値:
    
    integer pixel value
  - detectBackgroundColor
```
public static int detectBackgroundColor(java.awt.image.BufferedImage b)
```
    get estimated background color
    
    パラメータ:
    
    b -
    
    戻り値:
    
    most frequent color.
  - getObjectRectangle
```
public static boolean getObjectRectangle(java.awt.image.BufferedImage image,
                                         java.awt.Rectangle rectangle)
```
    find object rectangle in given rectangle area if find, replace given rectangle object with object rectangle
    
    パラメータ:
    
    image -
    
    rectangle -
    
    戻り値:
    
    true if finding object rectangle succeeds
  - norm
```
public static double norm(int pixel1,
                          int pixel2)
```
    L2 norm between two RGB pixel values
    
    パラメータ:
    
    pixel1 -
    
    pixel2 -
    
    戻り値:
    
    d(R)^2 + d(G)^2 + d(B)^2
  - countSubpixel
```
public static double[] countSubpixel(java.awt.image.BufferedImage bimage)
```
    calculate the features of sub-pixel rendered text image
    
    パラメータ:
    
    bimage -
    
    戻り値:
    
    smoothly rendered edges rate over all colored chunk and number of chunks per line.
  - removeRedundantRectangles
```
public static void removeRedundantRectangles(java.util.List<java.awt.Rectangle> rectangles,
                                             int xLimit,
                                             int yLimit)
```
    remove redundant rectangles. Each of them may occur raster error, or has smaller length than minLength.
    
    パラメータ:
    
    rectangles - list of rectangles
    
    xLimit - limit of x+width of given rectangle
    
    yLimit - limit of y+height of given rectangle
  - removeOverlappingRectangles
```
public static void removeOverlappingRectangles(java.util.List<java.awt.Rectangle> rectangles)
```
    remove overlapping rectangles for better UI
    
    パラメータ:
    
    rectangles - the list of rectangles which will be checker overlapping
  - reshapeRect
```
public static void reshapeRect(java.awt.Rectangle rectangle,
                               int xLimit,
                               int yLimit)
```
    if the given rectangle may occur raster error, reshape it
    
    パラメータ:
    
    rectangle - Rectangle which will be reshaped
    
    xLimit - limit of x+width of given rectangle
    
    yLimit - limit of y+height of given rectangle
  - getTightDiffArea
```
public static java.awt.Rectangle getTightDiffArea(java.awt.Rectangle rectangle,
                                                  int xLimit,
                                                  int yLimit)
```
    get tight differences area
    
    パラメータ:
    
    rectangle -
    
    xLimit -
    
    yLimit -
    
    戻り値:
  - convertObjectGroupsToAreas
```
public static java.util.List<java.awt.Rectangle> convertObjectGroupsToAreas(java.util.List<ObjectGroup> objectGroups)
```
    cpnvert objectGroups to areas
    
    パラメータ:
    
    objectGroups -
    
    戻り値:
  - convertDiffPointsToObjectGroups
```
public static java.util.List<ObjectGroup> convertDiffPointsToObjectGroups(DiffPoints DP,
                                                                          int group_distance)
```
    convert different points to the list of object groups which are completely merged
    
    パラメータ:
    
    DP - DiffPoints
    
    group_distance - distance for grouping
    
    戻り値:
    
    list of object groups which are completely merged
  - getSubImage
```
public static java.awt.image.BufferedImage getSubImage(java.awt.image.BufferedImage image,
                                                       java.awt.Rectangle rectangle)
```
    get sub-image from given image and rectangle
    
    パラメータ:
    
    image -
    
    rectangle -
    
    戻り値:
    
    sub-image of given area
  - findDominantOffset
```
public static Offset findDominantOffset(java.awt.image.BufferedImage expectedImage,
                                        java.awt.image.BufferedImage actualImage,
                                        double diffThreshold)
```
    find dominant offset between two images
    
    パラメータ:
    
    expectedImage -
    
    actualImage -
    
    diffThreshold - threshold to ignore small difference
    
    戻り値:
    
    Offset contains offsetX and offsetY
  - getDominantImage
```
public static java.awt.image.BufferedImage getDominantImage(java.awt.image.BufferedImage expectedImage,
                                                            java.awt.image.BufferedImage actualImage,
                                                            Offset offset)
```
    using dominant offset, extract subImage from given expectedImage the size of subImage will be the same as the size of intersection of two images.
    
    パラメータ:
    
    expectedImage - the image which we want to extract sub-image from
    
    actualImage - the other image
    
    offset - dominant offset between two images
    
    戻り値:
    
    subImage of expectedImage at dominant offset
  - getSizeRelationType
```
public static int getSizeRelationType(int expectedWidth,
                                      int expectedHeight,
                                      int actualWidth,
                                      int actualHeight)
```
    In order to find dominant offset, we have to consider the relationship between two image sizes.
    
    パラメータ:
    
    expectedWidth - width of expectedImage
    
    expectedHeight - height of expectedImage
    
    actualWidth - width of actualImage
    
    actualHeight - height of actualImage
    
    戻り値:
    
    the number of type of size-relationship 1 when actualImage is bigger than expectedImage 2 when expectedImage is bigger than actualImage 3 when the width of expectedImage is larger and the height of actualImage is larger. 4 when the width of actualImage is larger and the height of expectedImage is larger.

クラス ImageUtils

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

メソッドの詳細

compare

isContained

calcIntegralImage

imageEquals

getMaskedImage

getMarkedImage

getDiffImage

trim

verticalMerge

merge

getRGB

toARGB

toPixel

toPixel

toPixel

detectBackgroundColor

getObjectRectangle

norm

countSubpixel

removeRedundantRectangles

removeOverlappingRectangles

reshapeRect

getTightDiffArea

convertObjectGroupsToAreas

convertDiffPointsToObjectGroups

getSubImage

findDominantOffset

getDominantImage

getSizeRelationType