tess_run_pipeline(
    func::Function,
    pipe::TessPipeline,
    title::AbstractString = ""
)::Bool

Run the pipeline against a series of images.

Arguments:

Details:

This is the primary function of the TessPipeline object. This method is used to combine output from multiple images into a single document (or multiple documents of different types).

The argument passed back to the function is a method with the form:

function add(Pix, Integer)::Bool

The client calls this method with the image and pixels per inch of the image. The image will be processed immediately and added to the pipeline's output.

If you the callback returns false then the tess_run_pipeline() will return false. If it doesn't return a boolean or returns true then tess_run_pipeline() returns true assuming there are no other errors.

This method can only be used "once". After it's called new output needs to be added to the pipeline if you want to reuse the TessPipeline object.

Examples:

using Tesseract

# Generate some pages to load.
write("page01.tiff", sample_tiff())
write("page02.tiff", sample_tiff())
write("page03.tiff", sample_tiff())

download_languages() # Make sure we have the data files.

instance = TessInst()
pipeline = TessPipeline(instance)

book = tess_pipeline_text(pipeline)

tess_run_pipeline(pipeline, "My First Book") do add
    add(pix_read("page01.tiff"), 72)
    add(pix_read("page02.tiff"), 72)
    add(pix_read("page03.tiff"), 72)
end

for line in split(book[], "\n")[1:10]
    println(line)
end

# output

No one would have believed in the last years of the

the nineteenth century that this world was being watched
watched keenly and closely by intelligences greater than
than man’s and yet as mortal as his own; that as men busied
busied themselves about their various concerns they were
were scrutinised and studied, perhaps almost as narrowly as
as a man with a microscope might scrutinise the transient
transient creatures that swarm and multiply in a drop of

See also: TessPipeline, tess_pipeline_text

tess_run_pipeline(
    pipe::TessPipeline,
    filename::AbstractString;
    retryConfig::AbstractString = "",
    timeout::Integer = Int32(0)
)::Bool

Run the pipline against a file that contains the list of images to process or a TIFF file with multiple images. Returns false if the process fails.

Arguments:

Details:

This method provides a simplified version of the tess_run_pipeline function. This uses method exposed by the Tesseract library to process a list of files or a single TIFF file without additional input.

This method can only be used "once". After it's called new output needs to be added to the pipeline if you want to reuse the TessPipeline object.

Examples:

Providing a file with a list of images to process:

using Tesseract
using Suppressor

# Generate some pages to load.
write("page01.tiff", sample_tiff())
write("page02.tiff", sample_tiff())
write("page03.tiff", sample_tiff())

download_languages() # Make sure we have the data files.

instance = TessInst()
pipeline = TessPipeline(instance)

book = tess_pipeline_text(pipeline)

# Create a text file with the files to process.
open("pages.lst", create = true, write = true) do io
    println(io, "page01.tiff")
    println(io, "page02.tiff")
    println(io, "page03.tiff")
end

@suppress tess_run_pipeline(pipeline, "pages.lst")

for line in split(book[], "\n")[1:10]
    println(line)
end

# output

No one would have believed in the last years of the

the nineteenth century that this world was being watched
watched keenly and closely by intelligences greater than
than man’s and yet as mortal as his own; that as men busied
busied themselves about their various concerns they were
were scrutinised and studied, perhaps almost as narrowly as
as a man with a microscope might scrutinise the transient
transient creatures that swarm and multiply in a drop of

Using a multipage TIFF:

using Tesseract
using Suppressor

# Generate some pages to load.
pix_write_tiff("book.tiff", sample_pix())
pix_write_tiff("book.tiff", sample_pix(); append = true)
pix_write_tiff("book.tiff", sample_pix(); append = true)

download_languages() # Make sure we have the data files.

instance = TessInst()
pipeline = TessPipeline(instance)

book = tess_pipeline_text(pipeline)

@suppress tess_run_pipeline(pipeline, "book.tiff")

for line in split(book[], "\n")[1:10]
    println(line)
end

# output

No one would have believed in the last years of the

the nineteenth century that this world was being watched
watched keenly and closely by intelligences greater than
than man’s and yet as mortal as his own; that as men busied
busied themselves about their various concerns they were
were scrutinised and studied, perhaps almost as narrowly as
as a man with a microscope might scrutinise the transient
transient creatures that swarm and multiply in a drop of

See also: TessPipeline, tess_pipeline_text