er.attachment.thumbnail

Class ImageMagickImageProcessor

java.lang.Object

er.attachment.thumbnail.ERImageProcessor

er.attachment.thumbnail.ImageMagickImageProcessor

All Implemented Interfaces:

IERImageProcessor

public class ImageMagickImageProcessor
extends ERImageProcessor

ImageMagickImageProcessor is an implementation of the IImageProcessor interface on top of the ImageMagick commandline tool. You must provide your own installation of ImageMagick, specifically the "convert" and "composite" binaries (along with any dependencies they require).

Author:

mschrag

Properties

Name	Description
er.attachment.ImageProcessor.imageMagickBinFolder	er.attachment.ImageProcessor.imageMagickBinFolder

Nested Class Summary

Nested classes/interfaces inherited from interface er.attachment.thumbnail.IERImageProcessor

IERImageProcessor.Quality

Field Summary

Fields inherited from class er.attachment.thumbnail.ERImageProcessor

_imageProcessor, log

Constructor Summary

Constructors

Constructor and Description
ImageMagickImageProcessor(File imageMagickConvertBinary, File imageMagickCompositeBinary) Constructs a new ImageMagickImageProcessor using a max memory setting of 128M.
ImageMagickImageProcessor(File imageMagickConvertBinary, File imageMagickCompositeBinary, long maxMemory) Constructs a new ImageMagickImageProcessor.

Method Summary

Modifier and Type	Method and Description
static IERImageProcessor	imageMagickImageProcessor() Returns an ImageMagick image processor.
void	processImage(int resizeWidth, int resizeHeight, IERImageProcessor.Quality resizeQuality, int dpi, float sharpenRadius, float sharpenIntensity, float gamma, int cropX, int cropY, int cropWidth, int cropHeight, File watermarkFile, boolean tileWatermark, float compressionQuality, File colorProfileFile, File inputFile, File outputFile, ERMimeType outputMimeType) Processes the given image with all of the given configuration settings.

Methods inherited from class er.attachment.thumbnail.ERImageProcessor

imageProcessor, thumbnail, thumbnail

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageMagickImageProcessor

public ImageMagickImageProcessor(File imageMagickConvertBinary,
                                 File imageMagickCompositeBinary)

Constructs a new ImageMagickImageProcessor using a max memory setting of 128M.

Parameters:

imageMagickConvertBinary - the "convert" binary path

imageMagickCompositeBinary - the "composite" binary path

ImageMagickImageProcessor

public ImageMagickImageProcessor(File imageMagickConvertBinary,
                                 File imageMagickCompositeBinary,
                                 long maxMemory)

Constructs a new ImageMagickImageProcessor.

Parameters:

imageMagickConvertBinary - the "convert" binary path

imageMagickCompositeBinary - the "composite" binary path

maxMemory - the memory limit in bytes

Method Detail

processImage

public void processImage(int resizeWidth,
                         int resizeHeight,
                         IERImageProcessor.Quality resizeQuality,
                         int dpi,
                         float sharpenRadius,
                         float sharpenIntensity,
                         float gamma,
                         int cropX,
                         int cropY,
                         int cropWidth,
                         int cropHeight,
                         File watermarkFile,
                         boolean tileWatermark,
                         float compressionQuality,
                         File colorProfileFile,
                         File inputFile,
                         File outputFile,
                         ERMimeType outputMimeType)
                  throws IOException

Description copied from interface: IERImageProcessor

Processes the given image with all of the given configuration settings. Order: resize/dpi, colorspace, crop, sharpen, gamma, watermark

指定イメージを指定パラメータで処理します 順番: リサイズ/dpi, カラー・スペース, 切り取り, シャープ, ガンマ, ウォーターマーク

Parameters:

resizeWidth -

the maximum width to resize to (or -1 to not specify)

リサイズする最大幅 (又は -1 は指定なし)

resizeHeight -

the maximum height to resize to (or -1 to not specify)

リサイズする最大高 (又は -1 は指定なし)

resizeQuality -

influences the resize algorithm to use (or null to not specify)

リサイズ・アルゴリズム (又は null は指定なし)

dpi -

the dpi to resize to (or -1 to skip)

リサイズする新 dpi (又は -1 はスキップ)

sharpenRadius -

the radius of the unsharp mask (or <= 0.0 to skip)

アンシャープマスクの半径 (又は <= 0.0 はスキップ)

sharpenIntensity -

the intensity of the unsharp mask (or <= 0.0 to skip)

アンシャープマスクの強度 (又は <= 0.0 はスキップ)

gamma -

the gamma to apply (or 0.0 to skip)

適用するガンマ (又は 0.0 はスキップ)

cropX -

the x position of the crop (or <= 0 to skip)

x 切り取り位置 (又は <= 0 はスキップ)

cropY -

the y position of the crop (or <= 0 to skip)

y 切り取り位置 (又は <= 0 はスキップ)

cropWidth -

the width of the crop (or <= 0 to skip)

切り取り幅 (又は <= 0 はスキップ)

cropHeight -

the height of the crop (or <= 0 to skip)

切り取り高 (又は <= 0 はスキップ)

watermarkFile -

the watermark File to apply to this image (or null to skip)

ウォーターマーク・ファイル (又は null はスキップ)

tileWatermark -

whether or not to tile the watermark

ウォーターマークをタイルするかどうか

compressionQuality -

the compression quality of the resize to perform (0.0 to ignore) -- range is 0.0 to 1.0 (1.0 = best)

リサイズの圧縮品質 (0.0 は無視) -- 範囲は 0.0 〜 1.0 (1.0 = 最高)

colorProfileFile -

the ICC profile to use (or null to skip)

ICC カラー・プロファイル (又は null はスキップ)

inputFile -

the File to perform the given operations on

処理対象ファイル

outputFile -

the File to write the resulting output image to

結果ファイルの出力先

outputMimeType -

the desired mime type of the output file

出力 Mime タイプ

Throws:

IOException -

if the image processing fails

イメージ処理中にエラーが発生した場合

imageMagickImageProcessor

public static IERImageProcessor imageMagickImageProcessor()
                                                   throws IOException

Returns an ImageMagick image processor.

Returns:

an ImageMagick image processor

Throws:

IOException - if an ImageMagick cannot be created