org.sleuthkit.autopsy.textextractors.configs.ImageConfig Class Reference

Public Member Functions
boolean	getOCREnabled ()
List< String >	getOCRLanguages ()
ProcessTerminator	getOCRTimeoutTerminator ()
void	setOCREnabled (boolean enabled)
void	setOCRLanguages (List< String > languages)

Private Attributes
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.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 56 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 78 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 87 of file ImageConfig.java.

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

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

enabled

Flag indicating if OCR is enabled.

Definition at line 47 of file ImageConfig.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.getExtractor(), 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

languages

List of languages to use

Definition at line 67 of file ImageConfig.java.

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

Member Data Documentation

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

Definition at line 37 of file ImageConfig.java.

Referenced by org.sleuthkit.autopsy.textextractors.configs.ImageConfig.getOCREnabled().

List<String> org.sleuthkit.autopsy.textextractors.configs.ImageConfig.ocrLanguages = null

private

Definition at line 38 of file ImageConfig.java.

Referenced by org.sleuthkit.autopsy.textextractors.configs.ImageConfig.getOCRLanguages().

final TimedProcessTerminator org.sleuthkit.autopsy.textextractors.configs.ImageConfig.ocrTimedTerminator = new TimedProcessTerminator(OCR_TIMEOUT_SECONDS)

private

Definition at line 39 of file ImageConfig.java.

Referenced by org.sleuthkit.autopsy.textextractors.configs.ImageConfig.getOCRTimeoutTerminator().

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/textextractors/configs/ImageConfig.java