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.tools.globalfeature.type;
031
032import java.util.List;
033
034import org.openimaj.feature.FeatureVector;
035import org.openimaj.feature.FloatFV;
036import org.openimaj.image.FImage;
037import org.openimaj.image.MBFImage;
038import org.openimaj.image.colour.ColourSpace;
039import org.openimaj.tools.globalfeature.GlobalFeatureType;
040import org.openimaj.util.array.ArrayUtils;
041
042/**
043 * Using a pixel histogram (see {@link GlobalFeatureType#HISTOGRAM}) find the
044 * maximum bin. This can be interpreted as the image's dominant colour.
045 *
046 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
047 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk),
048 *
049 */
050public class MaxHistogramExtractor extends HistogramExtractor {
051        MaxHistogramExtractor(ColourSpace rgb, List<Integer> asList) {
052                this.converter = rgb;
053                this.bins = asList;
054        }
055
056        /**
057         * Default constructor
058         */
059        public MaxHistogramExtractor() {
060
061        }
062
063        @Override
064        public FeatureVector extract(MBFImage image, FImage mask) {
065                final FeatureVector fv = super.extract(image, mask);
066                final double[] vals = fv.asDoubleVector();
067                final int index = ArrayUtils.maxIndex(vals);
068                return new FloatFV(hm.colourAverage(index));
069        }
070}