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.video;
031
032import org.openimaj.image.Image;
033import org.openimaj.math.geometry.shape.Rectangle;
034import org.openimaj.video.timecode.VideoTimecode;
035
036/**
037 * A {@link VideoFrame} with a subwindow defined
038 * 
039 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
040 * 
041 * @param <T>
042 */
043public class VideoSubFrame<T extends Image<?, T>> extends VideoFrame<T> {
044        /**
045         * The region of interest defining the sub-window.
046         */
047        public Rectangle roi;
048        private VideoFrame<T> cachedSubFrame;
049
050        /**
051         * Constructor
052         * 
053         * @param frame
054         *            The frame
055         * @param timecode
056         *            The timecode
057         * @param rectangle
058         *            The subwindow into the frame
059         */
060        public VideoSubFrame(T frame, VideoTimecode timecode, Rectangle rectangle) {
061                super(frame, timecode);
062                this.roi = rectangle;
063        }
064
065        /**
066         * @return the subframe as a {@link VideoFrame}
067         */
068        public VideoFrame<T> extract() {
069                if (cachedSubFrame == null) {
070                        cachedSubFrame = new VideoFrame<T>(frame.extractROI(roi), timecode);
071                }
072                return cachedSubFrame;
073        }
074}