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.pixel.statistics;
31  
32  import java.io.Serializable;
33  
34  import org.openimaj.image.FImage;
35  import org.openimaj.image.MBFImage;
36  
37  
38  /**
39   * Abstract base class for models based on pixel statistics of an image.
40   * 
41   * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
42   */
43  public abstract class AbstractPixelStatisticsModel implements Cloneable, Serializable {
44  	private static final long serialVersionUID = 1L;
45  	
46  	protected int ndims;
47  	
48  	/**
49  	 * Construct the model with the given number of dimensions
50  	 * @param ndims number of dimensions
51  	 */
52  	public AbstractPixelStatisticsModel(int ndims) {
53  		this.ndims = ndims;
54  	}
55  	
56  	/**
57  	 * Estimate the model parameters from the given image(s).
58  	 * @param images list of images
59  	 */
60  	public abstract void estimateModel(MBFImage... images);
61  	
62  	/**
63  	 * Estimate the model parameters from the given image(s). Internally
64  	 * this method constructs 1-band MBFImages.
65  	 * 
66  	 * @see #estimateModel(MBFImage[])
67  	 * @param images images list of images
68  	 */
69  	public void estimateModel(FImage... images) {
70  		MBFImage[] imgs = new MBFImage[images.length];
71  		for (int i=0; i<images.length; i++)
72  			imgs[i] = new MBFImage(images[i]);
73  		
74  		estimateModel(imgs);
75  	}
76  }