ColorImage

java.lang.Object
- comp102x.CanvasObject
- - comp102x.ColorImage

```
public class ColorImage
extends CanvasObject
```
The ColorImage class represents an image read from the file system. It also provides various method for manipulating the image.

Author:

leofan

Constructor Summary

Constructors
Constructor and Description
`ColorImage()` Constructs a ColorImage object by loading an image from the file system and re-scales it to fit the default canvas size.
`ColorImage(boolean rescale)` Constructs a ColorImage object by loading an image from the file system and re-scales it to fit the default canvas size if indicated.
`ColorImage(ColorImage copy)` Constructs a copy of the given ColorImage object.
`ColorImage(int width, int height)` Constructs a blank white ColorImage object with a specify width and height.
`ColorImage(java.lang.String filename)` Constructs a ColorImage object by using a filename and re-scales it to fit the default canvas size.
`ColorImage(java.lang.String filename, boolean rescale)` Constructs a ColorImage object by using a filename and re-scales it to fit the default canvas size if indicated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ColorImage`	`add(ColorImage operand)` Adds another ColorImage object to this ColorImage object.
`static ColorImage`	`add(ColorImage image1, ColorImage image2)` Adds two ColorImage objects together.
`void`	`add(int value)` Adds a value to all the RGB channels of this ColorImage object.
`double`	`averageDifference(ColorImage operand)` Gets the average difference between this ColorImage object and the other ColorImage object.
`void`	`convolve(float[][] kernel)` Convolves the ColorImage object with a specified kernel.
`ColorImage`	`createCyanImage()` Creates a copy of this ColorImage object with the red channel removed.
`ColorImage`	`createRedImage()` Creates a copy of this ColorImage object with the green and blue channel removed.
`void`	`decreaseBlue(int value)` Decreases the value of blue channel for all pixels.
`void`	`decreaseGreen(int value)` Decreases the value of green channel for all pixels.
`void`	`decreaseRed(int value)` Decreases the value of red channel for all pixels.
`ColorImage`	`divide(ColorImage operand)` Divides another ColorImage object to this ColorImage object.
`static ColorImage`	`divide(ColorImage image1, ColorImage image2)` Divides a ColorImage object object by another ColorImage object.
`void`	`divide(int value)` Divides all the RGB channels of this ColorImage object by a value.
`void`	`drawImage(ColorImage overImage, int x, int y)` Overlays another ColorImage object on top of the current one.
`void`	`drawOval(int x, int y, int width, int height)` Draws an oval on this ColorImage object
`void`	`drawOval(int x, int y, int width, int height, int red, int green, int blue)` Draws an oval on this ColorImage object with a specific color.
`void`	`drawRectangle(int x, int y, int width, int height)` Draws a rectangle on this ColorImage object.
`void`	`drawRectangle(int x, int y, int width, int height, int red, int green, int blue)` Draws a rectangle on this ColorImage object with a specific color.
`void`	`fillWithRandomNoise(int percentage, int dotSize)` Fills this ColorImage object with random pepper and salt noise.
`int`	`getAlpha(int x, int y)` Gets the value of alpha channel of a pixel.
`int`	`getBlue(int x, int y)` Gets the value of blue channel of a pixel.
`java.awt.Graphics2D`	`getGraphics2D()` Gets the graphics object of this ColorImage, which can be used for some graphics operations, e.g.
`int`	`getGreen(int x, int y)` Gets the value of green channel of a pixel.
`int`	`getRed(int x, int y)` Gets the value of red channel of a pixel.
`int[]`	`getRGB(int x, int y)` Gets the RGB values of a pixel.
`void`	`increaseBlue(int value)` Increases the value of blue channel for all pixels.
`void`	`increaseGreen(int value)` Increases the value of green channel for all pixels.
`void`	`increaseRed(int value)` Increases the value of red channel for all pixels.
`void`	`invert()` Inverts the ColorImage object by color.
`int`	`match(ColorImage target, boolean drawSquare)` Counts the number appearance of a sub image inside this image.
`ColorImage`	`multiply(ColorImage operand)` Multiplies another ColorImage object to this ColorImage object.
`static ColorImage`	`multiply(ColorImage image1, ColorImage image2)` Multiplies two ColorImage objects together.
`void`	`multiply(int value)` Multiplies a value to all the RGB channels of this ColorImage object.
`void`	`save()` Saves the color image to a .png image file.
`void`	`setAlpha(int x, int y, int a)` Sets the value of alpha channel of a pixel.
`void`	`setBlue(int x, int y, int value)` Sets the value of blue channel of a pixel.
`void`	`setGreen(int x, int y, int value)` Sets the value of green channel of a pixel.
`void`	`setRed(int x, int y, int value)` Sets the value of red channel of a pixel.
`void`	`setRGB(int x, int y, int r, int g, int b)` Sets the RGB values of a pixel.
`ColorImage`	`subtract(ColorImage operand)` Subtracts another ColorImage object to this ColorImage object.
`static ColorImage`	`subtract(ColorImage image1, ColorImage image2)` Subtracts a ColorImage object from another ColorImage object.
`void`	`subtract(int value)` Subtracts a value from all the RGB channels of this ColorImage object.
`void`	`threshold(int thresholdValue)` Thresholds the ColorImage object by a specific value.

Methods inherited from class comp102x.CanvasObject
getCanvas, getHeight, getRotation, getScale, getWidth, getX, getY, runRotateAnimation, runScaleAnimation, setCanvas, setMovable, setRotation, setScale, setX, setY

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

- Constructor Detail
  - ColorImage
```
public ColorImage()
```
    Constructs a ColorImage object by loading an image from the file system and re-scales it to fit the default canvas size.
  - ColorImage
```
public ColorImage(boolean rescale)
```
    Constructs a ColorImage object by loading an image from the file system and re-scales it to fit the default canvas size if indicated.
    
    Parameters:
    
    rescale - Flag indicating whether to re-scale the image or not.
  - ColorImage
```
public ColorImage(java.lang.String filename)
```
    Constructs a ColorImage object by using a filename and re-scales it to fit the default canvas size.
    
    Parameters:
    
    filename - The filename of the image.
  - ColorImage
```
public ColorImage(java.lang.String filename,
                  boolean rescale)
```
    Constructs a ColorImage object by using a filename and re-scales it to fit the default canvas size if indicated.
    
    Parameters:
    
    filename - The filename of the image.
    
    rescale - Flag indicating whether to re-scale the image or not.
  - ColorImage
```
public ColorImage(int width,
                  int height)
```
    Constructs a blank white ColorImage object with a specify width and height.
    
    Parameters:
    
    width - The width of the ColorImage object to be constructed.
    
    height - The height of the ColorImage object to be constructed.
  - ColorImage
```
public ColorImage(ColorImage copy)
```
    Constructs a copy of the given ColorImage object.
    
    Parameters:
    
    copy - The ColorImage object to be copied from.
- Method Detail
  - getRed
```
public int getRed(int x,
                  int y)
```
    Gets the value of red channel of a pixel.
    
    Parameters:
    
    x - The x position of the pixel.
    
    y - The y position of the pixel.
    
    Returns:
    
    The value of the red channel [0 - 255].
  - setRed
```
public void setRed(int x,
                   int y,
                   int value)
```
    Sets the value of red channel of a pixel.
    
    Parameters:
    
    x - The x position of the pixel.
    
    y - The y position of the pixel.
    
    value - The value of the red channel to be set to.
  - getGreen
```
public int getGreen(int x,
                    int y)
```
    Gets the value of green channel of a pixel.
    
    Parameters:
    
    x - The x position of the pixel.
    
    y - The y position of the pixel.
    
    Returns:
    
    The value of the green channel [0 - 255].
  - setGreen
```
public void setGreen(int x,
                     int y,
                     int value)
```
    Sets the value of green channel of a pixel.
    
    Parameters:
    
    x - The x position of the pixel.
    
    y - The y position of the pixel.
    
    value - The value of the green channel to be set to.
  - getBlue
```
public int getBlue(int x,
                   int y)
```
    Gets the value of blue channel of a pixel.
    
    Parameters:
    
    x - The x position of the pixel.
    
    y - The y position of the pixel.
    
    Returns:
    
    The value of the blue channel [0 - 255].
  - setBlue
```
public void setBlue(int x,
                    int y,
                    int value)
```
    Sets the value of blue channel of a pixel.
    
    Parameters:
    
    x - The x position of the pixel.
    
    y - The y position of the pixel.
    
    value - The value of the blue channel to be set to.
  - getRGB
```
public int[] getRGB(int x,
                    int y)
```
    Gets the RGB values of a pixel.
    
    Parameters:
    
    x - The x position of the pixel.
    
    y - The y position of the pixel.
    
    Returns:
    
    The RGB values of the blue channel [0 - 255] in an integer array.
  - setRGB
```
public void setRGB(int x,
                   int y,
                   int r,
                   int g,
                   int b)
```
    Sets the RGB values of a pixel.
    
    Parameters:
    
    x - The x position of the pixel.
    
    y - The y position of the pixel.
    
    r - The value of the red channel to be set to.
    
    g - The value of the green channel to be set to.
    
    b - The value of the blue channel to be set to.
  - getAlpha
```
public int getAlpha(int x,
                    int y)
```
    Gets the value of alpha channel of a pixel.
    
    Parameters:
    
    x - The x position of the pixel.
    
    y - The y position of the pixel.
    
    Returns:
    
    The value of the alpha channel [0 - 255].
  - setAlpha
```
public void setAlpha(int x,
                     int y,
                     int a)
```
    Sets the value of alpha channel of a pixel.
    
    Parameters:
    
    x - The x position of the pixel.
    
    y - The y position of the pixel.
    
    a - value The value of the alpha channel to be set to.
  - increaseRed
```
public void increaseRed(int value)
```
    Increases the value of red channel for all pixels.
    
    Parameters:
    
    value - The value to be increased in the red channel.
  - decreaseRed
```
public void decreaseRed(int value)
```
    Decreases the value of red channel for all pixels.
    
    Parameters:
    
    value - The value to be decreased in the red channel.
  - increaseGreen
```
public void increaseGreen(int value)
```
    Increases the value of green channel for all pixels.
    
    Parameters:
    
    value - The value to be increased in the green channel.
  - decreaseGreen
```
public void decreaseGreen(int value)
```
    Decreases the value of green channel for all pixels.
    
    Parameters:
    
    value - The value to be decreased in the green channel.
  - increaseBlue
```
public void increaseBlue(int value)
```
    Increases the value of blue channel for all pixels.
    
    Parameters:
    
    value - The value to be increased in the blue channel.
  - decreaseBlue
```
public void decreaseBlue(int value)
```
    Decreases the value of blue channel for all pixels.
    
    Parameters:
    
    value - The value to be decreased in the blue channel.
  - add
```
public ColorImage add(ColorImage operand)
```
    Adds another ColorImage object to this ColorImage object.
    
    Parameters:
    
    operand - The color image to add.
    
    Returns:
    
    A new ColorImage object representing the addition result.
  - add
```
public void add(int value)
```
    Adds a value to all the RGB channels of this ColorImage object.
    
    Parameters:
    
    value - The value to add.
  - subtract
```
public ColorImage subtract(ColorImage operand)
```
    Subtracts another ColorImage object to this ColorImage object.
    
    Parameters:
    
    operand - The color image to subtract.
    
    Returns:
    
    A new ColorImage object representing the subtraction result.
  - subtract
```
public void subtract(int value)
```
    Subtracts a value from all the RGB channels of this ColorImage object.
    
    Parameters:
    
    value - The value to subtract.
  - multiply
```
public ColorImage multiply(ColorImage operand)
```
    Multiplies another ColorImage object to this ColorImage object. The other ColorImage object is used as an intensity mask i.e. newPixel.value = pixelOfThisImage.value * pixelOfAnotherImage.value / 255.0.
    
    Parameters:
    
    operand - The color image to multiply.
    
    Returns:
    
    A new ColorImage object representing the multiplication result.
  - multiply
```
public void multiply(int value)
```
    Multiplies a value to all the RGB channels of this ColorImage object. The value is first normalized by value = value / 255.0.
    
    Parameters:
    
    value - The value to multiply.
  - divide
```
public ColorImage divide(ColorImage operand)
```
    Divides another ColorImage object to this ColorImage object. The division result is then multiplied by 255.0 to give the final value i.e. newPixel.value = pixelOfThisImage.value / pixelOfAnotherImage .value * 255.0.
    
    Parameters:
    
    operand - The ColorImage to divide.
    
    Returns:
    
    A new ColorImage object representing the division result.
  - divide
```
public void divide(int value)
```
    Divides all the RGB channels of this ColorImage object by a value. The division result is then multiplied by 255.0 to give the final value i.e. newPixel.value = pixelOfThisImage.value / givenValue * 255.0.
    
    Parameters:
    
    value - The value to divide.
  - convolve
```
public void convolve(float[][] kernel)
```
    Convolves the ColorImage object with a specified kernel.
    
    Parameters:
    
    kernel - The kernel of the convolution as a 2D float matrix.
  - threshold
```
public void threshold(int thresholdValue)
```
    Thresholds the ColorImage object by a specific value. Set the channel to 255 if the original value is greater than the threshold value, otherwise 0.
    
    Parameters:
    
    thresholdValue - The threshold value.
  - invert
```
public void invert()
```
    Inverts the ColorImage object by color.
  - averageDifference
```
public double averageDifference(ColorImage operand)
```
    Gets the average difference between this ColorImage object and the other ColorImage object.
    
    Parameters:
    
    operand - The other color image object.
    
    Returns:
    
    The average difference between the color image objects, 0.0 = no difference.
  - match
```
public int match(ColorImage target,
                 boolean drawSquare)
```
    Counts the number appearance of a sub image inside this image.
    
    Parameters:
    
    target - The sub image.
    
    drawSquare - A flag to specify if squares will be drawn in the current image to identify the found sub images.
    
    Returns:
    
    The number of appearance of the sub image.
  - drawRectangle
```
public void drawRectangle(int x,
                          int y,
                          int width,
                          int height)
```
    Draws a rectangle on this ColorImage object.
    
    Parameters:
    
    x - The x position of the rectangle.
    
    y - The y position of the rectangle.
    
    width - The width of the rectangle.
    
    height - The height of the rectangle.
  - drawRectangle
```
public void drawRectangle(int x,
                          int y,
                          int width,
                          int height,
                          int red,
                          int green,
                          int blue)
```
    Draws a rectangle on this ColorImage object with a specific color.
    
    Parameters:
    
    x - The x position of the rectangle.
    
    y - The y position of the rectangle.
    
    width - The width of the rectangle.
    
    height - The height of the rectangle.
    
    red - The value of the red channel of the color.
    
    green - The value of the green channel of the color.
    
    blue - The value of the blue channel of the color.
  - drawOval
```
public void drawOval(int x,
                     int y,
                     int width,
                     int height)
```
    Draws an oval on this ColorImage object
    
    Parameters:
    
    x - The x position of the oval.
    
    y - The y position of the oval.
    
    width - The width of the oval.
    
    height - The height of the oval.
  - drawOval
```
public void drawOval(int x,
                     int y,
                     int width,
                     int height,
                     int red,
                     int green,
                     int blue)
```
    Draws an oval on this ColorImage object with a specific color.
    
    Parameters:
    
    x - The x position of the oval.
    
    y - The y position of the oval.
    
    width - The width of the oval.
    
    height - The height of the oval.
    
    red - The value of the red channel of the color.
    
    green - The value of the green channel of the color.
    
    blue - The value of the blue channel of the color.
  - drawImage
```
public void drawImage(ColorImage overImage,
                      int x,
                      int y)
```
    Overlays another ColorImage object on top of the current one.
    
    Parameters:
    
    overImage - The overlaying color image object.
    
    x - The x position of the overlaying image.
    
    y - The y position of the overlaying image.
  - getGraphics2D
```
public java.awt.Graphics2D getGraphics2D()
```
    Gets the graphics object of this ColorImage, which can be used for some graphics operations, e.g. drawing shapes.
    
    Returns:
    
    The graphics object
  - createRedImage
```
public ColorImage createRedImage()
```
    Creates a copy of this ColorImage object with the green and blue channel removed.
    
    Returns:
    
    A copy of this image with only red channel retained.
  - createCyanImage
```
public ColorImage createCyanImage()
```
    Creates a copy of this ColorImage object with the red channel removed.
    
    Returns:
    
    A copy of this image with green and blue channel retained.
  - fillWithRandomNoise
```
public void fillWithRandomNoise(int percentage,
                                int dotSize)
```
    Fills this ColorImage object with random pepper and salt noise.
    
    Parameters:
    
    percentage - The percentage of white (salt) noise.
    
    dotSize - the size of the noise dots.
  - save
```
public void save()
```
    Saves the color image to a .png image file.
  - add
```
public static ColorImage add(ColorImage image1,
                             ColorImage image2)
```
    Adds two ColorImage objects together.
    
    Parameters:
    
    image1 - The first ColorImage object to add.
    
    image2 - The second ColorImage object to add.
    
    Returns:
    
    A new ColorImage object representing the addition result.
  - subtract
```
public static ColorImage subtract(ColorImage image1,
                                  ColorImage image2)
```
    Subtracts a ColorImage object from another ColorImage object.
    
    Parameters:
    
    image1 - The ColorImage object to subtract from.
    
    image2 - The ColorImage object to subtract.
    
    Returns:
    
    A new ColorImage object representing the subtraction result.
  - multiply
```
public static ColorImage multiply(ColorImage image1,
                                  ColorImage image2)
```
    Multiplies two ColorImage objects together.
    
    Parameters:
    
    image1 - The first ColorImage object to multiply.
    
    image2 - The second ColorImage object to multiply.
    
    Returns:
    
    A new ColorImage representing the multiplication result.
  - divide
```
public static ColorImage divide(ColorImage image1,
                                ColorImage image2)
```
    Divides a ColorImage object object by another ColorImage object.
    
    Parameters:
    
    image1 - The ColorImage object to be divided.
    
    image2 - The ColorImage object to divide.
    
    Returns:
    
    A new ColorImage object representing the division result.

Class ColorImage

Constructor Summary

Method Summary

Methods inherited from class comp102x.CanvasObject

Methods inherited from class java.lang.Object

Constructor Detail

ColorImage

ColorImage

ColorImage

ColorImage

ColorImage

ColorImage

Method Detail

getRed

setRed

getGreen

setGreen

getBlue

setBlue

getRGB

setRGB

getAlpha

setAlpha

increaseRed

decreaseRed

increaseGreen

decreaseGreen

increaseBlue

decreaseBlue

add

add

subtract

subtract

multiply

multiply

divide

divide

convolve

threshold

invert

averageDifference

match

drawRectangle

drawRectangle

drawOval

drawOval

drawImage

getGraphics2D

createRedImage

createCyanImage

fillWithRandomNoise

save

add

subtract

multiply

divide