org.gm4java.im4java

Class GMOperation

java.lang.Object

org.im4java.core.Operation

org.im4java.core.GMOps

org.im4java.core.GMOperation

org.gm4java.im4java.GMOperation

public class GMOperation
extends org.im4java.core.GMOperation

This class extends the im4java version of GMOperation and provide a list of convenience methods to ease the construction of the image command for GraphicsMagick.

Author:

Michael Magpayo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GMOperation.GeometryAnnotation Options which modify the behavior of the 'width X height' specification for geometry-based settings.
static class	GMOperation.Gravity Used in conjunction with other settings, generally defines how to interpret the offset for geometry-based options.
static class	GMOperation.RotationAnnotation Options which modify the behavior of the 'degrees' specification for rotation-based settings.

Field Summary

Fields inherited from class org.im4java.core.Operation

IMG_PLACEHOLDER

Constructor Summary

Constructors

Constructor and Description
GMOperation()

Method Summary

Methods

Modifier and Type	Method and Description
GMOperation	addImage(File file) Add image to operation.
GMOperation	addRawArg(String arg) Add raw text to the list of arguments.
GMOperation	drawText(String text, int offsetX, int offsetY) Draws text overlay on image with the upper-right corner defined by the offsetX and offsetY parameters.
GMOperation	font(String style, int size, String color) Defines font for text overlay.
GMOperation	gravity(GMOperation.Gravity value) Defines the gravity for geometry-based operations.
GMOperation	grayscale(int depth) Convert the image to grayscale (i.e.
GMOperation	limitThreads(int threadsPerProcess) Limits the number of threads used by the GraphicsMagick process during execution.
GMOperation	quality(double quality) Add option -quality to the GraphicsMagick commandline (see the documentation of GraphicsMagick for details).
GMOperation	resize(int width, int height, Collection<GMOperation.GeometryAnnotation> annotations) Resize source to desired target dimensions, using default resizing filter algorithm.
GMOperation	rotate(double degrees, GMOperation.RotationAnnotation annotation) Rotates the image, with empty triangles back-filled using default background color.
GMOperation	scale(int width, int height, Collection<GMOperation.GeometryAnnotation> annotations) Scale source to desired target dimensions, using simplified resizing algorithm with pixel averaging.
GMOperation	source(File file, Integer width, Integer height) Specifies the source image to convert.
GMOperation	stripProfiles() Strips out ICC profiles.

Methods inherited from class org.im4java.core.GMOperation

appendHorizontally, appendVertically

Methods inherited from class org.im4java.core.GMOps

adjoin, affine, affine, affine, affine, affine, affine, affine, antialias, append, authenticate, authenticate, average, backdrop, background, background, blackThreshold, blackThreshold, blackThreshold, bluePrimary, bluePrimary, bluePrimary, blur, blur, blur, border, border, border, bordercolor, bordercolor, borderwidth, borderwidth, borderwidth, borderwidth, borderwidth, borderwidth, box, box, channel, channel, charcoal, charcoal, chop, chop, chop, chop, chop, chop, clip, clippath, coalesce, colorize, colorize, colorize, colorize, colors, colors, colorspace, colorspace, comment, comment, compress, compress, contrast, convolve, convolve, convolve, convolve, convolve, convolve, convolve, convolve, convolve, convolve, convolve, convolve, convolve, convolve, convolve, convolve, convolve, crop, crop, crop, crop, crop, crop, cycle, cycle, debug, debug, deconstruct, define, define, delay, delay, delay, delay, density, density, density, depth, depth, despeckle, display, display, display, display, dispose, dispose, dither, dither, draw, draw, edge, edge, emboss, emboss, encoding, encoding, endian, endian, enhance, equalize, fill, fill, filter, filter, flatten, flip, flop, font, font, frame, frame, frame, frame, frame, fuzz, fuzz, fuzz, gamma, gamma, gaussian, gaussian, gaussian, geometry, geometry, geometry, geometry, geometry, gravity, gravity, greenPrimary, greenPrimary, greenPrimary, help, implode, implode, intent, intent, interlace, interlace, label, label, lat, lat, lat, lat, lat, level, level, level, level, level, limit, limit, list, list, log, log, loop, loop, map, map, mask, mask, matte, median, median, modulate, modulate, modulate, modulate, monitor, monochrome, morph, morph, mosaic, motionBlur, motionBlur, motionBlur, motionBlur, negate, noise, noise, noop, normalize, opaque, opaque, operator, operator, operator, operator, operator, orderedDither, orderedDither, orderedDither, outputDirectory, outputDirectory, p_adjoin, p_antialias, p_append, p_borderwidth, p_compress, p_contrast, p_debug, p_define, p_define, p_dither, p_endian, p_frame, p_gamma, p_gamma, p_label, p_map, p_mask, p_matte, p_negate, p_noise, p_noise, p_page, p_ping, p_profile, p_profile, p_progress, p_raise, p_raise, p_raise, p_remap, p_render, p_shade, p_shade, p_shade, p_write, p_write, page, page, page, page, page, page, paint, paint, pause, pause, pen, pen, ping, pointsize, pointsize, preview, preview, process, process, profile, profile, quality, quality, raise, raise, raise, randomThreshold, randomThreshold, randomThreshold, randomThreshold, redPrimary, redPrimary, redPrimary, region, region, region, region, region, render, resample, resample, resample, resize, resize, resize, resize, roll, roll, roll, rotate, rotate, rotate, sample, sample, sample, sample, sample, samplingFactor, samplingFactor, samplingFactor, scale, scale, scale, scale, scale, scene, scene, seed, segment, segment, segment, set, set, set, shade, shade, shade, sharpen, sharpen, sharpen, shave, shave, shave, shave, shear, shear, shear, size, size, size, size, solarize, solarize, spread, spread, stroke, stroke, strokewidth, strokewidth, swirl, swirl, texture, texture, threshold, threshold, threshold, tile, tile, transform, transparent, transparent, treedepth, treedepth, trim, type, type, undercolor, undercolor, units, units, unsharp, unsharp, unsharp, unsharp, unsharp, verbose, version, view, view, virtualPixel, virtualPixel, wave, wave, wave, whitePoint, whitePoint, whitePoint, whiteThreshold, whiteThreshold, whiteThreshold, write, write

Methods inherited from class org.im4java.core.Operation

addDynamicOperation, addImage, addImage, addImage, addOperation, addRawArgs, addRawArgs, cloneObject, getCmdArgs, getDynamicOperations, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GMOperation

public GMOperation()

Method Detail

limitThreads

public GMOperation limitThreads(int threadsPerProcess)

Limits the number of threads used by the GraphicsMagick process during execution. Note that no validation is made, so ensure that the value is a non-positive integer presumably less than the maximum CPU cores on the host.

Parameters:

threadsPerProcess - Number of threads to use per process.

Returns:

Builder object for chained options setup.

resize

public GMOperation resize(int width,
                 int height,
                 Collection<GMOperation.GeometryAnnotation> annotations)

Resize source to desired target dimensions, using default resizing filter algorithm.

Parameters:

width - Length in pixels of the target image's width.

height - Length in pixels of the target image's height.

annotations - Geometry annotations to define how the width and height options are to be interpreted.

Returns:

Builder object for chained options setup.

scale

public GMOperation scale(int width,
                int height,
                Collection<GMOperation.GeometryAnnotation> annotations)

Scale source to desired target dimensions, using simplified resizing algorithm with pixel averaging.

Parameters:

width - Length in pixels of the target image's width.

height - Length in pixels of the target image's height.

annotations - Geometry annotations to define how the width and height options are to be interpreted.

Returns:

Builder object for chained options setup.

rotate

public GMOperation rotate(double degrees,
                 GMOperation.RotationAnnotation annotation)

Rotates the image, with empty triangles back-filled using default background color.

Parameters:

degrees - The angle by which the image should be rotated. Positive numbers indicate clockwise direction; negative numbers indicate counterclockwise direction.

annotation - Rotate annotation to define when rotation should happen.

Returns:

Builder object for chained options setup.

gravity

public GMOperation gravity(GMOperation.Gravity value)

Defines the gravity for geometry-based operations. See documentation for more details, as this option works in conjunction with various options in different ways.

Parameters:

value - Gravity value to use, defining the coordinate system to use.

Returns:

Builder object for chained options setup.

grayscale

public GMOperation grayscale(int depth)

Convert the image to grayscale (i.e. replace color encoding with smaller gray encoding).

Parameters:

depth - the depth of the grayscale

Returns:

Builder object for chained options setup.

stripProfiles

public GMOperation stripProfiles()

Strips out ICC profiles.

Returns:

Builder object for chained options setup.

font

public GMOperation font(String style,
               int size,
               String color)

Defines font for text overlay.

Parameters:

style - Text font style (system-dependent based on installed fonts).

size - Text point size.

color - Text color, either named or #RGB variant.

Returns:

Builder object for chained options setup.

drawText

public GMOperation drawText(String text,
                   int offsetX,
                   int offsetY)

Draws text overlay on image with the upper-right corner defined by the offsetX and offsetY parameters. Note that will affect how the offset values are interpreted.

Parameters:

text - Text to write.

offsetX - Offset value in the horizontal direction.

offsetY - Offset value in the vertical direction.

Returns:

Builder object for chained options setup.

source

public GMOperation source(File file,
                 @CheckForNull
                 Integer width,
                 @CheckForNull
                 Integer height)
                   throws IOException

Specifies the source image to convert.

Parameters:

file - Source image file to convert.

width - Length in pixels of the source image's width; if null or negative, the in-memory size definition is omitted. Optional.

height - Length in pixels of the source image's height; if null or negative, the in-memory size definition is omitted. Optional.

Returns:

Builder object for chained options setup.

Throws:

IOException - when the source file does not exist.

addImage

public GMOperation addImage(File file)

Add image to operation.

Parameters:

file - image file to be added.

Returns:

Builder object for chained options setup.

addRawArg

public GMOperation addRawArg(String arg)

Add raw text to the list of arguments.

Parameters:

arg - argument to add

Returns:

Builder object for chained options setup.

quality

public GMOperation quality(double quality)

Add option -quality to the GraphicsMagick commandline (see the documentation of GraphicsMagick for details).

Parameters:

quality - the quality of the image from 0 - 100

Returns:

Builder object for chained options setup