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;
031
032import java.io.DataInput;
033import java.io.DataOutput;
034import java.io.IOException;
035import java.io.PrintWriter;
036import java.util.Scanner;
037
038import org.openimaj.feature.FeatureVector;
039
040/**
041 * A basic implementation of a {@link LocalFeature} that internally holds
042 * references to a {@link FeatureVector} and {@link Location}.
043 * 
044 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
045 * 
046 * @param <L>
047 *            The type of {@link Location}
048 * @param <F>
049 *            The type of {@link FeatureVector}
050 */
051public class LocalFeatureImpl<L extends Location, F extends FeatureVector> implements LocalFeature<L, F> {
052        /** The {@link Location} of the local feature */
053        public L location;
054
055        /** The {@link FeatureVector} of the local feature */
056        public F feature;
057
058        /**
059         * Construct the LocalFeatureImpl with the given {@link Location} and
060         * {@link FeatureVector}.
061         * 
062         * @param location
063         *            the location
064         * @param feature
065         *            the feature vector
066         */
067        public LocalFeatureImpl(L location, F feature) {
068                this.location = location;
069                this.feature = feature;
070        }
071
072        @Override
073        public void writeBinary(DataOutput out) throws IOException {
074                location.writeBinary(out);
075                feature.writeBinary(out);
076        }
077
078        @Override
079        public void writeASCII(PrintWriter out) throws IOException {
080                location.writeASCII(out);
081                feature.writeASCII(out);
082        }
083
084        @Override
085        public void readBinary(DataInput in) throws IOException {
086                location.readBinary(in);
087                feature.readBinary(in);
088        }
089
090        @Override
091        public void readASCII(Scanner in) throws IOException {
092                location.readASCII(in);
093                feature.readASCII(in);
094        }
095
096        @Override
097        public byte[] binaryHeader() {
098                return ("LFVI" + "." + new String(location.binaryHeader()) + "." + new String(feature.asciiHeader())).getBytes();
099        }
100
101        @Override
102        public String asciiHeader() {
103                return this.getClass().getName() + "." + location.asciiHeader() + "." + feature.asciiHeader();
104        }
105
106        @Override
107        public F getFeatureVector() {
108                return feature;
109        }
110
111        @Override
112        public L getLocation() {
113                return location;
114        }
115}