FRPage オブジェクト（IFRPage インターフェイス）

ABBYY FineReader Engine API の FRPage オブジェクト（IFRPage インターフェイス）— FRDocument または Batch Processor（Linux/Windows）の単一ページを表します。ページ レベルの解析、認識、合成、エクスポート、前処理のメソッドに加え、cache dictionary の操作も公開します。

このオブジェクトは、1 ページに対応します。

Linux と Windows では、これはドキュメントのページ、または Batch Processor によって生成されたページのいずれかです。

このオブジェクトは、ページの前処理、解析、認識、ページ合成、およびエクスポートのための一連のメソッドを提供します。このオブジェクトのメソッドは、文書の合成は実行しません (Synthesize メソッドを除く) 。結果をエクスポートする前に、文書の合成を実行するメソッドを明示的に呼び出す必要があります。詳しくは、前処理、解析、認識、および合成のチューニングパラメーターを参照してください。

FRPage オブジェクトは、いわゆる「使用」です。Windows 上の FRE の Visual Basic では、WithEvents として宣言できます。C++ (サポート対象のすべてのオペレーティングシステム) では、これは IConnectionPointContainer インターフェイスをサポートしていることを意味します。処理中に通知イベントを受け取るには、C++ ユーザーは IFRPageEvents インターフェイスから派生したオブジェクトを作成し、次のいずれかを行う必要があります。

• Linux と macOS では、AdviseFREngineObject グローバル関数を呼び出して、そのオブジェクトを FRPage オブジェクトに advise します。
• Windows では、標準的な COM の方法で、そのオブジェクトと FRPage オブジェクトに実装されているイベント ソースとの接続を設定します。

Windows では、FRPage オブジェクトのメソッドは、特別な outgoing インターフェイスを介して、ページ処理の進行状況に関する情報を通知します。これらのインターフェイスは、IFRPageEvents (C++ 用) および dispinterface DIFRPageEvents (Visual Basic 用) です。なお、Visual Basic ユーザーはイベント インターフェイスの実装の詳細を意識する必要はありません。これは、この開発プラットフォームにイベント処理を簡単に扱うための手段が用意されているためです。

​

プロパティ

	, 読み取り専用	Engine オブジェクトを返します。
	, 読み取り専用	ページを含む Document を返します。
	, 読み取り専用	ページの画像へのアクセスを提供します。
		ページの Layout へのアクセスを提供します。 このプロパティに Layout オブジェクトを割り当てると (たとえば、あるページから別のページへデータを転送する場合) 、対応する Document の論理構造が無効になります。合成メソッドのいずれかを呼び出して Document の構造を復元する必要があります。ただし、Document 全体に対して合成を実行する必要はなく、変更されたページのみを合成すれば十分です。たとえば、 Synthesize メソッドを使用します。
	, 読み取り専用	ページのテキストを特殊な「プレーンテキスト」形式で返します。
	, 読み取り専用	ページのソース画像へのフルパスを指定します。
	, 読み取り専用	認識されたページの主要言語を指定します。このプロパティには、検出された言語のコレクション (DetectedLanguages プロパティ) の先頭にある言語の内部名が格納されます。 このプロパティが有効な値を持つのは、自動言語検出を有効にして認識を実行した場合のみです (詳細については、 プロパティを参照してください) 。 デフォルト値は空の文字列です。
	, 読み取り専用	認識されたページで検出された認識言語のコレクションへのアクセスを提供します。コレクション内の言語は、出現頻度の高い順に並べられています。 このプロパティが有効な値を持つのは、自動言語検出を有効にして認識を実行した場合のみです (詳細については、 プロパティを参照してください) 。 言語のリストは認識後にのみ更新されます。つまり、ページの Layout を手動で編集しても、コレクションの内容は変わりません。
	、読み取り専用	ページの論理構造が最新でないかどうかを指定します。このプロパティが TRUE の場合、エクスポートの前にページの文書合成を実行する必要があります。実行しない場合、エクスポート中にエラーが発生します。 このプロパティは、ビジュアルコンポーネントを使用する場合に役立ちます。ユーザーがビジュアルコンポーネントの GUI を通じてページのレイアウトを変更すると、ページの論理構造が無効になります。ビジュアルコンポーネントで利用可能なコマンドを使用してそのようなページをエクスポートする場合、ビジュアルコンポーネントは自動的にページを合成します。ただし、エクスポートに FineReader Engine API メソッドを使用する場合は、エクスポートの前にページの文書合成を実行する必要があります。
	、読み取り専用	ソースファイル内のページのインデックスを返します。
	、読み取り専用	このページのソースファイルがデジタル署名された PDF かどうかを示します。
	, 読み取り専用	ページ上で検出された名刺のコレクションへのアクセスを提供します。
		ビジュアルコンポーネントは現在 Windows のみでサポートされています。 Undo および Redo メソッドを使用できるかどうかを指定します。このプロパティの値が TRUE の場合、ページを変更できるメソッド (FRPage または オブジェクトのメソッドなど) を通じて呼び出されたコマンド、あるいは Windows ビジュアルコンポーネントから呼び出されたコマンドをすべて元に戻すスタックに追加できます。 この場合、ビジュアルコンポーネントから呼び出されたコマンドは自動的にスタックに追加されます。API から呼び出されたコマンドをスタックに追加するには、Update メソッドを使用してください。 ビジュアルコンポーネントで開かれているページに対して、このプロパティを FALSE に設定することはできません。
	、読み取り専用	ビジュアルコンポーネントは現在 Windows のみでサポートされています。 ページを変更できるメソッド (FRPage または オブジェクトのメソッドなど) を通じて呼び出されたか、いずれかのビジュアルコンポーネントから呼び出された、最後に元に戻したコマンドに対して Redo メソッドを実行できるかどうかを指定します。
	、読み取り専用	ビジュアルコンポーネントは現在 Windows のみでサポートされています。 ページを変更できるメソッド (FRPage または オブジェクトのメソッドなど) を通じて呼び出されたか、いずれかのビジュアルコンポーネントから呼び出された最後のコマンドに対して Undo メソッドを実行できるかどうかを指定します。

​

メソッド

名称	説明
AddWordsToCacheDictionary	このメソッドは、複数の単語を cache dictionary に追加します。
AddWordToCacheDictionary	このメソッドは、cache dictionary に単語を1つ追加します。
Analyze	ページを解析します。
AnalyzeRegion	指定した領域内の画像レイアウトを解析します。
AnalyzeTable	指定したブロックをテーブルブロックに置き換え、テーブルの構造を解析します。
CleanCacheDictionary	このメソッドは、cache dictionary 内のすべての単語を削除します。
DetectOrientation	ページの向きを検出します。
DetectResolution	指定された範囲から最適な解像度を選択します。
Export	ページを外部形式のファイルに保存します。
ExtractBarcodes	すべてのバーコードブロックを検出し、認識します。
ExtractMrz	機械可読領域 (MRZ) からデータを抽出します。
FindPageSplitPosition	画像を分割できる位置を特定します。
Flush	それらへの参照がない場合、FRPage オブジェクトに対応する ImageDocument オブジェクトおよび Layout オブジェクトをアンロードし、必要に応じてディスクに保存します。ディスクへの保存は任意であり、データが変更されていない場合はこの段階を省略できます。
IsEmpty	ページが空であるかどうかを確認します。
LearnCheckmarks	FineReader Engine にカスタム型のチェックマークを認識させるための学習を行います。
PreprocessAnalyzeRecognize	ページの前処理、レイアウト解析、認識、およびページ合成を実行します。
Preprocess	ページを前処理します。ページの向き、白黒反転、幾何学的な歪みを補正します。ページの前処理は、ページ解析の前に実行されます。
Recognize	ページを認識し、ページ合成を行います。
RecognizeBlocks	明示的に指定した一連のブロック内のテキストを認識し、ページ合成を行います。
Redo	注: Visual Components は現在 Windows でのみサポートされています。 FineReader Engine API から呼び出された、直前に取り消したコマンドを再実行します。
Synthesize	各ページに対して文書合成を実行します。Linux および Windows では、1 ページの文書を Batch Processor で処理する場合に、このメソッドが役立つことがあります。
SynthesizeBusinessCard	指定された認識済みの領域内で、名刺のfieldを検出しようとします。
SynthesizeBusinessCardEx	合成パラメーターを使用して、指定した認識済み領域内で名刺のfieldの検出を試みます。
元に戻す	注: Visual Components は現在 Windows でのみサポートされています。 FineReader Engine API から呼び出された最新のコマンドを元に戻します。
Update	注: Visual Components は現在、Windows でのみサポートされています。 FineReader Engine API を介して行われたページレイアウトの変更を Visual Components に反映し、それらの変更を undo スタックに保存します。 注: このメソッドを呼び出すと、対応するドキュメントの論理構造は無効になります。いずれかの合成メソッドを呼び出してドキュメント構造を復元する必要があります。ただし、ドキュメント全体に対して合成を実行する必要はなく、変更されたページだけを合成すれば十分です。たとえば、Synthesize メソッドを使用できます。

​

関連オブジェクト

オブジェクト図

​

Output parameter

このオブジェクトは、以下のメソッドのOutput parameterです：

• FRPages オブジェクトの Item メソッド
• LinuxおよびWindows：BatchProcessor オブジェクトの GetNextProcessedPage メソッド

​

入力パラメーター

このオブジェクトは、以下のメソッドの入力パラメーターとして渡されます。

• IndexOf メソッド (FRPages オブジェクト)
• AddPage メソッド (FRDocument オブジェクト)
• AddPage メソッド (ExportFileWriter オブジェクト)
• CreateObjectFromPage メソッド (ClassificationEngine オブジェクト)
• OnProgress、OnWarning、OnRegionProcessed、OnPageProcessed メソッド (IFRPageEvents インターフェイス)
• PageRemoved メソッド (IFRPagesEvents インターフェイス)
• ComparePages メソッド (Comparator オブジェクト)
• Linux および Windows: ProcessPageAsync メソッド (BatchProcessor オブジェクト)
• Windows で Visual Components を使用する場合:
  • OnActivePageChanged、OnActivePageChanging メソッド (DocumentViewerEvents インターフェイス)
  • OnActivePageChanged、OnActivePageChanging メソッド (IImageViewerEvents インターフェイス)
  • OnActivePageChanged メソッド (IZoomViewerEvents インターフェイス)
  • OnActivePageChanged、OnActivePageChanging メソッド (ITextEditorEvents インターフェイス)
  • OnActivePageChanged メソッド (ITextValidatorEvents インターフェイス)

​

関連するビジュアルコンポーネント

​

サンプル

C# コード

FREngine.IEngine engine;
string fileName;
FREngine.IBatchProcessor batchProcessor;
// Batch Processor は作成および開始されているものとします
// 認識済みページを取得し、PDF 形式でエクスポートします
FREngine.IFRPage page = batchProcessor.GetNextProcessedPage();
while( page != null ) {
 // エクスポート前にページを合成します
 page.Synthesize(null);
 // ページをファイルにエクスポートします
 page.Export(fileName, FREngine.FileExportFormatEnum.FEF_PDF, null);
 page = batchProcessor.GetNextProcessedPage();
}

このオブジェクトは、次のコード サンプルで使用されています。

• macOS: 名刺認識 および RecognizedTextProcessing
• Linux: BCR, BatchProcessing, CustomLanguage, CommandLineInterface
• Windows: BatchProcessing, CustomLanguage, CommandLineInterface, RecognizedTextProcessing, VisualComponents およびデモ ツール: BatchProcessingRecognition, Engine 事前定義処理プロファイル.

​

関連項目

FRPages

使用

プロパティの操作