page¶
page モジュールでは、Page クラスに関する機能を扱います。
Page オブジェクト¶
Page クラスは、DocuWorks 文書に含まれる個別のページを扱います。
Page クラスは、その基底クラスである Annotatable クラスに多くを負っています。
annotatable モジュールを参照してください。
コンストラクタ¶
- クラス
Page(doc, pos) docは、ページが属する DocuWorks 文書またはバインダー内文書 (Document オブジェクトまたは DocumentInBinder オブジェクト) です。posはdoc内でのページ番号です (0 から始まります)。
インスタンス属性¶
annotationsページに直接付加されているアノテーションの個数です。
bppページの色深度 (ピクセルあたりのビット数) です。
compress_typeページの圧縮方法です。
'NORMAL','LOSSLESS','HIGHQUALITY','HIGHCOMPRESS','NOCOMPRESS','JPEG','PACKBITS','G4','MRC_NORMAL','MRC_HIGHQUALITY','MRC_HIGHCOMPRESS','MRC'または'JPEG_TTN2'です。degreeページの回転角です。90 の倍数です。
docページが属する DocuWorks 文書またはバインダー内文書 (Document オブジェクトまたは DocumentInBinder オブジェクト) です。
(注) ページがバインダー内文書に含まれている場合であっても、 そのバインダーをページから直接指し示す手段はありません。 バインダー内文書 (DocumentInBinder オブジェクト) を取得した上で、 その DocumentInBinder オブジェクトの属性
binderを参照して、 バインダーにアクセスしてください。image_sizeページの元データの大きさを表す Point オブジェクトです。 単位はピクセルです。
is_colorページがカラーの場合は
Trueになります。 モノクロまたはグレイスケールの場合はFalseになります。original_sizeページの元データの大きさを表す Point オブジェクトです。 単位はミリメートルです。
original_resolutionページの元データの横・縦の解像度を表す Point オブジェクトです。 単位は DPI です。
posself.docの中でのページ位置 (0 から始まります)。resolutionページの横・縦の解像度を表す Point オブジェクトです。 単位は DPI です。
sizeページの横・縦の大きさを表す Point オブジェクトです。 単位はミリメートルです。
typeページの種類です。
'IMAGE','APPLICATION'または'NULL'です。
インスタンスメソッド¶
bitmap()ページを画像化して Bitmap オブジェクトで返します。アノテーションを 表示する設定になっていれば、アノテーションも画像に含めます。
(注) Bitmap オブジェクトは、属性として
width,height,planes,depth,compression,data_size,color_used,color_important,resolution,headerおよびdataを持ちます。 BMP/DIB フォーマットの (ヘッダを含めた) オクテットストリーム (バイト列) は、Bitmap オブジェクトの インスタンスメソッドoctet_stream()で取得できます。clear_ocr_text()ページ内の OCR テキストをすべて消去します。
color_scheme()self.is_colorおよびself.bppから、ページのカラースキームを'COLOR','MONO_HIGHQUALITY'(グレースケール) または'MONO'で返します。content_text(type=None)ページに含まれるアプリケーションテキストまたは OCR テキストを返します。
(注) アノテーションに含まれるテキストを取得するには、Annotatable クラスのインスタンスメソッド
annotation_text()またはfulltext()を利用してください。export(path=None)ページを別ファイルに書き出します。
pathは書き出し先のパス名です。pathを設定しない場合は、self.docのファイル名の拡張子を除く 部分に'_Pn'(n はページ番号) を付加したもの (os.path.join(self.dir, '%s_P%d.xdw' % (self.doc.name, self.pos))) となります。実際に書き出されたファイルのパス名を返します。export_image(path=None, dpi=600, color='COLOR', format=None, compress='NORMAL', direct=False)(バインダー内) 文書のページ (単独または連続する複数ページ) を 画像ファイルへ書き出します。
pathは書き出し先のパス名です。すでに存在する場合は 派生したパス名が書き出し先になります。dpiは書き出される画像の解像度です。単位は DPI です。 10～600 が有効です。colorは書き出される画像の色数の指定です。'COLOR','MONO'または'MONO_HIGHQUALITY'(グレースケール) で指定します (小文字でもかまいません)。formatは書き出される画像のデータ形式です。'BMP','TIFF','JPEG'または'PDF'で指定します (小文字でもかまいません)。compressは書き出される画像の圧縮形式です。formatが'BMP'である場合は、指定は無視されます。formatが'TIFF'である場合は、'NOCOMPRESS','PACKBITS','JPEG','JPEG_TTN2'または'G4'を指定します。formatが'JPEG'である場合は、'NORMAL','HIGHQUALITY'または'HIGHCOMPRESS'を指定します。formatが'PDF'である場合は、'NORMAL','HIGHQUALITY','HIGHCOMPRESS','MRC_NORMAL','MRC_HIGHQUALITY'または'MRC_HIGHCOMPRESS'を指定します。directが真である場合は、ページの画像 (アノテーションや ページフォームは含みません) を内部の圧縮イメージのまま書き出します。 このため、処理が高速です。生成される画像の形式は内部状態に依存して TIFF, JPEG または PDF となり、生成される画像ファイルの拡張子はそれぞれ'.tiff','.jpeg'または'.pdf'となります。画像の向きも 内部状態に依存し、DocuWorks Viewer (Lite) で見たときとは異なる場合が あります。画像の向きは、self.degreeで取得できます。 実際に書き出されたファイルのパス名を返します。get_userattr(name, default=None)ページのユーザー定義属性
nameの値を取得します。strを返します。 ユーザー定義属性nameがない場合は、defaultの値を返します。(注) ページのユーザー定義属性は、DocuWorks Desk/Viewer の GUI で アクセスすることはできません。
ocr(engine='DEFAULT', strategy='SPEED', preprocessing='SPEED', noise_reduction='NONE', deskew=True, form='AUTO', column='AUTO', rects=None, language='AUTO', main_language='BALANCED', use_ascii=True, insert_space=False, verbose=False, failover=True)ページからテキストを抽出 (OCR) します。結果として得られるテキストは、 別途
self.content_text()で取り出す必要があります。engineは'DEFAULT','MULTI','WINREADER PRO'です (小文字でもかまいません)。ただし、DocuWorks 9 以上では'MULTI'は 指定できません。 DocuWorks 9 以上では DocuWorks OCR License for Development Tool Kit を あらかじめ登録しておく必要があります。有効な登録がなく必要な環境変数が 定義されている場合はocr_azure()またはocr_gcloud()の実行を 試みます。その他の場合は AccessDeniedError となります。strategyは'STANDARD','SPEED'または'ACCURACY'です (小文字でもかまいません)。preprocessingは'SPEED'または'ACCURACY'です (小文字でもかまいません)。DocuWorks 9 以上では'MONO_SPEED','MONO_ACCURACY','COLOR'のいずれかを指定します (小文字でも かまいません)。noise_reductionは'NONE','NORMAL','WEAK'または'STRONG'です (小文字でもかまいません)。deskewが真の場合は、OCR 処理の前に傾き補正を自動的に行います。 ただし、補正結果がページに反映されることはありません。formは'AUTO','TABLE'または'WRITING'です (小文字でもかまいません)。columnは'AUTO','HORIZONTAL_SINGLE','HORIZONTAL_MULTI','VERTICAL_SINGLE'または'VERTICAL_MULTI'です (小文字でもかまいません)。rectsは OCR 処理対象範囲となる領域 (Rect オブジェクト) のシーケンスです。languageは'AUTO','JAPANESE'または'ENGLISH'です (小文字でもかまいません)。 DocuWorks 9 以上では、'SIMPLIFIED_CHINESE','TRADITIONAL_CHINESE','THAI','KOREAN','VIETNAMESE','INDONESIAN','MALAY','TAGALOG'も指定できます。main_languageは'BALANCED','JAPANESE'または'ENGLISH'です (小文字でもかまいません)。use_asciiが真である場合は、ASCII コードで該当する文字がある場合は ASCII コード (いわゆる半角英数) を採用します。insert_spaceが真である場合は、空白部分に空白文字を挿入します。verboseが真である場合は、認識作業中の様子を画面に表示します。 ただし、verboseをFalseにしても、「認識中…」と表示される ダイアログは表示されます。failoverが真である場合は、DocuWorks 9 以上で内蔵 OCR が利用できない ときはocr_azure()を実行します。ただし、環境変数XDWLIB_OCR_AZURE_ENDPOINTおよびXDWLIB_OCR_AZURE_SUBSCRIPTION_KEYを定義しておく必要があります。ocr_azure(self, language="ja", charset="DEFAULT", errors="replace", timeout=60, endpoint="", subscription_key="", version="3.2", model_version="2021-04-12")ページから Microsoft Azure Cognitive Services の Computer Vision (OCR) を利用してテキストを抽出します。結果として得られるテキストは、別途
self.content_text()で取り出す必要があります。charsetには'DEFAULT','ANSI','SYMBOL','MAC','SHIFTJIS','HANGEUL','CHINESEBIG5','GREEK','TURKISH','BALTIC','RUSSIAN','EASTEUROPE','OEM'のいずれかを指定します。endpointおよびsubscription_keyは Computer Vision の設定で あらかじめ作成しておく必要があります。引数で与えられない場合は、環境変数XDWLIB_OCR_AZURE_ENDPOINTおよびXDWLIB_OCR_AZURE_SUBSCRIPTION_KEYから読み取ります。いずれも存在しない場合はエラーとなります。ocr_gcloud(self, language=None, charset="DEFAULT", errors="replace", credentials=None)ページから Google Cloud Vision の OCR を利用してテキストを抽出します。 結果として得られるテキストは、別途
self.content_text()で取り出す必要があります。languageには言語コード (ISO 639-1 または 639-2/T) を指定します。 通常は段落中の行末はひとつの空白文字に置き換えますが、日本語など 分かち書きをしない言語の場合は空白文字を置かず次の行と連結します。charsetには'DEFAULT','ANSI','SYMBOL','MAC','SHIFTJIS','HANGEUL','CHINESEBIG5','GREEK','TURKISH','BALTIC','RUSSIAN','EASTEUROPE','OEM'のいずれかを指定します。credentialsには Google Cloud サービスアカウントであらかじめ作成した 認証情報 (JSON ファイル) のフルパス名を指定します。指定しない場合は 環境変数GOOGLE_APPLICATION_CREDENTIALSの値を用います。rasterize()ページがアプリケーションページである場合は、イメージページに 置き換えます。アプリケーションページでない場合は、何もしません。
reduce_noise(level='NORMAL')ページイメージのノイズを除去します。
levelは'NORMAL','WEAK'または'STRONG'です (小文字でもかまいません)。(注) モノクロイメージのページについてのみ利用可能です。 アプリケーションページやカラー/グレイスケールのイメージページで 利用するとエラーとなります。
re_regions(pattern)指定のパターンに適合する文字列がページ上で占める半開矩形領域を求めます。
patternはreモジュールで利用できる正規表現文字列または 正規表現オブジェクトです。 Rect (ただし、適合する文字列が存在していても 対応するページ上の表示領域が得られない場合は None) のリストを返します。(注)
set_ocr_text()で OCR テキストが設定されていた場合は、 このメソッドで AccessDeniedError を発生することがあります。 これは XDWAPI の制限です。rotate(degree=0, auto=False)ページを回転します。
degreeは時計回りの回転角で、単位は度です。autoが真である場合は、OCR 処理用に自動正立処理を行います。degreeに指定できる値は、PIL (Python Imaging Library) が利用できる 場合は任意の整数です。PIL が利用できない場合は、90 の倍数のみ指定 できます。(注)
degreeが 90 の倍数でない場合、ページを画像にして処理を 進めます。この結果、アノテーションは画像の一部となり、アプリケーション テキストや OCR テキストも失われます。set_ocr_text(rtlist, charset='SHIFTJIS', half_open=True, errors='strict', unit='mm')ページの OCR テキストを置き換えます。
rtlistは 2 要素のシーケンス(rect, text)のシーケンスです。 rect は 文字列textがページ上で占める半開矩形領域です。 単位はミリメートルです。 たとえば、[(Rect(10, 10, 30, 18), "とある文字列"), (Rect(10, 30, 200, 32), "A long char string")]
などのようになります。
charsetはtextの文字セットで、'DEFAULT','OEM','ANSI','SYMBOL','MAC','SHIFHTJIS','HANGEUL','CHINESEBIG5','GREEK','TURKISH','BALTIC','RUSSIAN'または'EASTEUROPE'で指定します (小文字でもかまいません)。half_openに偽を指定した場合は、rectを閉鎖矩形領域とみなします。errorsは各文字列を格納する際のエンコーディングで生じたエラーの取扱を 指定します。 Python の codecs.encode() での指定と同じです。unitはrect(各文字列の位置) の単位を'mm'(ミリメートル) または'px'(ピクセル) で指定します。'px'はページの元となった 画像でのピクセル位置を表します。(注) このメソッドで OCR テキストを設定した場合、
text_regions()やre_regions()で文字列の位置を取得しようとすると AccessDeniedError が発生します。これは XDWAPI の制限です。set_userattr(name, value)ページのユーザー定義属性
nameを値valueで設定します。valueはstrで与えます。(注) ページのユーザー定義属性は、DocuWorks Desk/Viewer の GUI で アクセスすることはできません。
text_regions(text, ignore_case=False, ignore_width=False, ignore_hirakata=False)指定のテキストに適合する文字列がページ上で占める半開矩形領域を求めます。
textは対象文字列です。ignore_caseが真である場合は、大文字と小文字を区別しません。ignore_widthが真である場合は、いわゆる全角文字といわゆる半角文字を 区別しません。ignore_hirakataが真である場合は、平仮名と片仮名を 区別しません。Rect (ただし、適合する文字列が存在していても対応するページ上の 表示領域が得られない場合は
None) のリストを返します。 単位はミリメートルです。(注)
set_ocr_text()で OCR テキストが設定されていた場合は、 このメソッドで AccessDeniedError を発生することがあります。 これは XDWAPI の制限です。view(light=False, wait=True, fullscreen=False, zoom=0)ページの内容を複製した閲覧用一時ファイルを DocuWorks Viewer または DocuWorks Viewer Light のいずれかで閲覧します。 パスワード、DocuWorks 電子印鑑または電子証明書によるセキュリティーの 設定がされている文書では、エラーとなります。
lightが真である場合は、DocuWorks Viewer Light を優先して利用します。waitが真である場合は、DocuWorks Viewer (Light) が終了するのを待ち、 閲覧中に追加されたものも含めて、ページ番号 (0 から開始します) をキー、 各ページのアノテーションの情報 (AnnotationCacheオブジェクト) を列挙したリストを値とする辞書を返します。アノテーションが存在しない ページは含まれません。閲覧用一時ファイルは自動的に消去されます。waitが偽である場合は、DocuWorks Viewer (Light) を起動したら すぐに制御が戻り、(proc, temp)という 2 要素からなるタプルを 返します。この場合、procはsubprocessモジュールが提供するPopenオブジェクトであり、tempは DocuWorks Viewer (Light) で閲覧中の一時ファイルのパス名です。tempおよびその親ディレクトリは、このメソッドを呼び出した側が 必要がなくなった時点で消去してください。proc, temp = pg.view(wailt=False) # ... wait for proc.poll() != None ... os.remove(temp) os.rmdir(os.path.dirname(temp)) # shutil.rmtree() を利用してもよい
fullscreenが真である場合は、フルスクリーン (プレゼンテーション モード) で表示します。zoomには表示倍率を % で表示します。ただし、0 は 100% を意味します。 また'WIDTH','HEIGHT','PAGE'を指定すると、それぞれ 幅 / 高さ / ページ全体で表示します。
PageCollection オブジェクト¶
PageCollection クラスは、Page オブジェクトの集合 (シーケンス) を扱います。 DocuWorks には対応する概念はありませんが、おおむね、DocuWorks 文書を開いて 一覧表示した状態で Ctrl + クリックして複数のページを選択した状態に 相当します。
PageCollection クラスは、 list を拡張したものです。 list
で利用できるメソッド等が使えますが、その場合は結果も list
になることがある点に注意してください。
コンストラクタ¶
- クラス
PageCollection(seq) seqは Page オブジェクトからなるシーケンスです。
インスタンスメソッド¶
__add__(obj)objは Page オブジェクトまたは PageCollection オブジェクトです。objをページのシーケンスに追加 (appendまたはextend) して得られる PageCollection オブジェクトを返します。__iadd__(obj)self += objはself = self + objと同じです。export(path=None, flat=False, group=True)selfが持つページをすべてまとめた内容の新たな DocuWorks 文書またはバインダーを生成します。pathは生成先のパス名です。指定しなかった場合は、 最初のページが属する文書またはバインダーのパス名から 派生したパス名となります。flatが真である場合は、DocuWorks 文書が生成されます。flatがFalseである場合は、DocuWorks バインダーが生成されます。groupの指定は、flatがFalseの場合のみ有効です。groupが真である場合は、各ページが属する DocuWorks 文書またはバインダー内文書が同一の連続するページは、 バインダー内文書にまとめられます。groupがFalseである場合は、各ページはすべて別々のバインダー内文書となります。 実際に生成された DocuWorks 文書またはバインダーのパス名を返します。 拡張子は DocuWorks 文書の場合は.xdwとなり、DocuWorks バインダーの場合は.xbdとなります。group()selfを分解して、PageCollection オブジェクトのリストにして返します。 分解に際して、連続する Page オブジェクトの属する BaseDocument オブジェクトが同一であれば、同じ PageCollection オブジェクトに 格納されるようにします。 たとえば、selfがPageCollection([A[0], A[1], B[2], C[2], C[5], C[7], A[3], B[4], B[6]])であれば、self.group()は[PageCollection([A[0], A[1]]), PageCollection([B[2]]), PageCollection([C[2], C[5], C[7]]), PageCollection([A[3]]), PageCollection([B[4], B[6]])]となります。view(light=False, wait=True, page=0, fullscreen=False, zoom=0, flat=False, group=True)ページの内容を複製した閲覧用一時ファイルを DocuWorks Viewer または DocuWorks Viewer Light のいずれかで閲覧します。 パスワード、DocuWorks 電子印鑑または電子証明書によるセキュリティーの 設定がされている文書では、エラーとなります。
lightが真である場合は、DocuWorks Viewer Light を優先して利用します。waitが真である場合は、DocuWorks Viewer (Light) が終了するのを待ち、 閲覧中に追加されたものも含めて、ページ番号 (0 から開始します) をキー、 各ページのアノテーションの情報 (AnnotationCacheオブジェクト) を列挙したリストを値とする辞書を返します。アノテーションが存在しない ページは含まれません。閲覧用一時ファイルは自動的に消去されます。waitが偽である場合は、DocuWorks Viewer (Light) を起動したら すぐに制御が戻り、(proc, temp)という 2 要素からなるタプルを 返します。この場合、procはsubprocessモジュールが提供するPopenオブジェクトであり、tempは DocuWorks Viewer (Light) で閲覧中の一時ファイルのパス名です。tempおよびその親ディレクトリは、このメソッドを呼び出した側が 必要がなくなった時点で消去してください。proc, temp = pg.view(wailt=False) # ... wait for proc.poll() != None ... os.remove(temp) os.rmdir(os.path.dirname(temp)) # shutil.rmtree() を利用してもよい
pageが指定されている場合は、最初からそのページ (0 から開始します) を表示します。fullscreenが真である場合は、フルスクリーン (プレゼンテーション モード) で表示します。zoomには表示倍率を % で表示します。ただし、0 は 100% を意味します。 また'WIDTH','HEIGHT','PAGE'を指定すると、それぞれ 幅 / 高さ / ページ全体で表示します。flatが真である場合は、すべてのページをひとつの DocuWorks 文書に まとめて表示します。flatが偽である場合は、各ページをバインダー内 文書としたバインダーとして表示します。このときgroupが真であれば、 連続するページで元の文書が同じものはひとつの文書にまとめます。