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;
031
032import org.openimaj.feature.DoubleFV;
033import org.openimaj.feature.FeatureExtractor;
034import org.openimaj.image.FImage;
035import org.openimaj.util.array.ArrayUtils;
036
037/**
038 * Transform a {@link DoubleFV} into an {@link FImage}. Note: this makes a copy
039 * of the data
040 * 
041 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
042 * 
043 */
044public class DoubleFV2FImage implements FeatureExtractor<FImage, DoubleFV> {
045        /**
046         * the image width
047         */
048        public int width;
049
050        /**
051         * the image height
052         */
053        public int height;
054
055        /**
056         * Construct the converter with the given image size
057         * 
058         * @param width
059         * @param height
060         */
061        public DoubleFV2FImage(int width, int height) {
062                this.width = width;
063                this.height = height;
064        }
065
066        @Override
067        public FImage extractFeature(DoubleFV object) {
068                return new FImage(ArrayUtils.reshapeFloat(object.values, width, height));
069        }
070
071        /**
072         * Transform a {@link DoubleFV} into an {@link FImage}. Note: this makes a
073         * copy of the data.
074         * 
075         * @param fv
076         *            the feature vector
077         * @param width
078         *            the image width
079         * @param height
080         *            the image height
081         * @return the image
082         */
083        public static FImage extractFeature(DoubleFV fv, int width, int height) {
084                return new FImage(ArrayUtils.reshapeFloat(fv.values, width, height));
085        }
086}