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.ArrayList;
033import java.util.List;
034
035import org.kohsuke.args4j.Argument;
036import org.kohsuke.args4j.Option;
037import org.openimaj.feature.FeatureVector;
038import org.openimaj.image.FImage;
039import org.openimaj.image.MBFImage;
040import org.openimaj.image.colour.ColourSpace;
041import org.openimaj.image.pixel.statistics.HistogramModel;
042import org.openimaj.image.pixel.statistics.MaskingHistogramModel;
043import org.openimaj.tools.globalfeature.GlobalFeatureExtractor;
044
045/**
046 * Create a global colour histogram and output a feature
047 * 
048 * @author Sina Samangooei (ss@ecs.soton.ac.uk) 
049 *
050 */
051public class HistogramExtractor extends GlobalFeatureExtractor {
052        @Option(name="--color-space", aliases="-c", usage="Specify colorspace model", required=true)
053        ColourSpace converter;
054        
055        @Argument(required=true, usage="Number of bins per dimension")
056        List<Integer> bins = new ArrayList<Integer>();
057        
058        /**
059         * The histogram model 
060         */
061        public HistogramModel hm;
062        
063        @Override
064        public FeatureVector extract(MBFImage image, FImage mask) {
065                MBFImage converted = converter.convert(image);
066                
067                if (converted.numBands() != bins.size()) {
068                        throw new RuntimeException("Incorrect number of dimensions - recieved " + bins.size() +", expected " + converted.numBands() +".");
069                }
070                
071                int [] ibins = new int[bins.size()];
072                for (int i=0; i<bins.size(); i++)
073                        ibins[i] = bins.get(i);
074                
075                hm = null; 
076                if (mask == null)
077                        hm = new HistogramModel(ibins);
078                else 
079                        hm = new MaskingHistogramModel(mask, ibins);
080                
081                hm.estimateModel(converted);
082                return hm.histogram;
083        }
084}