tess_pipeline_word_box(
    pipe::TessPipeline,
    filename::AbstractString
)::Bool

Generate a BOX file from the pipeline and save it to the specified file. Returns false if there is a problem adding the BOX generator to the output.

Arguments:

Details:

If the file exists it will be overwritten.

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)

tess_pipeline_word_box(pipeline, "My Book.box")

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 readlines("My Book.box")[1:10]
    println(line)
end

# output

WordStr 11 577 417 591 0 #No one would have believed in the last years of the
   418 577 422 591 0
WordStr 11 557 457 571 0 #the nineteenth century that this world was being watched
   458 557 462 571 0
WordStr 10 537 457 551 0 #watched keenly and closely by intelligences greater than
   458 537 462 551 0
WordStr 11 517 481 531 0 #than man’s and yet as mortal as his own; that as men busied
   482 517 486 531 0
WordStr 11 497 457 511 0 #busied themselves about their various concerns they were
   458 497 462 511 0

See also: tess_run_pipeline, tess_pipeline_unlv, tess_pipeline_lstm_box

tess_pipeline_word_box(
    pipe::TessPipeline
)::Union{TessOutput{String}, Nothing}

Generate a BOX file from the pipeline and save it to a string. Returns nothing if there is a problem adding the BOX generator to the output.

Arguments:

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_word_box(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

WordStr 11 577 417 591 0 #No one would have believed in the last years of the
   418 577 422 591 0
WordStr 11 557 457 571 0 #the nineteenth century that this world was being watched
   458 557 462 571 0
WordStr 10 537 457 551 0 #watched keenly and closely by intelligences greater than
   458 537 462 551 0
WordStr 11 517 481 531 0 #than man’s and yet as mortal as his own; that as men busied
   482 517 486 531 0
WordStr 11 497 457 511 0 #busied themselves about their various concerns they were
   458 497 462 511 0

See also: tess_run_pipeline, tess_pipeline_unlv, tess_pipeline_lstm_box

tess_pipeline_word_box(
    func::Function,
    pipe::TessPipeline
)::Bool

Generate a BOX file from the pipeline and pass it back to the client via a callback. Returns false if there is a problem adding the BOX generator to the output.

Arguments:

Details:

The text will be passed to the caller one line at a time. The "\n" line terminator will be included with the text.

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)

count = 0
tess_pipeline_word_box(pipeline) do line
    global count
    if count < 10
        print(line)
    end
    count += 1
end

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

# output

WordStr 11 577 417 591 0 #No one would have believed in the last years of the
   418 577 422 591 0
WordStr 11 557 457 571 0 #the nineteenth century that this world was being watched
   458 557 462 571 0
WordStr 10 537 457 551 0 #watched keenly and closely by intelligences greater than
   458 537 462 551 0
WordStr 11 517 481 531 0 #than man’s and yet as mortal as his own; that as men busied
   482 517 486 531 0
WordStr 11 497 457 511 0 #busied themselves about their various concerns they were
   458 497 462 511 0
true

See also: tess_run_pipeline, tess_pipeline_unlv, tess_pipeline_lstm_box