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
032import java.util.Comparator;
033
034
035/**
036 *      Represents a pixel location. This is basically the same
037 *      as java.awt.Point except we can control exactly what goes
038 *      in here to optimise for memory usage.
039 *
040 *  @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
041 *  
042 *      
043 */
044public class FValuePixel extends ValuePixel<Float> {
045        /**
046         * {@link Comparator} for comparing {@link FValuePixel}s based on
047         * the natural order of their values.
048         * 
049         * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
050         */
051        public static class ValueComparator implements Comparator<FValuePixel> {
052                /**
053                 * The singleton instance of {@link ValueComparator}
054                 */
055                public final static ValueComparator INSTANCE = new ValueComparator();
056                
057                private ValueComparator() {}
058                
059                @Override
060                public int compare(FValuePixel o1, FValuePixel o2) {
061                        return Float.compare(o1.value, o2.value);
062                }
063        }
064        
065        /**
066         * {@link Comparator} for comparing {@link FValuePixel}s based on
067         * the reversed natural order of their values.
068         * 
069         * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
070         */
071        public static class ReverseValueComparator implements Comparator<FValuePixel> {
072                /**
073                 * The singleton instance of {@link ReverseValueComparator}
074                 */
075                public final static ReverseValueComparator INSTANCE = new ReverseValueComparator();
076                
077                private ReverseValueComparator() {}
078                
079                @Override
080                public int compare(FValuePixel o1, FValuePixel o2) {
081                        return Float.compare(o2.value, o1.value);
082                }
083        }
084        
085        /** The value of the pixel */
086        public float value = 0;
087        
088        /**
089         *      Default constructor
090         *      @param x X-location of the pixel
091         *      @param y Y-location of the pixel
092         */
093        public FValuePixel( int x, int y ) { super(x, y); }
094        
095        /**
096         *      Constructor that takes the location and value of the
097         *      pixel.
098         *      @param x X-location of the pixel
099         *      @param y Y-location of the pixel
100         *      @param v value of the pixel
101         */
102        public FValuePixel( int x, int y, float v ) { super(x, y); this.value = v; }
103        
104        /**
105         *      {@inheritDoc}
106         *      @see java.lang.Object#toString()
107         */
108        @Override
109        public String toString() { return "{"+x+","+y+","+value+"}"; }
110
111        @Override
112        public Float getValue() {
113                return value;
114        }
115}
116