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.data;
031
032import java.util.List;
033import java.util.Map;
034
035import org.openimaj.data.AbstractMultiListDataSource;
036import org.openimaj.data.DataSource;
037import org.openimaj.feature.ArrayFeatureVector;
038import org.openimaj.feature.FeatureVector;
039import org.openimaj.feature.local.LocalFeature;
040import org.openimaj.feature.local.list.LocalFeatureList;
041
042/**
043 * A {@link DataSource} for the feature vector of one or more lists of
044 * {@link LocalFeature}s that use an {@link ArrayFeatureVector} for the feature
045 * vector. This can be used as a convenience when you want to feed multiple
046 * lists of local features to a clustering algorithm.
047 *
048 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
049 *
050 * @param <T>
051 *            The type of {@link LocalFeature}
052 * @param <F>
053 *            The type of {@link FeatureVector}.
054 */
055public class LocalFeatureListDataSource<T extends LocalFeature<?, ? extends ArrayFeatureVector<F>>, F>
056extends
057AbstractMultiListDataSource<F, T>
058{
059        /**
060         * Construct with the given list of data
061         *
062         * @param data
063         *            the data
064         */
065        public LocalFeatureListDataSource(LocalFeatureList<T> data) {
066                super(data);
067        }
068
069        /**
070         * Construct with the given lists of data
071         *
072         * @param data
073         *            the data
074         */
075        @SafeVarargs
076        public LocalFeatureListDataSource(LocalFeatureList<T>... data) {
077                super(data);
078        }
079
080        /**
081         * Construct with the given lists of data
082         *
083         * @param data
084         *            the data
085         */
086        public LocalFeatureListDataSource(List<LocalFeatureList<T>> data) {
087                super(data);
088        }
089
090        /**
091         * Construct with the given map of data. The keys are ignored, and only the
092         * values are used.
093         *
094         * @param data
095         *            the data
096         */
097        public LocalFeatureListDataSource(Map<?, LocalFeatureList<T>> data) {
098                super(data);
099        }
100
101        @Override
102        public int numDimensions() {
103                return ((LocalFeatureList<T>) this.data.get(0)).vecLength();
104        }
105
106        @Override
107        protected F convert(T ele) {
108                return ele.getFeatureVector().values;
109        }
110}