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.indexing.vlad;
031
032import java.util.ArrayList;
033import java.util.List;
034
035import org.openimaj.data.identity.Identifiable;
036import org.openimaj.image.ImageProvider;
037import org.openimaj.image.MBFImage;
038import org.openimaj.image.indexing.IncrementalIndexer;
039import org.openimaj.image.searching.ImageSearchResult;
040import org.openimaj.image.searching.IncrementalMetaIndex;
041import org.openimaj.knn.pq.IncrementalFloatADCNearestNeighbours;
042import org.openimaj.util.pair.IntFloatPair;
043
044public class VLADIndexer<DATA extends ImageProvider<MBFImage>, METADATA extends Identifiable>
045                implements
046                IncrementalIndexer<DATA, ImageSearchResult<METADATA>, ImageProvider<MBFImage>>
047{
048        private static final int DEFAULT_MAX_RESULTS = 5000;
049
050        private VLADIndexerData indexerData;
051        private IncrementalFloatADCNearestNeighbours nn;
052        private IncrementalMetaIndex<DATA, METADATA> metaStore;
053
054        public VLADIndexer(VLADIndexerData indexerData, IncrementalMetaIndex<DATA, METADATA> metaStore) {
055                this.indexerData = indexerData;
056                this.nn = indexerData.createIncrementalIndex();
057                this.metaStore = metaStore;
058        }
059
060        @Override
061        public void indexImage(DATA image) {
062                final int id = indexerData.index(image.getImage(), nn);
063                metaStore.put(id, image);
064        }
065
066        @Override
067        public List<ImageSearchResult<METADATA>> search(ImageProvider<MBFImage> query) {
068                final List<IntFloatPair> res = nn.searchKNN(indexerData.extractPcaVlad(query.getImage()), DEFAULT_MAX_RESULTS);
069
070                final List<ImageSearchResult<METADATA>> results = new ArrayList<ImageSearchResult<METADATA>>(res.size());
071                for (int i = 0; i < res.size(); i++) {
072                        final IntFloatPair r = res.get(i);
073                        results.add(new ImageSearchResult<METADATA>(metaStore.get(r.first), r.second));
074                }
075
076                return results;
077        }
078}