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.analysis.pyramid;
031
032import org.openimaj.image.FImage;
033import org.openimaj.image.Image;
034import org.openimaj.image.processor.SinglebandImageProcessor;
035
036/**
037 * Basic options for constructing a pyramid
038 * 
039 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
040 * 
041 * @param <OCTAVE> type of underlying octave
042 * @param <IMAGE> type of underlying image.
043 */
044public class PyramidOptions<
045        OCTAVE extends Octave<?,?,IMAGE>, 
046        IMAGE extends Image<?,IMAGE> & SinglebandImageProcessor.Processable<Float,FImage,IMAGE>> 
047{
048        /**
049         * Should the Pyramid hold onto its octaves?
050         */
051        protected boolean keepOctaves = false;
052        
053        /**
054         * An OctaveProcessor to apply to each octave of the pyramid. 
055         */
056        protected OctaveProcessor<OCTAVE,IMAGE> octaveProcessor;
057        
058        /**
059         * PyramidProcessor for processing the pyramid after construction.
060         * Setting a PyramidProcessor will cause the Pyramid to hold onto
061         * its entire set of octaves.
062         */
063        protected PyramidProcessor<IMAGE> pyramidProcessor = null;
064        
065        /**
066         * Get an OctaveProcessor to apply to each octave of the pyramid or null
067         * if none is set.
068         * 
069         * @return the octaveProcessor or null
070         */
071        public OctaveProcessor<OCTAVE,IMAGE> getOctaveProcessor() {
072                return octaveProcessor;
073        }
074
075        /**
076         * Gets the currently set PyramidProcessor or null if none is set.
077         * 
078         * PyramidProcessors process the pyramid after construction.
079         * Setting a PyramidProcessor will cause the Pyramid to hold onto
080         * its entire set of octaves.
081         * 
082         * @return the pyramidProcessor or null
083         */
084        public PyramidProcessor<IMAGE> getPyramidProcessor() {
085                return pyramidProcessor;
086        }
087
088        /**
089         * Determine whether the Pyramid should retain its octaves. 
090         * Value is overridden if a PyramidProcessor is set.
091         * @return the keepOctaves
092         */
093        public boolean isKeepOctaves() {
094                return keepOctaves;
095        }
096
097        /**
098         * Set whether the Pyramid should retain its octaves. 
099         * Default value is false, but is overridden if a PyramidProcessor
100         * is set.
101         * 
102         * @param keepOctaves the keepOctaves to set
103         */
104        public void setKeepOctaves(boolean keepOctaves) {
105                this.keepOctaves = keepOctaves;
106        }
107
108        /**
109         * Get an OctaveProcessor to apply to each octave of the pyramid. 
110         * Setting the OctaveProcessor to null disables it.
111         * 
112         * @param octaveProcessor the octaveProcessor to set
113         */
114        public void setOctaveProcessor(OctaveProcessor<OCTAVE,IMAGE> octaveProcessor) {
115                this.octaveProcessor = octaveProcessor;
116        }
117
118        /**
119         * Sets the PyramidProcessor.
120         * 
121         * PyramidProcessors for process the pyramid after construction.
122         * Setting a PyramidProcessor will cause the Pyramid to hold onto
123         * its entire set of octaves.
124         * 
125         * Setting the PyramidProcessor to null disables it.
126         * 
127         * @param pyramidProcessor the pyramidProcessor to set
128         */
129        public void setPyramidProcessor(PyramidProcessor<IMAGE> pyramidProcessor) {
130                this.pyramidProcessor = pyramidProcessor;
131        }
132}