com.aspose.imaging.magicwand.imagemasks

Class ImageGrayscaleMask

java.lang.Object

com.aspose.imaging.magicwand.imagemasks.ImageGrayscaleMask

All Implemented Interfaces:

IImageMask, com.aspose.ms.System.ICloneable

public class ImageGrayscaleMask
extends Object
implements IImageMask

Describes a grayscale image mask.

Code example:

The example shows how to select a complicated area of an image using Magic Wand tool and the ability to interact with masks (invert, union, subtract).

String imageFilePath = "input.png";
String outputFilePath = "masked-complex.png";
try (RasterImage image = (RasterImage)Image.load(imageFilePath))
{
    // Create a new mask using magic wand tool based on tone and color of pixel (845, 128)
    MagicWandTool.select(image, new MagicWandSettings(845, 128))
            // Union the existing mask with the specified one created by magic wand tool
            .union(new MagicWandSettings(416, 387))
            // Invert the existing mask
            .invert()
            // Subtract the specified mask created by magic wand tool with specified threshold from the existing one
            .subtract(new MagicWandSettings(1482, 346) {{ setThreshold(69); }})
            // Subtract four specified rectangle masks from the existing mask one by one
            .subtract(new RectangleMask(0, 0, 800, 150))
            .subtract(new RectangleMask(0, 380, 600, 220))
            .subtract(new RectangleMask(930, 520, 110, 40))
            .subtract(new RectangleMask(1370, 400, 120, 200))
            // Feather mask with specified settings
            .getFeathered(new FeatheringSettings() {{ setSize(3); }})
            // Apply mask to the image
            .apply();

    // Save image
    image.save(outputFilePath);
}

Constructor Summary

Constructors

Constructor and Description
ImageGrayscaleMask(int width, int height) Initializes a new instance of the ImageGrayscaleMask class with the specified width and height.
ImageGrayscaleMask(RasterImage image) Initializes a new instance of the ImageGrayscaleMask class with the size of the specified existing RasterImage.

Method Summary

Modifier and Type	Method and Description
void	apply() Applies current mask to the RasterImage source, if exists.
void	applyTo(RasterImage image) Applies current mask to the specified RasterImage.
ImageGrayscaleMask	crop(int width, int height) Crops mask with the specified width and height.
ImageGrayscaleMask	crop(Rectangle rectangle) Crops mask with the specified rectangle.
ImageGrayscaleMask	crop(Size size) Crops mask with the specified size.
Object	deepClone() Creates a new object that is a copy of the current instance.
ImageGrayscaleMask	exclusiveDisjunction(ImageGrayscaleMask mask) Gets the exclusive disjunction of current mask with provided.
byte	get_Item(int x, int y) Gets the opacity of the specified pixel.
Rectangle	getBounds() Gets the bounds, in pixels, of this mask.
byte	getByteOpacity(int x, int y) Gets the opacity of the specified pixel with byte precision.
int	getHeight() Gets the height, in pixels, of this mask.
Rectangle	getSelectionBounds() Gets the bounds of the selected part of the mask, in pixels.
RasterImage	getSource() Gets the source image used to create this mask, if exists.
int	getWidth() Gets the width, in pixels, of this mask.
ImageGrayscaleMask	intersect(ImageGrayscaleMask mask) Gets the intersection of current mask with provided.
ImageGrayscaleMask	invert() Gets the inversion of the current mask.
boolean	isOpaque(int x, int y) Checks if the specified pixel is opaque.
boolean	isTransparent(int x, int y) Checks if the specified pixel is transparent.
static ImageGrayscaleMask	op_Addition(ImageGrayscaleMask a, ImageGrayscaleMask b) Union of two masks.
static ImageGrayscaleMask	op_ExclusiveOr(ImageGrayscaleMask a, ImageGrayscaleMask b) Exclusive disjunction of two masks.
static ImageGrayscaleMask	op_LogicalNot(ImageGrayscaleMask a) Inverts mask.
static ImageGrayscaleMask	op_Multiply(ImageGrayscaleMask a, ImageGrayscaleMask b) Intersection of two masks.
static ImageGrayscaleMask	op_Subtraction(ImageGrayscaleMask a, ImageGrayscaleMask b) Subtract second mask from first.
void	set_Item(int x, int y, byte value) Sets the opacity of the specified pixel.
ImageGrayscaleMask	subtract(ImageGrayscaleMask mask) Gets the subtraction of the provided mask from current.
ImageGrayscaleMask	union(ImageGrayscaleMask mask) Union of two masks.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageGrayscaleMask

public ImageGrayscaleMask(int width,
                          int height)

Initializes a new instance of the ImageGrayscaleMask class with the specified width and height.

Parameters:

width - Width of the mask.

height - Height of the mask.

ImageGrayscaleMask

public ImageGrayscaleMask(RasterImage image)

Initializes a new instance of the ImageGrayscaleMask class with the size of the specified existing RasterImage. Specified RasterImage will be stored as source image.

Parameters:

image - Source image.

Method Detail

getSource

public final RasterImage getSource()

Gets the source image used to create this mask, if exists.

Specified by:

getSource in interface IImageMask

Returns:

the source image used to create this mask, if exists.

getWidth

public final int getWidth()

Gets the width, in pixels, of this mask.

Specified by:

getWidth in interface IImageMask

Returns:

the width, in pixels, of this mask.

getHeight

public final int getHeight()

Gets the height, in pixels, of this mask.

Specified by:

getHeight in interface IImageMask

Returns:

the height, in pixels, of this mask.

getBounds

public final Rectangle getBounds()

Gets the bounds, in pixels, of this mask.

Specified by:

getBounds in interface IImageMask

Returns:

the bounds, in pixels, of this mask.

getSelectionBounds

public final Rectangle getSelectionBounds()

Gets the bounds of the selected part of the mask, in pixels.

Specified by:

getSelectionBounds in interface IImageMask

Returns:

the bounds of the selected part of the mask, in pixels.

get_Item

public final byte get_Item(int x,
                           int y)

Gets the opacity of the specified pixel.

Parameters:

x - The x-coordinate of the pixel.

y - The y-coordinate of the pixel. Value: Byte value; 0 if transparent; 255 if opaque.

set_Item

public final void set_Item(int x,
                           int y,
                           byte value)

Sets the opacity of the specified pixel.

Parameters:

x - The x-coordinate of the pixel.

y - The y-coordinate of the pixel. Value: Byte value; 0 if transparent; 255 if opaque.

value - the opacity of the specified pixel.

isOpaque

public final boolean isOpaque(int x,
                              int y)

Checks if the specified pixel is opaque.

Specified by:

isOpaque in interface IImageMask

Parameters:

x - The x-coordinate of the pixel.

y - The y-coordinate of the pixel.

Returns:

true if the specified pixel is opaque; otherwise, false.

isTransparent

public final boolean isTransparent(int x,
                                   int y)

Checks if the specified pixel is transparent.

Specified by:

isTransparent in interface IImageMask

Parameters:

x - The x-coordinate of the pixel.

y - The y-coordinate of the pixel.

Returns:

true if the specified pixel is transparent; otherwise, false.

getByteOpacity

public final byte getByteOpacity(int x,
                                 int y)

Gets the opacity of the specified pixel with byte precision.

Specified by:

getByteOpacity in interface IImageMask

Parameters:

x - The x-coordinate of the pixel.

y - The y-coordinate of the pixel.

Returns:

Byte value, representing the opacity of the specified pixel.

deepClone

public final Object deepClone()

Creates a new object that is a copy of the current instance.

Specified by:

deepClone in interface com.aspose.ms.System.ICloneable

Returns:

A new object that is a copy of this instance.

apply

public final void apply()

Applies current mask to the RasterImage source, if exists.

Throws:

com.aspose.ms.System.NullReferenceException - Thrown when the source image is not defined.

applyTo

public final void applyTo(RasterImage image)

Applies current mask to the specified RasterImage.

Parameters:

image - Image to apply mask to.

Throws:

com.aspose.ms.System.ArgumentNullException - Thrown when the image is not defined.

crop

public final ImageGrayscaleMask crop(Size size)

Crops mask with the specified size.

Parameters:

size - The specified size.

Returns:

A cropped ImageGrayscaleMask.

crop

public final ImageGrayscaleMask crop(int width,
                                     int height)

Crops mask with the specified width and height.

Parameters:

width - The specified width.

height - The specified height.

Returns:

A cropped ImageGrayscaleMask.

crop

public final ImageGrayscaleMask crop(Rectangle rectangle)

Crops mask with the specified rectangle.

Parameters:

rectangle - The specified rectangle.

Returns:

A cropped ImageGrayscaleMask.

invert

public final ImageGrayscaleMask invert()

Gets the inversion of the current mask.

Returns:

New ImageGrayscaleMask.

union

public final ImageGrayscaleMask union(ImageGrayscaleMask mask)

Union of two masks.

Parameters:

mask - Provided mask

Returns:

New ImageGrayscaleMask.

subtract

public final ImageGrayscaleMask subtract(ImageGrayscaleMask mask)

Gets the subtraction of the provided mask from current.

Parameters:

mask - Provided mask

Returns:

New ImageGrayscaleMask.

intersect

public final ImageGrayscaleMask intersect(ImageGrayscaleMask mask)

Gets the intersection of current mask with provided.

Parameters:

mask - Provided mask

Returns:

New ImageGrayscaleMask.

exclusiveDisjunction

public final ImageGrayscaleMask exclusiveDisjunction(ImageGrayscaleMask mask)

Gets the exclusive disjunction of current mask with provided.

Parameters:

mask - Provided mask

Returns:

New ImageGrayscaleMask.

op_LogicalNot

public static ImageGrayscaleMask op_LogicalNot(ImageGrayscaleMask a)

Inverts mask.

Parameters:

a - The mask to be inverted.

Returns:

New ImageGrayscaleMask.

op_Addition

public static ImageGrayscaleMask op_Addition(ImageGrayscaleMask a,
                                             ImageGrayscaleMask b)

Union of two masks.

Parameters:

a - The first mask.

b - The second mask.

Returns:

New ImageGrayscaleMask.

op_Subtraction

public static ImageGrayscaleMask op_Subtraction(ImageGrayscaleMask a,
                                                ImageGrayscaleMask b)

Subtract second mask from first.

Parameters:

a - The first mask.

b - The second mask.

Returns:

New ImageGrayscaleMask.

op_Multiply

public static ImageGrayscaleMask op_Multiply(ImageGrayscaleMask a,
                                             ImageGrayscaleMask b)

Intersection of two masks.

Parameters:

a - The first mask.

b - The second mask.

Returns:

New ImageGrayscaleMask.

op_ExclusiveOr

public static ImageGrayscaleMask op_ExclusiveOr(ImageGrayscaleMask a,
                                                ImageGrayscaleMask b)

Exclusive disjunction of two masks.

Parameters:

a - The first mask.

b - The second mask.

Returns:

New ImageGrayscaleMask.