1 /**
2 * Copyright (c) 2011, The University of Southampton and the individual contributors.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
7 *
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 *
11 * * Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * * Neither the name of the University of Southampton nor the names of its
16 * contributors may be used to endorse or promote products derived from this
17 * software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 package org.openimaj.image.analysis.pyramid;
31
32 import java.util.Iterator;
33
34 import org.openimaj.image.FImage;
35 import org.openimaj.image.Image;
36 import org.openimaj.image.processor.SinglebandImageProcessor;
37 import org.openimaj.util.array.ArrayIterator;
38
39 /**
40 * An octave is an interval in scale space, typically corresponding to a
41 * doubling of sigma. Octaves contain a stack of one or more images,
42 * with each image typically at a higher scale than the previous.
43 *
44 * Octaves are Iterable for easy access to each of the images in turn.
45 *
46 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
47 *
48 * @param <OPTIONS> Type of options object
49 * @param <PYRAMID> Type of parent pyramid
50 * @param <IMAGE> Type of underlying image
51 */
52 public abstract class Octave<
53 OPTIONS extends PyramidOptions<?, IMAGE>,
54 PYRAMID extends Pyramid<OPTIONS,?,IMAGE>,
55 IMAGE extends Image<?,IMAGE> & SinglebandImageProcessor.Processable<Float,FImage,IMAGE>>
56 implements
57 Iterable<IMAGE>
58 {
59 /** The options used for the pyramid construction */
60 public OPTIONS options;
61
62 /** The images that make up this Octave */
63 public IMAGE [] images;
64
65 /** The pyramid that contains this Octave */
66 public PYRAMID parentPyramid;
67
68 /** The size of the octave relative to the original image. */
69 public float octaveSize;
70
71 /**
72 * Construct a Gaussian octave with the provided parent Pyramid
73 * and octaveSize. The octaveSize parameter is the size of
74 * the octave's images compared to the original image used
75 * to construct the pyramid. An octaveSize of 1 means the
76 * same size as the original, 2 means half size, 4 means
77 * quarter size, etc.
78 *
79 * @param parent the pyramid that this octave belongs to
80 * @param octaveSize the size of the octave relative to
81 * the original image.
82 */
83 public Octave(PYRAMID parent, float octaveSize) {
84 parentPyramid = parent;
85 if (parent != null) this.options = parent.options;
86 this.octaveSize = octaveSize;
87 }
88
89 /**
90 * Populate the octave, starting from the provided image.
91 * @param image the image.
92 */
93 public abstract void process(IMAGE image);
94
95 /**
96 * Get the image that starts the next octave.
97 * Usually this is the image that has twice the sigma
98 * of the image used to initialise this octave.
99 *
100 * @return image image to start next octave.
101 */
102 public abstract IMAGE getNextOctaveImage();
103
104 /* (non-Javadoc)
105 * @see java.lang.Iterable#iterator()
106 */
107 @Override
108 public Iterator<IMAGE> iterator() {
109 return new ArrayIterator<IMAGE>(images);
110 }
111 }