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 /**
31 *
32 */
33 package org.openimaj.image.text.ocr;
34
35 import java.util.Map;
36
37 import org.openimaj.image.Image;
38 import org.openimaj.image.analyser.ImageAnalyser;
39 import org.openimaj.image.processor.ImageProcessor;
40 import org.openimaj.math.geometry.shape.Rectangle;
41
42 /**
43 * Top-level class for classes that are able to process images to extract
44 * textual content by performing OCR.
45 *
46 * @author David Dupplaw (dpd@ecs.soton.ac.uk)
47 * @created 4 Aug 2011
48 *
49 * @param <T>
50 * The type of {@link ImageProcessor}
51 */
52 public abstract class OCRProcessor<T extends Image<?, T>>
53 implements ImageAnalyser<T>
54 {
55 /**
56 * After processing, this method should return a set of bounding boxes of
57 * regions within the image mapped to a String that contains the recognised
58 * text. If the OCR processor cannot extract regions (it just reads whatever
59 * image it's given), then the map can be singular with the rectangular
60 * bounding box the same as the image bounding box.
61 *
62 * @return A map of rectangle to string
63 */
64 public abstract Map<Rectangle, String> getText();
65 }