001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.image.pixel;
031
032
033/**
034 *      Represents a pixel location. This is basically the same
035 *      as java.awt.Point except we can control exactly what goes
036 *      in here to optimise for memory usage.
037 *
038 *  @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
039 *  
040 *      
041 */
042public class IntValuePixel extends ValuePixel<Integer>
043{
044        /** The value of the pixel */
045        public int value = 0;
046        
047        /**
048         *      Default constructor
049         *      @param x X-location of the pixel
050         *      @param y Y-location of the pixel
051         */
052        public IntValuePixel( int x, int y ) { super(x, y); }
053        
054        /**
055         *      Constructor that takes the location and value of the
056         *      pixel.
057         *      @param x X-location of the pixel
058         *      @param y Y-location of the pixel
059         *      @param v value of the pixel
060         */
061        public IntValuePixel( int x, int y, int v ) { super(x, y); this.value = v; }
062        
063        /**
064         *      {@inheritDoc}
065         *      @see java.lang.Object#toString()
066         */
067        @Override
068        public String toString() { return "{"+x+","+y+","+value+"}"; }
069
070        @Override
071        public Integer getValue() {
072                return value;
073        }
074}
075