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 */
030/**
031 * 
032 */
033package org.openimaj.video.analyser;
034
035import org.openimaj.image.Image;
036import org.openimaj.image.analyser.ImageAnalyser;
037import org.openimaj.video.Video;
038import org.openimaj.video.processor.VideoProcessor;
039
040/**
041 *      This class is analagous to the {@link ImageAnalyser} class for analysing
042 *      image. It should be used to make analysis and measurements on video frames
043 *      without altering the frames themselves.
044 *      <p>
045 *      This class overrides {@link VideoProcessor} to inherit many of its
046 *      abilities (chainability etc.) but the processFrame method will always
047 *      return the input frame having called analyseFrame. The analyseFrame method
048 *      should not alter the input frame. 
049 *
050 *      @author David Dupplaw (dpd@ecs.soton.ac.uk)
051 *  @created 1 Mar 2012
052 *      
053 *      @param <T> The type of the video frame to be analysed 
054 */
055public abstract class VideoAnalyser<T extends Image<?,T>> 
056        extends VideoProcessor<T>
057{
058        /**
059         *      Construct a stand-alone video analyser.
060         */
061        public VideoAnalyser()
062        {
063        }
064        
065        /**
066         *      Construct a chainable video analyser.
067         *      @param v The video to chain to
068         */
069        public VideoAnalyser( Video<T> v )
070        {
071                super( v );
072        }
073        
074        /**
075         *      Analyse the given frame and make no changes to the frame.
076         *      @param frame The video frame to analyse
077         */
078        public abstract void analyseFrame( T frame );
079        
080        /**
081         *      This method will return the input frame after calling 
082         *      {@link #analyseFrame(Image)} on the input image.
083         * 
084         *      @see org.openimaj.video.processor.VideoProcessor#processFrame(org.openimaj.image.Image)
085         */
086        @Override
087        final public T processFrame( T frame )
088        {
089                analyseFrame( frame );
090                return frame;
091        }
092}