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.pixel.statistics;
031
032import java.io.Serializable;
033
034import org.openimaj.image.FImage;
035import org.openimaj.image.MBFImage;
036
037
038/**
039 * Abstract base class for models based on pixel statistics of an image.
040 * 
041 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
042 */
043public abstract class AbstractPixelStatisticsModel implements Cloneable, Serializable {
044        private static final long serialVersionUID = 1L;
045        
046        protected int ndims;
047        
048        /**
049         * Construct the model with the given number of dimensions
050         * @param ndims number of dimensions
051         */
052        public AbstractPixelStatisticsModel(int ndims) {
053                this.ndims = ndims;
054        }
055        
056        /**
057         * Estimate the model parameters from the given image(s).
058         * @param images list of images
059         */
060        public abstract void estimateModel(MBFImage... images);
061        
062        /**
063         * Estimate the model parameters from the given image(s). Internally
064         * this method constructs 1-band MBFImages.
065         * 
066         * @see #estimateModel(MBFImage[])
067         * @param images images list of images
068         */
069        public void estimateModel(FImage... images) {
070                MBFImage[] imgs = new MBFImage[images.length];
071                for (int i=0; i<images.length; i++)
072                        imgs[i] = new MBFImage(images[i]);
073                
074                estimateModel(imgs);
075        }
076}