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.feature.global;
031
032import org.openimaj.citation.annotation.Reference;
033import org.openimaj.citation.annotation.ReferenceType;
034import org.openimaj.feature.DoubleFV;
035import org.openimaj.feature.FeatureVectorProvider;
036import org.openimaj.image.FImage;
037import org.openimaj.image.MBFImage;
038import org.openimaj.image.analyser.ImageAnalyser;
039import org.openimaj.image.mask.AbstractMaskedObject;
040
041/**
042 * Estimate the saturation of an image using the RGB approximation of
043 * avg(max(R,G,B) - min(R,G,B)).
044 * 
045 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
046 */
047@Reference(
048                type = ReferenceType.Inproceedings,
049                author = { "Jose San Pedro", "Stefan Siersdorfer" },
050                title = "Ranking and Classifying Attractiveness of Photos in Folksonomies",
051                year = "2009",
052                booktitle = "18th International World Wide Web Conference",
053                pages = { "771", "", "771" },
054                url = "http://www2009.eprints.org/78/",
055                month = "April")
056public class Saturation extends AbstractMaskedObject<FImage>
057                implements
058                ImageAnalyser<MBFImage>,
059                FeatureVectorProvider<DoubleFV>
060{
061        double saturation;
062
063        @Override
064        public DoubleFV getFeatureVector() {
065                return new DoubleFV(new double[] { saturation });
066        }
067
068        @Override
069        public void analyseImage(MBFImage image) {
070                final FImage R = image.getBand(0);
071                final FImage G = image.getBand(1);
072                final FImage B = image.getBand(2);
073
074                int N = 0;
075                double sat = 0;
076
077                if (mask != null) {
078                        for (int y = 0; y < R.height; y++) {
079                                for (int x = 0; x < R.width; x++) {
080                                        if (mask.pixels[y][x] == 1) {
081                                                final float min = Math.min(Math.min(R.pixels[y][x], G.pixels[y][x]), B.pixels[y][x]);
082                                                final float max = Math.max(Math.max(R.pixels[y][x], G.pixels[y][x]), B.pixels[y][x]);
083                                                sat += (max - min);
084                                                N++;
085                                        }
086                                }
087                        }
088                } else {
089                        for (int y = 0; y < R.height; y++) {
090                                for (int x = 0; x < R.width; x++) {
091                                        final float min = Math.min(Math.min(R.pixels[y][x], G.pixels[y][x]), B.pixels[y][x]);
092                                        final float max = Math.max(Math.max(R.pixels[y][x], G.pixels[y][x]), B.pixels[y][x]);
093                                        sat += (max - min);
094                                        N++;
095                                }
096                        }
097                }
098
099                saturation = sat / N;
100        }
101
102        /**
103         * Get the average saturation of the last image processed with
104         * {@link #analyseImage(MBFImage)}.
105         * 
106         * @return the saturation
107         */
108        public double getSaturation() {
109                return saturation;
110        }
111}