任意カーネルフィルタクラス

Namespace: FVIL.Filter
Assembly: FVILbasic (in FVILbasic.dll) Version: 3.1.0.0 (3.1.0.17)

Syntax

C#
[SerializableAttribute]
public class CFviArbitraryKernelFilter : CFviFilter
Visual Basic
<SerializableAttribute>
Public Class CFviArbitraryKernelFilter
	Inherits CFviFilter

Remarks

画像データに任意のフィルタを施すクラスです。

パラメータKernel による2次元畳み込み処理を行います。 座標(x,y)における入力画像の濃度値を G(x,y) 、カーネルの値をK(i,j) と定義すると、出力画像の濃度値は

但し、

で定義されます。


整数型での演算:

画像の型が整数型の場合は、計算時間を減らす為に計算をINTで行なっています。 この時、カーネルの値も事前にDOUBLEからINTに変換してから演算を行う為、カーネルの値は整数値に変換できるよう、 適切にスケーリングされている必要があります。 Denom の値も同様に整数に変換して扱われます。 (DOUBLEからINTへの変換は、四捨五入を行います。)

例えば、1x3 のカーネルに [-0.1 -0.2 -0.1] を設定した場合、 これを四捨五入して 整数にすると [0 0 0] となってしまう為、結果は全て0になります。

また、カーネルの値があまりに大きい場合は演算途中でオーバーフローが発生する為、 カーネルの値は下式の条件を満たしている必要があります。 もし、下式の条件が満たされない場合は、オーバーフローが発生し、その時の出力結果は不定です。

尚、最終的な計算結果(積和した後、Denom の値で割った値)が画像型の有効範囲(※)を超える場合は、その型の有効な値範囲で飽和処理が行われます。 (※例えば ImageType.UC8 であれば 0〜255)


要求する入出力画像数
項目定数
入力画像1SrcImageCount フィールド
出力画像1DstImageCount フィールド

処理対象画像の条件:

処理対象の画像は下記の条件を満たしている必要が有ります。

  • 入力画像と出力画像の画像種別、処理範囲サイズ、チャネル数が等しい事
  • 処理画像の画像種別

初期値と範囲:
プロパティ初期値範囲説明
KernelCFviFilterKernel の初期値※インスタンスの差し替えはできません。カーネル
BorderModeBorderMode.NoneBorderMode に定義された定数ボーダー処理モード
BorderValue0(任意) ボーダー値
(BorderModeValue の場合に使用します。)

ボーダー処理について:

画像の周囲画素において、指定されたカーネルがはみ出す部分は、正しく値を求める事が出来ません。 しかし、基本クラス(CFviFilter)の ボーダーモード(BorderMode)と ボーダー濃度値(BorderValue)を使用し、 入力画像を拡張する事で、擬似的に周囲1画素の結果値も出力できるようになっています。 BorderModeBorderMode.None を指定した場合は、 この拡張処理を行わず、 カーネルがはみ出す部分の出力画像の画素には値を書き込みません。(元の値が保持されます) BorderMode.None 以外を指定した場合には、入力画像をはみ出す分だけ拡張した後にフィルタ処理を行います。 この為、本来はカーネルがはみ出す部分の値も擬似的に計算され、結果値が格納されます。


処理対象画像の有効性検査と有効化:

  • 入力画像の有効性検査
    このクラスの CheckValidity(CFviImage) 関数で入力画像の有効性を検査できます。 この関数はスタティックメンバですので、このクラスのインスタンスを生成せずに直接呼び出す事ができます。
  • 入出力画像の整合性検査
    このクラスの IsValid()()()() メソッドで入出力画像の整合性を検査できます。 このメソッドが false を返す場合は、前述の処理対象画像の条件を満たしていない為、 実行できない事を意味します。
  • 出力画像の有効化
    このクラスの Validate(Int32) メソッドで出力画像を有効化する事ができます。 このメソッドを実行すると、出力画像の領域サイズ、画像種別、チャネル数を適切なものに設定します。 領域サイズは、入力画像の処理範囲サイズに合わせられます。

Examples

【入力画像】【出力画像】

C# Copy imageCopy
//    $Revision: 1.3 $

using System;
using System.Collections.Generic;
using System.Text;
using System.Drawing;
using fvalgcli;    // FvPluginXXXX attribute requires fvalgcli

namespace User.SampleCode
{
    public partial class Filter
    {
        // ============================================================
        /// <summary>
        /// 任意カーネルフィルタクラス+フィルタカーネル構造クラス.
        /// </summary>
        [FvPluginExecute]
        public void ArbitraryKernelFilter()
        {
            // 1) インスタンスの準備.
            FVIL.Filter.CFviArbitraryKernelFilter parser = new FVIL.Filter.CFviArbitraryKernelFilter();
            FVIL.Data.CFviImage src = new FVIL.Data.CFviImage();
            FVIL.Data.CFviImage dst = new FVIL.Data.CFviImage();

            // 2) 処理対象画像の取り込み.
            FVIL.File.Function.LoadImageFile(Defs.TestImageDir + "/floppy_UC8.jpg", src, FVIL.PixelMode.Unpacking);

            // 3) 処理対象画像の有効性検査.
            int valid = FVIL.Filter.CFviArbitraryKernelFilter.CheckValidity(src);
            if (valid != FVIL.ErrorCode._SUCCESS)
                throw new FVIL.CFviException(valid, "FVIL.Filter.CFviArbitraryKernelFilter.CheckValidity");

            // 4) 画像処理準備 (共通)
            parser.SrcImages[0] = src;
            parser.DstImages[0] = dst;
            if (!parser.IsValid())    // 有効性検査.
                parser.Validate();    // 有効化.

            // 5-1) パラメータ設定 (固有)
            //    Kernel=FVIL.Filter.CFviFilterKernel    
            //    FVIL.Filter.Preset.Sobel_X5_1
            //    [ 5][ 4][ 0][ -4][ -5]
            //    [ 8][10][ 0][-10][ -8]
            //    [10][20][ 0][-20][-10]
            //    [ 8][10][ 0][-10][ -8]
            //    [ 5][ 4][ 0][ -4][ -5]
#if false
            parser.Kernel.Preset(FVIL.Filter.Preset.Sobel_X5_1);
#else
            parser.Kernel.Resize(5,5);
            FVIL.Filter.CFviFilterKernel k = parser.Kernel;
            k[0, 0] = 5; k[0, 1] = 4; k[0, 2] = 0; k[0, 3] = -4; k[0, 4] = -5;
            k[1, 0] = 8; k[1, 1] = 10; k[1, 2] = 0; k[1, 3] = -10; k[1, 4] = -8;
            k[2, 0] = 10; k[2, 1] = 20; k[2, 2] = 0; k[2, 3] = -20; k[2, 4] = -10;
            k[3, 0] = 8; k[3, 1] = 10; k[3, 2] = 0; k[3, 3] = -10; k[3, 4] = -8;
            k[4, 0] = 5; k[4, 1] = 4; k[4, 2] = 0; k[4, 3] = -4; k[4, 4] = -5;
            k.Denom = 10;
#endif

            // 5-2) パラメータ設定 (継承)
            parser.BorderMode = FVIL.BorderMode.None;

            // 6) 画像処理実行.
            parser.Execute();

            // E) 処理結果画像の保存.
            FVIL.File.Function.SaveImageFile(Defs.ResultDir + "/Filter.ArbitraryKernelFilter.png", dst);
        }
    }
}


Visual Basic Copy imageCopy
'    $Revision: 1.1 $

Imports System.Collections.Generic
Imports System.Text
Imports System.Drawing
Imports fvalgcli
' FvPluginXXXX attribute requires fvalgcli
Namespace SampleCode
    Public Partial Class Filter
        ' ============================================================
        ''' <summary>
        ''' 任意カーネルフィルタクラス+フィルタカーネル構造クラス.
        ''' </summary>
        <FvPluginExecute> _
        Public Sub ArbitraryKernelFilter()
            ' 1) インスタンスの準備.
            Dim parser As New FVIL.Filter.CFviArbitraryKernelFilter()
            Dim src As New FVIL.Data.CFviImage()
            Dim dst As New FVIL.Data.CFviImage()

            ' 2) 処理対象画像の取り込み.
            FVIL.File.[Function].LoadImageFile(Defs.TestImageDir & "/floppy_UC8.jpg", src, FVIL.PixelMode.Unpacking)

            ' 3) 処理対象画像の有効性検査.
            Dim valid As Integer = FVIL.Filter.CFviArbitraryKernelFilter.CheckValidity(src)
            If valid <> FVIL.ErrorCode._SUCCESS Then
                Throw New FVIL.CFviException(valid, "FVIL.Filter.CFviArbitraryKernelFilter.CheckValidity")
            End If

            ' 4) 画像処理準備 (共通)
            parser.SrcImages(0) = src
            parser.DstImages(0) = dst
            If Not parser.IsValid() Then
                ' 有効性検査.
                parser.Validate()
            End If
            ' 有効化.
            ' 5-1) パラメータ設定 (固有)
            '    Kernel=FVIL.Filter.CFviFilterKernel    
            '    FVIL.Filter.Preset.Sobel_X5_1
            '    [ 5][ 4][ 0][ -4][ -5]
            '    [ 8][10][ 0][-10][ -8]
            '    [10][20][ 0][-20][-10]
            '    [ 8][10][ 0][-10][ -8]
            '    [ 5][ 4][ 0][ -4][ -5]
            #If False Then
            parser.Kernel.Preset(FVIL.Filter.Preset.Sobel_X5_1)
            #Else
            parser.Kernel.Resize(5, 5)
            Dim k As FVIL.Filter.CFviFilterKernel = parser.Kernel
            k(0, 0) = 5
            k(0, 1) = 4
            k(0, 2) = 0
            k(0, 3) = -4
            k(0, 4) = -5
            k(1, 0) = 8
            k(1, 1) = 10
            k(1, 2) = 0
            k(1, 3) = -10
            k(1, 4) = -8
            k(2, 0) = 10
            k(2, 1) = 20
            k(2, 2) = 0
            k(2, 3) = -20
            k(2, 4) = -10
            k(3, 0) = 8
            k(3, 1) = 10
            k(3, 2) = 0
            k(3, 3) = -10
            k(3, 4) = -8
            k(4, 0) = 5
            k(4, 1) = 4
            k(4, 2) = 0
            k(4, 3) = -4
            k(4, 4) = -5
            k.Denom = 10
            #End If

            ' 5-2) パラメータ設定 (継承)
            parser.BorderMode = FVIL.BorderMode.None

            ' 6) 画像処理実行.
            parser.Execute()

            ' E) 処理結果画像の保存.
            FVIL.File.[Function].SaveImageFile(Defs.ResultDir & "/Filter.ArbitraryKernelFilter.png", dst)
        End Sub
    End Class
End Namespace

Inheritance Hierarchy

System..::..Object
FVIL..::..CFviObject
FVIL..::..CFviImageParser
FVIL.Filter..::..CFviFilter
FVIL.Filter..::..CFviArbitraryKernelFilter

See Also