Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
README updated
  • Loading branch information
rccarrasco committed Dec 6, 2013
1 parent c107500 commit 0c2d8e5
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Instructions on how to use ocrevalUAtion can be found in the [wiki](https://gith

The classes defined are listed below:

[distance.Aligner] (https://github.com/impactcentre/ocrevalUAtion/blob/master/src/main/java/eu/digitisation/distance/Aligner.java)<br>
[distance.Aligner](https://github.com/impactcentre/ocrevalUAtion/blob/master/src/main/java/eu/digitisation/distance/Aligner.java)<br>
Shows the best alignment between two texts (output in HTML format)

[distance.ArrayEditDistance<Type>](https://github.com/impactcentre/ocrevalUAtion/blob/master/src/main/java/eu/digitisation/distance/ArrayEditDistance.java)<br>
Expand All @@ -33,13 +33,22 @@ operating on strings (currently, Levenshtein, Damerau-Levenshtein, and indel).
[distance.TextFileEncoder](https://github.com/impactcentre/ocrevalUAtion/blob/master/src/main/java/eu/digitisation/distance/TextFileEncoder.java)<br>
Encode a text file as an array of Integers (one code per word).

[gui.InputFileSelector](https://github.com/impactcentre/ocrevalUAtion/blob/master/src/main/java/eu/digitisation/gui/InputFileSelector.java)<br>
Graphical interface to select input files with both drag and drop or menu selection.

[gui.OutputFileSelector](https://github.com/impactcentre/ocrevalUAtion/blob/master/src/main/java/eu/digitisation/gui/OutputFileSelector.java)<br>
File chooser with confirmation dialog to avoid accidental overwrites.

[image.Bimage](https://github.com/impactcentre/ocrevalUAtion/blob/master/src/main/java/eu/digitisation/image/Bimage.java)<br>
Extends BufferedImage with some useful operations

[io.CharFilter](https://github.com/impactcentre/ocrevalUAtion/blob/master/src/main/java/eu/digitisation/io/CharFilter.java)<br>
Transform text according to a mapping between (source, target)
Unicode character sequences.

[io.Encoding](https://github.com/impactcentre/ocrevalUAtion/blob/master/src/main/java/eu/digitisation/io/Encoding.java)<br>
Detect the encoding of a text file.

[io.StringNormalizer](https://github.com/impactcentre/ocrevalUAtion/blob/master/src/main/java/eu/digitisation/io/StringNormalizer.java)<br>
Normalizes strings: collapse whitespace and use composed form (see java.text.Normalizer.Form)

Expand Down Expand Up @@ -72,8 +81,11 @@ objects and integers which can be incremented and decremented.
[math.Pair](https://github.com/impactcentre/ocrevalUAtion/blob/master/src/main/java/eu/digitisation/math/Pair.java)<br>
A pair of objects.

[ocr.ErrorMeasure](https://github.com/impactcentre/ocrevalUAtion/blob/master/src/main/java/eu/digitisation/ocr/ErrorMeasure.java)<br>
The main class which computes character and word error rates.
[ocrevaluation.ErrorMeasure](https://github.com/impactcentre/ocrevalUAtion/blob/master/src/main/java/eu/digitisation/ocrevaluation/ErrorMeasure.java)<br>
Computes character and word error rates.

[ocrevaluation.Report](https://github.com/impactcentre/ocrevalUAtion/blob/master/src/main/java/eu/digitisation/ocrevaluation/ErrorMeasure.java)<br>
Create a report in HTML format.

[Page.Geometry](https://github.com/impactcentre/ocrevalUAtion/blob/master/src/main/java/eu/digitisation/Page/Geometry.java)<br>
Geometry information contained in one PAGE-XML file.
Expand Down

0 comments on commit 0c2d8e5

Please sign in to comment.