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.video.processing.pixels;
31  
32  import org.openimaj.image.MBFImage;
33  import org.openimaj.video.analyser.VideoAnalyser;
34  import org.openimaj.video.processing.shotdetector.HistogramVideoShotDetector;
35  
36  /**
37   * Compute the mean and variance fields from a video of {@link MBFImage} frames.
38   * The generated fields could be used to analyse which parts of a video are
39   * stationary or change a lot. If your video consists of multiple shots, between
40   * which there are large changes in the content, then it probably makes sense to
41   * segment the video using a {@link HistogramVideoShotDetector} and apply a new
42   * analyser to each shot independently.
43   *
44   * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
45   */
46  public class MBFMeanVarianceField
47  extends
48  VideoAnalyser<MBFImage>
49  {
50  	private MBFImage mean;
51  	private MBFImage m2;
52  	private int n;
53  
54  	@Override
55  	public void analyseFrame(MBFImage frame) {
56  		final int width = frame.getWidth();
57  		final int height = frame.getHeight();
58  		final int nBands = frame.numBands();
59  
60  		if (mean == null || mean.getWidth() != width || mean.getHeight() != height || mean.numBands() != nBands) {
61  			n = 0;
62  			mean = new MBFImage(width, height, nBands);
63  			m2 = new MBFImage(width, height, nBands);
64  		}
65  
66  		for (int b = 0; b < nBands; b++) {
67  			final float[][] mp = mean.getBand(b).pixels;
68  			final float[][] m2p = m2.getBand(b).pixels;
69  			final float[][] fp = frame.getBand(b).pixels;
70  			for (int y = 0; y < height; y++) {
71  				for (int x = 0; x < width; x++) {
72  					final float v = fp[y][x];
73  					final float delta = v - mp[y][x];
74  
75  					n++;
76  					mp[y][x] = mp[y][x] + delta / n;
77  					m2p[y][x] = m2p[y][x] + delta * (v - mp[y][x]);
78  				}
79  			}
80  		}
81  	}
82  
83  	/**
84  	 * Reset the accumulated field data.
85  	 *
86  	 * @see org.openimaj.video.processor.VideoProcessor#reset()
87  	 */
88  	@Override
89  	public void reset() {
90  		this.mean = null;
91  		this.m2 = null;
92  	}
93  
94  	/**
95  	 * Get the mean field of all the frames that have been analysed so far.
96  	 *
97  	 * @return the mean field.
98  	 */
99  	public MBFImage getMean() {
100 		return mean;
101 	}
102 
103 	/**
104 	 * Get the variance field of all the frames that have been analysed so far.
105 	 *
106 	 * @return the variance field.
107 	 */
108 	public MBFImage getVariance() {
109 		if (m2 == null)
110 			return null;
111 
112 		return m2.divide((float) (n - 1));
113 	}
114 }