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.objectdetection;
031
032import Jama.Matrix;
033
034/**
035 * An object detection with an associated transform that maps the detection
036 * shape to the image. Typically this is used by {@link ObjectDetector}s that
037 * perform some form of pre-processing transform on the image (for example to
038 * simulate rotations or affine warps in order to increase invariance). In these
039 * cases, the transformation held by the {@link TransformedDetection} would be
040 * the <b>inverse</b> of the pre-process transform.
041 * 
042 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
043 * 
044 * @param <DETECTED_OBJECT>
045 *            Type of detected object
046 */
047public class TransformedDetection<DETECTED_OBJECT> {
048        /**
049         * The transform to be applied to the detected object to map it to the image
050         * in which the detection was made.
051         */
052        public Matrix transform;
053
054        /**
055         * The object that was detected
056         */
057        public DETECTED_OBJECT detected;
058
059        /**
060         * Construct a new {@link TransformedDetection} with the given detected
061         * object and transform.
062         * 
063         * @param detected
064         *            the detected object
065         * @param transform
066         *            the transform
067         */
068        public TransformedDetection(DETECTED_OBJECT detected, Matrix transform) {
069                this.detected = detected;
070                this.transform = transform;
071        }
072}