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.feature.local.detector.ipd.collector; 031 032import org.openimaj.feature.local.list.LocalFeatureList; 033import org.openimaj.feature.local.list.MemoryLocalFeatureList; 034import org.openimaj.image.FImage; 035import org.openimaj.image.feature.local.detector.ipd.extractor.InterestPointGradientFeatureExtractor; 036import org.openimaj.image.feature.local.interest.InterestPointData; 037import org.openimaj.image.feature.local.keypoints.InterestPointKeypoint; 038 039/** 040 * An interest point feature collector can be used to hold interest points found in an image. 041 * Interest point collectors decide what area of the image is considered "interesting" pass this 042 * information on to their designated extractor. 043 * 044 * @author Sina Samangooei (ss@ecs.soton.ac.uk) 045 * @param <T> The type of {@link InterestPointData} 046 */ 047public abstract class InterestPointFeatureCollector<T extends InterestPointData> { 048 049 protected MemoryLocalFeatureList<InterestPointKeypoint<T>> features; 050 protected InterestPointGradientFeatureExtractor extractor; 051 052 /** 053 * Initialise the collector with a memory local feature list types on {@link InterestPointKeypoint} 054 * @param extractor when interest points are found and prepared, inform this extractor 055 */ 056 public InterestPointFeatureCollector(InterestPointGradientFeatureExtractor extractor){ 057 this.features = new MemoryLocalFeatureList<InterestPointKeypoint<T>>(); 058 this.extractor = extractor; 059 } 060 061 /** 062 * @return the features collected 063 */ 064 public LocalFeatureList<InterestPointKeypoint<T>> getFeatures() { 065 return this.features; 066 } 067 068 /** 069 * Collect interest points from a single image 070 * @param image 071 * @param point 072 */ 073 public abstract void foundInterestPoint(FImage image,T point); 074 075 /** 076 * Collect interest points from an image known to be in a pyramid with a given octave size 077 * @param image 078 * @param point 079 * @param octaveSize 080 */ 081 public abstract void foundInterestPoint(FImage image,T point, double octaveSize); 082}