View Javadoc

1   /**
2    * Copyright (c) 2011, The University of Southampton and the individual contributors.
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without modification,
6    * are permitted provided that the following conditions are met:
7    *
8    *   * 	Redistributions of source code must retain the above copyright notice,
9    * 	this list of conditions and the following disclaimer.
10   *
11   *   *	Redistributions in binary form must reproduce the above copyright notice,
12   * 	this list of conditions and the following disclaimer in the documentation
13   * 	and/or other materials provided with the distribution.
14   *
15   *   *	Neither the name of the University of Southampton nor the names of its
16   * 	contributors may be used to endorse or promote products derived from this
17   * 	software without specific prior written permission.
18   *
19   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20   * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21   * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
23   * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26   * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28   * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29   */
30  package org.openimaj.image.feature;
31  
32  import org.openimaj.feature.FeatureExtractor;
33  import org.openimaj.feature.FloatFV;
34  import org.openimaj.image.FImage;
35  import org.openimaj.util.array.ArrayUtils;
36  
37  /**
38   * Transform a {@link FloatFV} into an {@link FImage}.
39   * Note: this makes a copy of the data 
40   * 
41   * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
42   *
43   */
44  public class FloatFV2FImage implements FeatureExtractor<FImage, FloatFV> {
45  	/**
46  	 * the image width
47  	 */
48  	public int width;
49  	
50  	/**
51  	 * the image height 
52  	 */
53  	public int height;
54  	
55  	/**
56  	 * Construct the converter with the given image size
57  	 * @param width
58  	 * @param height
59  	 */
60  	public FloatFV2FImage(int width, int height) {
61  		this.width = width;
62  		this.height = height;
63  	}
64  	
65  	@Override
66  	public FImage extractFeature(FloatFV object) {
67  		return new FImage(ArrayUtils.reshape(object.values, width, height));
68  	}
69  
70  	/**
71  	 * Transform a {@link FloatFV} into an {@link FImage}.
72  	 * Note: this makes a copy of the data.
73  	 *  
74  	 * @param fv the feature vector
75  	 * @param width the image width
76  	 * @param height the image height
77  	 * @return the image
78  	 */
79  	public static FImage extractFeature(FloatFV fv, int width, int height) {
80  		return new FImage(ArrayUtils.reshape(fv.values, width, height));
81  	}
82  }