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.experiment.dataset.cluster;
031
032import java.io.BufferedReader;
033import java.io.File;
034import java.io.FileInputStream;
035import java.io.IOException;
036import java.io.InputStream;
037import java.io.InputStreamReader;
038
039import org.openimaj.data.dataset.ListBackedDataset;
040import org.openimaj.data.dataset.MapBackedDataset;
041
042/**
043 * Reads datasets of items and cluster labels from the clustereval tool:
044 * http://chris.de-vries.id.au/2013/06/clustereval-10-release.html
045 * 
046 * The general format of clustereval is:
047 * item cluster_label*
048 * 
049 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
050 *
051 */
052public class ClusterEvalDataset extends MapBackedDataset<String, ListBackedDataset<Integer>, Integer> {
053        
054        /**
055         * Read from this file location
056         * @param loc
057         * @throws IOException
058         */
059        public ClusterEvalDataset(String loc) throws IOException {
060                this(new File(loc));
061        }
062        /**
063         * Load this file as a dataset
064         * @param f
065         * @throws IOException 
066         */
067        public ClusterEvalDataset(File f) throws IOException {
068                this(new FileInputStream(f));
069        }
070
071        /**
072         * Read the clusters from this stream
073         * @param is
074         * @throws IOException 
075         */
076        public ClusterEvalDataset(InputStream is) throws IOException {
077                BufferedReader reader = new BufferedReader(new InputStreamReader(is));
078                String line = null;
079                while((line = reader.readLine())!=null){
080                        String[] itemclusterparts = line.split(" ");
081                        int item = Integer.parseInt(itemclusterparts[0]);
082                        for (int i = 1; i < itemclusterparts.length; i++) {
083                                String clusterLabel = itemclusterparts[i];
084                                ListBackedDataset<Integer> list = this.get(clusterLabel);
085                                if(list == null){
086                                        this.put(clusterLabel, list = new ListBackedDataset<Integer>());
087                                }
088                                list.add(item);
089                        }
090                }
091        }
092        /**
093         * @return the dataset as clusters
094         */
095        public int[][] toClusters() {
096                int[][] clusters = new int[this.size()][];
097                int i = 0;
098                for (Entry<String, ListBackedDataset<Integer>> is : this.entrySet()) {
099                        clusters[i] = new int[is.getValue().size()];
100                        int j = 0;
101                        for (int js : is.getValue()) {
102                                clusters[i][j++] = js;
103                        }
104                        i++;
105                }
106                return clusters;
107        }
108}