Foxit PDF SDK
com.foxit.sdk.addon.ocr.OCRConfig类 参考

Public 成员函数

 OCRConfig ()
 构造函数。
 
 OCRConfig (boolean is_detect_pictures, boolean is_remove_noise, boolean is_correct_skew, boolean is_enable_text_extraction_mode, boolean is_sequentially_process, boolean is_auto_overwrite_resolution, int resolution_to_overwrite, int confidence)
 带参数的构造函数。 更多...
 
synchronized void delete ()
 直接清除C++相关资源。 更多...
 
int getConfidence ()
 Get 用于判断识别文本是否可靠的置信度阈值。 更多...
 
boolean getIs_auto_overwrite_resolution ()
 Get 决定是否自动设置分辨率。 更多...
 
boolean getIs_correct_skew ()
 Get 决定是否启用偏斜校正。true 表示启用偏斜校正。 false 表示不启用偏斜校正。 默认值:true更多...
 
boolean getIs_detect_pictures ()
 Get 决定是否检测图片。true 表示在分析过程中将检测图片。 false 表示不检测图片,PDF文档图像上的图片内容可能被解释为文本。 如果您只想从图像中提取文本,可以将此选项设置为 false。 默认值:true更多...
 
boolean getIs_enable_text_extraction_mode ()
 Get 决定是否启用文本提取模式。 更多...
 
boolean getIs_remove_noise ()
 Get 决定是否去除PDF图像的噪声。如果PDF图像包含一些噪声,比如随机的黑点或斑点,这可能很有用。 如果图像上字母的线条很细,应将此选项设置为 false,否则会影响文本的识别。 true 表示图像中的噪声在OCR过程中不会被识别。噪声不会被识别为文本。 false 表示不阻止噪声。 默认值:true更多...
 
boolean getIs_sequentially_process ()
 Get 决定OCR引擎是否在一个进程上顺序处理页面。 更多...
 
int getResolution_to_overwrite ()
 Get 用于覆盖 PDF 文档图像分辨率的分辨率值(DPI)。 更多...
 
void set (boolean is_detect_pictures, boolean is_remove_noise, boolean is_correct_skew, boolean is_enable_text_extraction_mode, boolean is_sequentially_process, boolean is_auto_overwrite_resolution, int resolution_to_overwrite, int confidence)
 设置值。 更多...
 
void setConfidence (int value)
 Set 用于判断识别文本是否可靠的置信度阈值。 更多...
 
void setIs_auto_overwrite_resolution (boolean value)
 Set 决定是否自动设置分辨率。 更多...
 
void setIs_correct_skew (boolean value)
 Set 决定是否启用偏斜校正。true 表示启用偏斜校正。 false 表示不启用偏斜校正。 默认值:true更多...
 
void setIs_detect_pictures (boolean value)
 Set 决定是否检测图片。true 表示在分析过程中将检测图片。 false 表示不检测图片,PDF文档图像上的图片内容可能被解释为文本。 如果您只想从图像中提取文本,可以将此选项设置为 false。 默认值:true更多...
 
void setIs_enable_text_extraction_mode (boolean value)
 Set 决定是否启用文本提取模式。 更多...
 
void setIs_remove_noise (boolean value)
 Set 决定是否去除PDF图像的噪声。如果PDF图像包含一些噪声,比如随机的黑点或斑点,这可能很有用。 如果图像上字母的线条很细,应将此选项设置为 false,否则会影响文本的识别。 true 表示图像中的噪声在OCR过程中不会被识别。噪声不会被识别为文本。 false 表示不阻止噪声。 默认值:true更多...
 
void setIs_sequentially_process (boolean value)
 Set 决定OCR引擎是否在一个进程上顺序处理页面。 更多...
 
void setResolution_to_overwrite (int value)
 Set 用于覆盖 PDF 文档图像分辨率的分辨率值(DPI)。 更多...
 

详细描述

此类表示用于OCR的配置。

构造及析构函数说明

◆ OCRConfig()

com.foxit.sdk.addon.ocr.OCRConfig.OCRConfig ( boolean  is_detect_pictures,
boolean  is_remove_noise,
boolean  is_correct_skew,
boolean  is_enable_text_extraction_mode,
boolean  is_sequentially_process,
boolean  is_auto_overwrite_resolution,
int  resolution_to_overwrite,
int  confidence 
)

带参数的构造函数。

参数
[in]is_detect_pictures决定是否检测图片。
[in]is_remove_noise决定是否去除PDF图像的噪声。
[in]is_correct_skew决定是否启用偏斜校正。
[in]is_enable_text_extraction_mode决定是否启用文本提取模式。
[in]is_sequentially_process决定OCR引擎是否在一个进程上顺序处理页面。
[in]is_auto_overwrite_resolution决定是否自动覆盖(重写)分辨率。
[in]resolution_to_overwrite要覆盖(重写)的分辨率。 这个参数只有当 is_auto_overwrite_resolution 设置为 false 有效。
[in]confidence用于判断识别文本是否可靠的置信度阈值。值范围从0到100。

成员函数说明

◆ delete()

synchronized void com.foxit.sdk.addon.ocr.OCRConfig.delete ( )

直接清除C++相关资源。

返回
无。
注解
一旦这个接口被调用,这个对象将不能再被使用。

◆ getConfidence()

com.foxit.sdk.addon.ocr.OCRConfig.getConfidence ( )

Get 用于判断识别文本是否可靠的置信度阈值。

取值范围为 [0, 100]。数值越大,对识别结果的置信度要求越高。 例如,如果该值设置为 30,则置信度低于 30 的识别文本将被视为不可靠文本,并会被移除。 默认值: 0。

返回
用于判断识别文本是否可靠的置信度阈值。

◆ getIs_auto_overwrite_resolution()

com.foxit.sdk.addon.ocr.OCRConfig.getIs_auto_overwrite_resolution ( )

Get 决定是否自动设置分辨率。

true 表示 OCR 引擎会自动检测并覆盖图像分辨率。 false 表示通过参数 resolution_to_overwrite 手动设置分辨率。

返回
决定是否自动设置分辨率。

◆ getIs_correct_skew()

com.foxit.sdk.addon.ocr.OCRConfig.getIs_correct_skew ( )

Get 决定是否启用偏斜校正。true 表示启用偏斜校正。 false 表示不启用偏斜校正。 默认值:true

注解
偏斜校正只能针对不超过20度的角度进行校正。
返回
决定是否启用偏斜校正。true 表示启用偏斜校正。 false 表示不启用偏斜校正。 默认值:true

◆ getIs_detect_pictures()

com.foxit.sdk.addon.ocr.OCRConfig.getIs_detect_pictures ( )

Get 决定是否检测图片。true 表示在分析过程中将检测图片。 false 表示不检测图片,PDF文档图像上的图片内容可能被解释为文本。 如果您只想从图像中提取文本,可以将此选项设置为 false。 默认值:true

返回
决定是否检测图片。true 表示在分析过程中将检测图片。 false 表示不检测图片,PDF文档图像上的图片内容可能被解释为文本。 如果您只想从图像中提取文本,可以将此选项设置为 false。 默认值:true

◆ getIs_enable_text_extraction_mode()

com.foxit.sdk.addon.ocr.OCRConfig.getIs_enable_text_extraction_mode ( )

Get 决定是否启用文本提取模式。

通常,当某些文本部分没有被发现为文本块(如图片上的文本或手写文本)时, 建议将此参数设置为 true。 如果图片的完整文本被正确识别,或者样本包含可能被认为和识别为文本的图像或图案, 建议将此参数设置为 false。 简而言之,此参数使引擎能够识别所有远程接近字母的内容为文本。 true 表示启用文本提取模式,而 false 表示不启用文本提取模式。 默认值:false

返回
决定是否启用文本提取模式。

◆ getIs_remove_noise()

com.foxit.sdk.addon.ocr.OCRConfig.getIs_remove_noise ( )

Get 决定是否去除PDF图像的噪声。如果PDF图像包含一些噪声,比如随机的黑点或斑点,这可能很有用。 如果图像上字母的线条很细,应将此选项设置为 false,否则会影响文本的识别。 true 表示图像中的噪声在OCR过程中不会被识别。噪声不会被识别为文本。 false 表示不阻止噪声。 默认值:true

返回
决定是否去除PDF图像的噪声。如果PDF图像包含一些噪声,比如随机的黑点或斑点,这可能很有用。 如果图像上字母的线条很细,应将此选项设置为 false,否则会影响文本的识别。 true 表示图像中的噪声在OCR过程中不会被识别。噪声不会被识别为文本。 false 表示不阻止噪声。 默认值:true

◆ getIs_sequentially_process()

com.foxit.sdk.addon.ocr.OCRConfig.getIs_sequentially_process ( )

Get 决定OCR引擎是否在一个进程上顺序处理页面。

此参数仅在OCR转换中使用。true 表示OCR引擎将在一个进程上顺序处理页面, 转换时间将增加。
false 表示OCR引擎将自动检测进程数。如果只处理一个页面或系统中只有一个处理器, 则使用一个进程。否则,使用并行处理。
默认值:false

返回
决定OCR引擎是否在一个进程上顺序处理页面。

◆ getResolution_to_overwrite()

com.foxit.sdk.addon.ocr.OCRConfig.getResolution_to_overwrite ( )

Get 用于覆盖 PDF 文档图像分辨率的分辨率值(DPI)。

该参数仅在 is_auto_overwrite_resolution 设置为 false 时有效。 默认值: 300。

返回
用于覆盖 PDF 文档图像分辨率的分辨率值(DPI)。

◆ set()

void com.foxit.sdk.addon.ocr.OCRConfig.set ( boolean  is_detect_pictures,
boolean  is_remove_noise,
boolean  is_correct_skew,
boolean  is_enable_text_extraction_mode,
boolean  is_sequentially_process,
boolean  is_auto_overwrite_resolution,
int  resolution_to_overwrite,
int  confidence 
)

设置值。

参数
[in]is_detect_pictures决定是否检测图片。
[in]is_remove_noise决定是否去除PDF图像的噪声。
[in]is_correct_skew决定是否启用偏斜校正。
[in]is_enable_text_extraction_mode决定是否启用文本提取模式。
[in]is_sequentially_process决定OCR引擎是否在一个进程上顺序处理页面。
[in]is_auto_overwrite_resolution决定是否自动覆盖(重写)分辨率。
[in]resolution_to_overwrite要覆盖(重写)的分辨率。 这个参数只有当 is_auto_overwrite_resolution 设置为 false 有效。
[in]confidence用于判断识别文本是否可靠的置信度阈值。值范围从0到100。
返回
无返回值。

◆ setConfidence()

com.foxit.sdk.addon.ocr.OCRConfig.setConfidence ( int  value)

Set 用于判断识别文本是否可靠的置信度阈值。

取值范围为 [0, 100]。数值越大,对识别结果的置信度要求越高。 例如,如果该值设置为 30,则置信度低于 30 的识别文本将被视为不可靠文本,并会被移除。 默认值: 0。

参数
[in]value用于判断识别文本是否可靠的置信度阈值。
返回
None.

◆ setIs_auto_overwrite_resolution()

com.foxit.sdk.addon.ocr.OCRConfig.setIs_auto_overwrite_resolution ( boolean  value)

Set 决定是否自动设置分辨率。

true 表示 OCR 引擎会自动检测并覆盖图像分辨率。 false 表示通过参数 resolution_to_overwrite 手动设置分辨率。

参数
[in]value决定是否自动设置分辨率。
返回
None.

◆ setIs_correct_skew()

com.foxit.sdk.addon.ocr.OCRConfig.setIs_correct_skew ( boolean  value)

Set 决定是否启用偏斜校正。true 表示启用偏斜校正。 false 表示不启用偏斜校正。 默认值:true

注解
偏斜校正只能针对不超过20度的角度进行校正。
参数
[in]value决定是否启用偏斜校正。true 表示启用偏斜校正。 false 表示不启用偏斜校正。 默认值:true
返回
None.

◆ setIs_detect_pictures()

com.foxit.sdk.addon.ocr.OCRConfig.setIs_detect_pictures ( boolean  value)

Set 决定是否检测图片。true 表示在分析过程中将检测图片。 false 表示不检测图片,PDF文档图像上的图片内容可能被解释为文本。 如果您只想从图像中提取文本,可以将此选项设置为 false。 默认值:true

参数
[in]value决定是否检测图片。true 表示在分析过程中将检测图片。 false 表示不检测图片,PDF文档图像上的图片内容可能被解释为文本。 如果您只想从图像中提取文本,可以将此选项设置为 false。 默认值:true
返回
None.

◆ setIs_enable_text_extraction_mode()

com.foxit.sdk.addon.ocr.OCRConfig.setIs_enable_text_extraction_mode ( boolean  value)

Set 决定是否启用文本提取模式。

通常,当某些文本部分没有被发现为文本块(如图片上的文本或手写文本)时, 建议将此参数设置为 true。 如果图片的完整文本被正确识别,或者样本包含可能被认为和识别为文本的图像或图案, 建议将此参数设置为 false。 简而言之,此参数使引擎能够识别所有远程接近字母的内容为文本。 true 表示启用文本提取模式,而 false 表示不启用文本提取模式。 默认值:false

参数
[in]value决定是否启用文本提取模式。
返回
None.

◆ setIs_remove_noise()

com.foxit.sdk.addon.ocr.OCRConfig.setIs_remove_noise ( boolean  value)

Set 决定是否去除PDF图像的噪声。如果PDF图像包含一些噪声,比如随机的黑点或斑点,这可能很有用。 如果图像上字母的线条很细,应将此选项设置为 false,否则会影响文本的识别。 true 表示图像中的噪声在OCR过程中不会被识别。噪声不会被识别为文本。 false 表示不阻止噪声。 默认值:true

参数
[in]value决定是否去除PDF图像的噪声。如果PDF图像包含一些噪声,比如随机的黑点或斑点,这可能很有用。 如果图像上字母的线条很细,应将此选项设置为 false,否则会影响文本的识别。 true 表示图像中的噪声在OCR过程中不会被识别。噪声不会被识别为文本。 false 表示不阻止噪声。 默认值:true
返回
None.

◆ setIs_sequentially_process()

com.foxit.sdk.addon.ocr.OCRConfig.setIs_sequentially_process ( boolean  value)

Set 决定OCR引擎是否在一个进程上顺序处理页面。

此参数仅在OCR转换中使用。true 表示OCR引擎将在一个进程上顺序处理页面, 转换时间将增加。
false 表示OCR引擎将自动检测进程数。如果只处理一个页面或系统中只有一个处理器, 则使用一个进程。否则,使用并行处理。
默认值:false

参数
[in]value决定OCR引擎是否在一个进程上顺序处理页面。
返回
None.

◆ setResolution_to_overwrite()

com.foxit.sdk.addon.ocr.OCRConfig.setResolution_to_overwrite ( int  value)

Set 用于覆盖 PDF 文档图像分辨率的分辨率值(DPI)。

该参数仅在 is_auto_overwrite_resolution 设置为 false 时有效。 默认值: 300。

参数
[in]value用于覆盖 PDF 文档图像分辨率的分辨率值(DPI)。
返回
None.