org.openimaj.image.pixel

Class Pixel

java.lang.Object

org.openimaj.image.pixel.Pixel

All Implemented Interfaces:

Cloneable, Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary, Coordinate, Point2d

Direct Known Subclasses:

ValuePixel

public class Pixel
extends Object
implements Point2d, Cloneable

Represents a pixel within an image, storing its coordinates. Provides helper methods for rounding non-integer values to pixel coordinates.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
int	x The x-coordinate of this pixel
int	y The y-coordinate of this pixel

Constructor Summary

Constructors

Constructor and Description
Pixel() Construct a pixel at the origin
Pixel(int x, int y) Construct a pixel with the given coordinates.

Method Summary

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
byte[]	binaryHeader() Header for binary input.
Pixel	clone()
Pixel	copy() Clone the point
void	copyFrom(Point2d p) Copy the values of the given point into this point.
boolean	equals(Object o)
int	getDimensions()
Integer	getOrdinate(int dimension) Get the ordinate value for a specific dimension.
float	getX()
float	getY()
int	hashCode()
Point2d	minus(Point2d a) Take point point from another point such that return = this - a
void	readASCII(Scanner in) Read internal state from in.
void	readBinary(DataInput in) Read internal state from in.
void	setOrdinate(int dimension, Number value) Set the ordinate value for a specific dimension.
void	setX(float x) Set x coordinate of point
void	setY(float y) Set y coordinate of point
String	toString()
Pixel	transform(Jama.Matrix transform) Transform the point by the given matrix
Pixel	transformInplace(Jama.Matrix transform) Inplace transform the point by the given matrix.
void	translate(float x, float y) Translate the position of the point by the given amounts
void	translate(Point2d v) Translate the position of the point by the given amounts
void	writeASCII(PrintWriter out) Write the content of this as ascii to out.
void	writeBinary(DataOutput out) Write the content of this as binary to out.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

x

public int x

The x-coordinate of this pixel

y

public int y

The y-coordinate of this pixel

Constructor Detail

Pixel

public Pixel(int x,
             int y)

Construct a pixel with the given coordinates.

Parameters:

x - The x-coordinate of the pixel

y - The y-coordinate of the pixel

Pixel

public Pixel()

Construct a pixel at the origin

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

getX

public float getX()

Specified by:

getX in interface Point2d

Returns:

x coordinate of point

See Also:

Point2d.getX()

getY

public float getY()

Specified by:

getY in interface Point2d

Returns:

y coordinate of point

See Also:

Point2d.getY()

setX

public void setX(float x)

Set x coordinate of point

Specified by:

setX in interface Point2d

Parameters:

x - x-coordinate

See Also:

Point2d.setX(float)

setY

public void setY(float y)

Set y coordinate of point

Specified by:

setY in interface Point2d

Parameters:

y - y-coordinate

See Also:

Point2d.setY(float)

clone

public Pixel clone()

Overrides:

clone in class Object

copyFrom

public void copyFrom(Point2d p)

Copy the values of the given point into this point.

Specified by:

copyFrom in interface Point2d

Parameters:

p - The point to copy values from.

See Also:

Point2d.copyFrom(org.openimaj.math.geometry.point.Point2d)

getOrdinate

public Integer getOrdinate(int dimension)

Get the ordinate value for a specific dimension.

Specified by:

getOrdinate in interface Coordinate

Parameters:

dimension - The index of the dimension we are interested in

Returns:

The value of the ordinate of the given dimension.

See Also:

Coordinate.getOrdinate(int)

getDimensions

public int getDimensions()

Specified by:

getDimensions in interface Coordinate

Returns:

The number of dimensions in the coordinate.

See Also:

Coordinate.getDimensions()

translate

public void translate(float x,
                      float y)

Description copied from interface: Point2d

Translate the position of the point by the given amounts

Specified by:

translate in interface Point2d

Parameters:

x - x-amount

y - y-amount

transform

public Pixel transform(Jama.Matrix transform)

Description copied from interface: Point2d

Transform the point by the given matrix

Specified by:

transform in interface Point2d

Returns:

a copy

transformInplace

public Pixel transformInplace(Jama.Matrix transform)

Inplace transform the point by the given matrix.

Parameters:

transform - the transform

Returns:

this

minus

public Point2d minus(Point2d a)

Description copied from interface: Point2d

Take point point from another point such that return = this - a

Specified by:

minus in interface Point2d

Returns:

a new point

readASCII

public void readASCII(Scanner in)
               throws IOException

Description copied from interface: ReadableASCII

Read internal state from in.

Specified by:

readASCII in interface ReadableASCII

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

asciiHeader

public String asciiHeader()

Description copied from interface: ReadableASCII

Header for ascii input. Will be automatically read by IOUtils when using readASCII().

Specified by:

asciiHeader in interface ReadableASCII

Specified by:

asciiHeader in interface WriteableASCII

Returns:

header

readBinary

public void readBinary(DataInput in)
                throws IOException

Description copied from interface: ReadableBinary

Read internal state from in.

Specified by:

readBinary in interface ReadableBinary

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

binaryHeader

public byte[] binaryHeader()

Description copied from interface: ReadableBinary

Header for binary input. Will be automatically read by IOUtils when using readBinary().

Specified by:

binaryHeader in interface ReadableBinary

Specified by:

binaryHeader in interface WriteableBinary

Returns:

header

writeASCII

public void writeASCII(PrintWriter out)
                throws IOException

Description copied from interface: WriteableASCII

Write the content of this as ascii to out.

Specified by:

writeASCII in interface WriteableASCII

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

writeBinary

public void writeBinary(DataOutput out)
                 throws IOException

Description copied from interface: WriteableBinary

Write the content of this as binary to out.

Specified by:

writeBinary in interface WriteableBinary

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

translate

public void translate(Point2d v)

Description copied from interface: Point2d

Translate the position of the point by the given amounts

Specified by:

translate in interface Point2d

Parameters:

v - the vector to translate by

copy

public Pixel copy()

Description copied from interface: Point2d

Clone the point

Specified by:

copy in interface Point2d

Returns:

a copy of the point

setOrdinate

public void setOrdinate(int dimension,
                        Number value)

Description copied from interface: Coordinate

Set the ordinate value for a specific dimension.

Specified by:

setOrdinate in interface Coordinate

Parameters:

dimension - The index of the dimension we are interested in

value - The value of the ordinate of the given dimension.