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 org.kohsuke.args4j.Option;
033import org.openimaj.feature.FeatureVector;
034import org.openimaj.image.FImage;
035import org.openimaj.image.MBFImage;
036import org.openimaj.image.feature.global.LuoSimplicity;
037import org.openimaj.tools.globalfeature.GlobalFeatureExtractor;
038
039/**
040 * Luo's simplicity feature
041 * @see LuoSimplicity
042 */
043public class LuoSimplicityExtractor extends GlobalFeatureExtractor {
044        @Option(name="--bins-per-band", aliases="-bpb", required=false, usage="Number of bins to split the R, G and B bands into when constructing the histogram (default 16)")
045        int binsPerBand = 16;
046
047        @Option(name="--gamma", required=false, usage="percentage threshold on the max value of the histogram for counting high-valued bins (default 0.01)")
048        float gamma = 0.01f;
049
050        @Option(name="--alpha", required=false, usage="alpha parameter for determining bounding box size based on the energy ratio (default 0.9)")
051        float alpha = 0.9f;
052
053        @Option(name="--max-kernel-size", required=false, usage="maximum smoothing kernel size (default 50)")
054        int maxKernelSize;
055
056        @Option(name="--kernel-size-step", required=false, usage="step size to increment smoothing kernel by (default 1)")
057        int kernelSizeStep = 1;
058
059        @Option(name="--num-bins", required=false, usage="number of bins for the gradiant histograms (default 41)")
060        int nbins = 41;
061
062        @Option(name="--window-size", required=false, usage="window size for estimating depth of field (default 3)")
063        int windowSize = 3;
064
065        @Override
066        public FeatureVector extract(MBFImage image, FImage mask) {
067                LuoSimplicity cc = new LuoSimplicity(binsPerBand, gamma, alpha, maxKernelSize, kernelSizeStep, nbins, windowSize);
068                image.analyseWith(cc);
069                return cc.getFeatureVector();
070        }
071}