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.tools.faces.recognition;
031
032import java.io.File;
033import java.io.IOException;
034import java.util.ArrayList;
035import java.util.Collections;
036import java.util.List;
037
038import org.kohsuke.args4j.CmdLineException;
039import org.kohsuke.args4j.CmdLineParser;
040import org.kohsuke.args4j.Option;
041import org.openimaj.image.processing.face.detection.DetectedFace;
042import org.openimaj.image.processing.face.recognition.FaceRecognitionEngine;
043
044/**
045 * A tool for printing out information about face recognisers.
046 * 
047 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
048 * 
049 */
050public class FaceRecognitionInfoTool {
051        @Option(name = "-f", aliases = "--file", usage = "Recogniser file", required = true)
052        File recogniserFile;
053
054        /**
055         * The main method of the tool.
056         * 
057         * @param <T>
058         *            Type of DetectedFace
059         * 
060         * @param args
061         * @throws IOException
062         */
063        public static <T extends DetectedFace> void main(String[] args) throws IOException {
064                final FaceRecognitionInfoTool options = new FaceRecognitionInfoTool();
065                final CmdLineParser parser = new CmdLineParser(options);
066
067                try {
068                        parser.parseArgument(args);
069                } catch (final CmdLineException e) {
070                        System.err.println(e.getMessage());
071                        System.err.println("java FaceRecognitionInfoTool [options...]");
072                        parser.printUsage(System.err);
073                        return;
074                }
075
076                final FaceRecognitionEngine<T, String> engine = options.getEngine();
077
078                System.out.println("Detector:\n" + engine.getDetector());
079                System.out.println();
080                System.out.println("Recogniser:\n" + engine.getRecogniser());
081
082                System.out.println();
083
084                final List<String> people = new ArrayList<String>(engine.getRecogniser().listPeople());
085                Collections.sort(people);
086                System.out.println("The recogniser has been trained on " + people.size() + " distinct people:");
087                System.out.println(people);
088        }
089
090        <FACE extends DetectedFace> FaceRecognitionEngine<FACE, String> getEngine() throws IOException
091        {
092                return FaceRecognitionEngine.load(recogniserFile);
093        }
094}