画像スタックオブジェクト
[FIE module]

画像格納モード

画像スタックオブジェクトにて、画像をどのように格納するかを定める定数です。

参照:

fnFIE_imgstack_alloc()

列挙型の値:

F_IMGSTACK_CHILD_MODE	チャイルド画像モード
F_IMGSTACK_ROOT_MODE	ルート画像モード

画像スタックオブジェクトの作成

画像スタックオブジェクトを作成します。作成時に画像格納モード( add_img_mode )を指定できます。

• チャイルド画像モードで作成した場合、画像スタックオブジェクトに画像を追加しようとすると、追加したい画像の全チャネル全座標をカバーしたチャイルド画像を保持します。外部で画像の内容を変更したり解放したりすると影響を受けます。
• ルート画像モードで作成した場合、画像スタックオブジェクトに画像を追加しようとすると画像スタックオブジェクトの内部に追加したい画像と同サイズのルート画像を作成し内容をコピーします。外部でもとの画像の内容を変更したり解放したりしても影響を受けません。

また、スタック内の画像の画像型、チャネル数、縦横サイズを統一させるか( check_img_format )を指定できます。

• TRUE を指定した場合、スタックに2枚目以降の画像を追加した際に、1枚目の画像と画像型、チャネル数、縦横サイズが等しいかをチェックし、異なる場合にエラーを返します。
• FALSE を指定した場合、スタックに画像を追加する際に画像型、チャネル数、縦横サイズのチェックを行いません。

画像スタックオブジェクトが不要になったら fnFIE_free_object() にて解放してください。

引数:

[in]	add_img_mode	画像格納モード F_IMGSTACK_CHILD_MODE チャイルド画像モード F_IMGSTACK_ROOT_MODE ルート画像モード
[in]	check_img_format	画像型、チャネル数、縦横サイズ統一オプション TRUE を指定した場合、画像スタックオブジェクトに2枚目以降の画像を追加した際に、1枚目の画像と画像型、チャネル数、及びサイズが等しいかをチェックし、異なる場合にエラーを返します。 FALSE を指定した場合、上記のチェックを行いません。

戻り値:

作成した画像スタックオブジェクト。 パラメータエラー、ライセンスエラー、またはメモリ確保エラーで失敗した場合はNULLを返します。

画像の取得

画像スタックオブジェクトの中から指定した番号の画像オブジェクトを一つ取得します。
画像オブジェクトが不要になったら fnFIE_free_object() にて解放してください。

引数:

[in]	hstack	画像スタックオブジェクト
[in]	index	画像の番号。0以上で、 fnFIE_imgstack_getnum() で得た数値より小さくなければなりません。
[out]	errorcode	エラーコード。必要がなければNULLを渡してください。 F_ERR_NO_LICENCE ライセンス異常 F_ERR_INVALID_OBJECT オブジェクト異常 F_ERR_INVALID_PARAM パラメータ異常 F_ERR_NOMEMORY メモリ不足 F_ERR_NONE 正常終了

戻り値:

画像オブジェクト。失敗した場合はNULLを返します。

画像の数を取得

引数:

[in]

hstack

画像スタックオブジェクト

戻り値:

格納されている画像の数。パラメータエラー、またはライセンスエラーの場合に -1 を返します。

画像スタック内の画像を全て取り除く

画像スタック内の画像を全て取り除きます。
当関数の実行より前に fnFIE_imgstack_getat() で取得した画像オブジェクトはNULLチャイルド画像になる可能性があります。

引数:

[in,out]

hstack

画像スタックオブジェクト

戻り値:

	F_ERR_NONE	正常終了
	F_ERR_INVALID_OBJECT	hstack が画像スタックオブジェクトではない
	F_ERR_NO_LICENCE	ライセンスエラー

画像スタック末尾に画像を追加する

画像スタックの末尾に himage の内容を追加します。追加の形式については fnFIE_imgstack_alloc() の画像格納モードに従います。 また、 fnFIE_imgstack_alloc() で設定した画像型、チャネル数、縦横サイズ統一オプションが TRUE の場合、 2枚目以降の画像 himage が追加された際に、1枚目の画像と himage の画像型、チャネル数、縦横サイズを比較し、ひとつでも異なる場合はエラーを返します。

引数 himage は内部で複製していますので、関数実行後は解放して構いません。 但し、画像格納モードが F_IMGSTACK_CHILD_MODE の場合、 himage の参照先のルート画像は保持する必要があります。

引数:

[in,out]	hstack	画像スタックオブジェクト
[in]	himage	追加する画像

戻り値:

	F_ERR_NONE	正常終了
	F_ERR_INVALID_OBJECT	hstack が画像スタックオブジェクトではない
	F_ERR_INVALID_IMAGE	himage が画像オブジェクトではない または画像型、チャネル数、縦横サイズ統一オプションが TRUE のとき、追加された画像と1枚目の画像の画像型、チャネル数、縦横サイズが異なる
	F_ERR_NOMEMORY	メモリ確保エラー
	F_ERR_NO_LICENCE	ライセンスエラー

画像スタック末尾の画像取り出し

画像スタック末尾の画像を戻り値として返し、画像スタックから削除します。 取り出した画像が不要になったら fnFIE_free_object() で解放してください。

引数:

[in,out]	hstack	画像スタックオブジェクト
[out]	errcode	エラーコード。必要なければNULLを渡してください F_ERR_NONE 正常終了 F_ERR_INVALID_OBJECT hstack が画像スタックオブジェクトではない F_ERR_NODATA hstack に画像がひとつもない F_ERR_NO_LICENCE ライセンスエラー

戻り値:

取り出した画像オブジェクト。失敗した場合はNULLを返します。

特定の位置に画像を追加

画像スタックオブジェクトの index 番目に himage を追加します。
格納されている画像の個数を num としたとき、index の範囲は 0 〜 num であり、 この範囲外の値を index に指定した場合はエラーになります。
また、 fnFIE_imgstack_alloc() で設定した画像型、チャネル数、縦横サイズ統一オプションが TRUE の場合、 挿入前の画像スタックの0番目の画像と himage の画像型、チャネル数、縦横サイズを比較し、 ひとつでも異なる場合はエラーとなります。

引数 himage は内部で複製していますので、関数実行後は解放して構いません。 但し、画像格納モードが F_IMGSTACK_CHILD_MODE の場合、 himage の参照先のルート画像は保持する必要があります。

引数:

[in]	hstack	画像スタックオブジェクト
[in]	index	追加位置の番号
[in]	himage	追加する画像オブジェクト

戻り値:

	F_ERR_NONE　正常終了
	F_ERR_INVALID_OBJECT	hstack が画像スタックオブジェクトではない
	F_ERR_INVALID_PARAM	index が有効な値ではない
	F_ERR_INVALID_IMAGE	himage が画像オブジェクトではない または画像型、チャネル数、縦横サイズ統一オプションが TRUE のとき、追加された画像と1枚目の画像の画像型、チャネル数、縦横サイズが異なる
	F_ERR_NOMEMORY	メモリ不足エラー
	F_ERR_NO_LICENCE	ライセンスエラー

特定の位置の画像を削除

画像スタックオブジェクトの index 番目の画像を削除します。
格納されている画像の個数を num としたとき、index の範囲は 0 〜 num-1 であり、 この範囲外の値を index に指定した場合はエラーになります。
また、画像スタック内に画像がひとつも格納されていない場合もエラーとなります。

引数:

[in]	hstack	画像スタックオブジェクト
[in]	index	削除位置の番号

戻り値:

	F_ERR_NONE　正常終了
	F_ERR_INVALID_OBJECT	hstack が画像スタックオブジェクトではない
	F_ERR_INVALID_PARAM	index が有効な値ではない、画像スタックに画像がひとつも格納されていない
	F_ERR_NO_LICENCE	ライセンスエラー

画像スタック内の画像の形式を確認する

• href に画像オブジェクトを渡した場合、 hstack 内の全ての画像が href の画像型、チャネル数、縦横サイズについて同一かどうか調べます。
• href に画像スタックオブジェクトを渡した場合、 hstack 内の画像数が href 内の画像数と等しく、かつ hstack 内の href と対応する位置の画像が画像型、チャネル数、縦横サイズについて同一かどうか調べます。
• href にNULLを渡した場合、 hstack 内の全ての画像が hstack の先頭の画像と画像型、チャネル数、縦横サイズについて同一かどうか調べます。

引数:

[in]	hstack	チェック対象の画像スタックオブジェクト
[in]	href	チェックの基準とする画像オブジェクトまたは画像スタックオブジェクト

戻り値:

	F_ERR_NONE	href に画像オブジェクトを渡した場合、hstack 内の全ての画像が href の画像型、チャネル数、縦横サイズについて等しい href に画像スタックオブジェクトを渡した場合、 hstack 内の画像数が href 内の画像数と等しく、 かつ hstack 内の href と対応する位置の画像が画像型、チャネル数、縦横サイズについて等しい href にNULLを渡した場合 hstack 内の全ての画像が hstack の先頭の画像と画像型、チャネル数、縦横サイズについて等しい hstack 内の画像枚数が1枚以下
	F_ERR_INVALID_OBJECT	hstack が画像スタックオブジェクトではない href が以下のいずれにも該当しない 画像オブジェクト 画像スタックオブジェクト NULL
	F_ERR_INVALID_IMAGE	画像を比較し、画像型、チャネル数、縦横サイズのいずれかが等しくない href に画像スタックオブジェクトを渡した場合、 hstack 内の画像数とhref 内の画像数が等しくない
	F_ERR_NO_LICENCE	ライセンスエラー