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.feature.local.matcher.quantised;
031
032import gnu.trove.map.hash.TIntObjectHashMap;
033
034import java.util.ArrayList;
035import java.util.List;
036
037import org.openimaj.feature.local.quantised.QuantisedLocalFeature;
038import org.openimaj.feature.local.matcher.LocalFeatureMatcher;
039import org.openimaj.util.pair.Pair;
040
041
042/**
043 * Simple matcher for quantised features. Features match if they
044 * have the same id.
045 *  
046 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
047 * @param <T> 
048 *
049 */
050public class BasicQuantisedKeypointMatcher<T extends QuantisedLocalFeature<?>> implements LocalFeatureMatcher<T> {
051        protected TIntObjectHashMap<List<T>> modelKeypoints;
052        protected List <Pair<T>> matches;
053        protected boolean allowMultiple;
054        
055        /**
056         * Match quantised keypoints
057         * @param allowMultiple
058         */
059        public BasicQuantisedKeypointMatcher(boolean allowMultiple)
060        {
061                this.allowMultiple = allowMultiple;
062        }
063        
064        @Override
065        public List<Pair<T>> getMatches() {
066                return matches;
067        }
068        
069        @Override
070        public boolean findMatches(List<T> keys1)
071        {
072                matches = new ArrayList<Pair<T>>();
073                
074            for (T k : keys1) {
075                if (modelKeypoints.contains(k.id)) {
076                        if (allowMultiple || modelKeypoints.get(k.id).size() == 1) {
077                                for (T match : modelKeypoints.get(k.id)) {
078                                        matches.add(new Pair<T>(k, match));
079                                }
080                        }
081                }
082            }
083            
084            return true;
085        }
086
087        @Override
088        public void setModelFeatures(List<T> modelkeys) {
089                modelKeypoints = new TIntObjectHashMap<List<T>>();
090                for (T k : modelkeys) {
091                        if (!modelKeypoints.contains(k.id))
092                                modelKeypoints.put(k.id, new ArrayList<T>());
093                        modelKeypoints.get(k.id).add(k);
094                }
095        }
096}