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.model.landmark;
31
32 import org.openimaj.image.Image;
33
34
35 /**
36 * {@link LandmarkModelFactory}s are used to construct pre-configured
37 * {@link LandmarkModel}s on demand.
38 *
39 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
40 *
41 * @param <I>
42 */
43 public interface LandmarkModelFactory<I extends Image<?, I>> {
44 /**
45 * Create a new pre-configured {@link LandmarkModel}.
46 * @return new {@link LandmarkModel}
47 */
48 public LandmarkModel<I> createLandmarkModel();
49
50 /**
51 * Create a new pre-configured {@link LandmarkModel}.
52 * The scaleFactor parameter is used to reduce/increase the
53 * relative size of the search area of the LandmarkModel.
54 * @param scaleFactor the scaleFactor
55 * @return new {@link LandmarkModel}
56 */
57 public LandmarkModel<I> createLandmarkModel(float scaleFactor);
58 }