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