\section{\module{imgfile} ---
         SGI imglib ファイルのサポート}

\declaremodule{builtin}{imgfile}
  \platform{IRIX}
\modulesynopsis{SGI imglib ファイルのサポート。}


\module{imgfile} モジュールは、Python プログラムが SGI imglib 画像
ファイル (\file{.rgb} ファイルとしても知られています) にアクセスできる
ようにします。このモジュールは完全なものにはほど遠いですが、その機能
はある状況で十分役に立つものなので、ライブラリで提供されています。
現在、カラーマップ形式のファイルはサポートされていません。

このモジュールでは以下の変数および関数が定義されています:

\begin{excdesc}{error}
この例外は、サポートされていないファイル形式の場合のような全てのエラーで
送出されます。
\end{excdesc}

\begin{funcdesc}{getsizes}{file}
この関数はタプル \code{(\var{x}, \var{y}, \var{z})} を返します。
\var{x} および \var{y} は画像のサイズをピクセルで表したもので、
\var{z} はピクセルあたりのバイト長です。3 バイトの RGB ピクセルと
1 バイトのグレイスケールピクセルのみが現在サポートされています。
\end{funcdesc}

\begin{funcdesc}{read}{file}
この関数は指定されたファイル上の画像を読み出して復号化し、Python 
文字列として返します。この文字列は 1 バイトのグレイスケールピクセル
か、4 バイトの RGBA ピクセルによるものです。左下のピクセルが文字列
中の最初のピクセルになります。これは \function{gl.lrectwrite()}
に渡すのに適した形式です。
\end{funcdesc}

\begin{funcdesc}{readscaled}{file, x, y, filter\optional{, blur}}
この関数は read と同じですが、\var{x} および \var{y} のサイズに
スケールされた画像を返します。\var{filter} および \var{blur} 
パラメタが省略された場合、単にピクセルデータを捨てたり複製したりする
ことによってスケール操作が行われるので、処理結果は、特に計算機上で
合成した画像の場合にはおよそ完璧とはいえないものになります。

そうする代わりに、スケール操作後に画像を平滑化するために用いる
フィルタを指定することができます。サポートされているフィルタの
形式は \code{'impulse'}、\code{'box'}、 \code{'triangle'}、
 \code{'quadratic'}、および \code{'gaussian'} です。フィルタを
指定する場合、\var{blur} はオプションのパラメタで、フィルタの
不明瞭化度を指定します。標準の値は \code{1.0} です。

\function{readscaled()} は正しいアスペクト比をまったく維持しようと
しないので、それはユーザの責任になります。
\end{funcdesc}

\begin{funcdesc}{ttob}{flag}
この関数は画像のスキャンラインの読み書きを下から上に向かって
行う (フラグがゼロの場合で、SGI GL 互換です) か、上から下に向かって
行う (フラグが 1 の場合で、X 互換です) かを決定する大域的なフラグを
設定します。標準の値はゼロです。
\end{funcdesc}

\begin{funcdesc}{write}{file, data, x, y, z}
この関数は \var{data} 中の RGB またはグレイスケールのデータ
を画像ファイル \var{file} に書き込みます。\var{x} および \var{y} 
には画像のサイズを与え、\var{z} は 1 バイトグレイスケール画像
の場合には 1 で、RGB 画像の場合には 3 (4 バイトの値として記憶され、
下位 3 バイトが使われます) です。これらは \function{gl.lrectread()}
が返すデータの形式です。
\end{funcdesc}
