Autopsy  4.18.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.textextractors.configs.ImageConfig Class Reference

Public Member Functions

boolean getLimitedOCREnabled ()
 
boolean getOCREnabled ()
 
List< String > getOCRLanguages ()
 
ProcessTerminator getOCRTimeoutTerminator ()
 
void setLimitedOCREnabled (boolean enabled)
 
void setOCREnabled (boolean enabled)
 
void setOCRLanguages (List< String > languages)
 

Private Attributes

boolean limitedOCREnabled = false
 
boolean OCREnabled = false
 
List< String > ocrLanguages = null
 
final TimedProcessTerminator ocrTimedTerminator = new TimedProcessTerminator(OCR_TIMEOUT_SECONDS)
 

Static Private Attributes

static final int OCR_TIMEOUT_SECONDS = 30 * 60
 

Detailed Description

Allows for configuration of OCR on image files. Extractors that use ImageConfig can be obtained through TextExtractoryFactory.getExtractor().

See also
org.openide.util.Lookup

Definition at line 33 of file ImageConfig.java.

Member Function Documentation

boolean org.sleuthkit.autopsy.textextractors.configs.ImageConfig.getLimitedOCREnabled ( )

Gets the limited OCR flag to indicate if OCR should be limited to larger images and images which were extracted from documents.

Returns
Flag indicating if limited OCR is enabled. True if OCR should be limited, false otherwise..

Definition at line 109 of file ImageConfig.java.

References org.sleuthkit.autopsy.textextractors.configs.ImageConfig.limitedOCREnabled.

boolean org.sleuthkit.autopsy.textextractors.configs.ImageConfig.getOCREnabled ( )

Gets the OCR flag that has been set. By default this flag is turned off.

Returns
Flag indicating if OCR is enabled.

Definition at line 67 of file ImageConfig.java.

References org.sleuthkit.autopsy.textextractors.configs.ImageConfig.OCREnabled.

List<String> org.sleuthkit.autopsy.textextractors.configs.ImageConfig.getOCRLanguages ( )

Gets the list of languages OCR should perform. Can be null.

Returns
Collection of OCR languages

Definition at line 89 of file ImageConfig.java.

References org.sleuthkit.autopsy.textextractors.configs.ImageConfig.ocrLanguages.

ProcessTerminator org.sleuthkit.autopsy.textextractors.configs.ImageConfig.getOCRTimeoutTerminator ( )

Returns a ProcessTerminator for timing out the OCR process.

Returns
ProcessTerminator instance.

Definition at line 98 of file ImageConfig.java.

References org.sleuthkit.autopsy.textextractors.configs.ImageConfig.ocrTimedTerminator.

void org.sleuthkit.autopsy.textextractors.configs.ImageConfig.setLimitedOCREnabled ( boolean  enabled)

Enables the limiting OCR to be run on larger images and images which were extracted from documents.

Parameters
enabledFlag indicating if OCR is enabled.

Definition at line 58 of file ImageConfig.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.extractTextAndIndex().

void org.sleuthkit.autopsy.textextractors.configs.ImageConfig.setOCREnabled ( boolean  enabled)

Enables OCR to be run on the text reader responsible for handling image files.

Parameters
enabledFlag indicating if OCR is enabled.

Definition at line 48 of file ImageConfig.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.extractTextAndIndex(), and org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.ExtractAndTranslateTextTask.getTextExtractor().

void org.sleuthkit.autopsy.textextractors.configs.ImageConfig.setOCRLanguages ( List< String >  languages)

Sets languages for OCR. Can be null.

See PlatformUtil for list of installed language packs.

Parameters
languagesList of languages to use

Definition at line 78 of file ImageConfig.java.

Referenced by org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.ExtractAndTranslateTextTask.getTextExtractor().

Member Data Documentation

boolean org.sleuthkit.autopsy.textextractors.configs.ImageConfig.limitedOCREnabled = false
private
final int org.sleuthkit.autopsy.textextractors.configs.ImageConfig.OCR_TIMEOUT_SECONDS = 30 * 60
staticprivate

Definition at line 35 of file ImageConfig.java.

boolean org.sleuthkit.autopsy.textextractors.configs.ImageConfig.OCREnabled = false
private
List<String> org.sleuthkit.autopsy.textextractors.configs.ImageConfig.ocrLanguages = null
private
final TimedProcessTerminator org.sleuthkit.autopsy.textextractors.configs.ImageConfig.ocrTimedTerminator = new TimedProcessTerminator(OCR_TIMEOUT_SECONDS)
private

The documentation for this class was generated from the following file:

Copyright © 2012-2021 Basis Technology. Generated on: Thu Jul 8 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.