ソーベルフィルタクラス

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

Syntax

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

Remarks

マルチコア対応:

このクラスの Execute()()()() メソッドは、 SetParallelNum(Int32) によって設定されたスレッド数に従って、 自動的に処理を並列化します。 マルチコア環境においては、処理を並列化する事によりレーテンシを短縮できる場合があります。 詳しくは、 SetParallelNum(Int32) の説明をご参照ください。

画像データにソーベルフィルタを施すクラスです。
3x3のソーベル微分フィルタを入力画像に適用し、出力画像に結果を出力します。 CalcMode の指定によって、実行するフィルタの演算は下記の様に変化します。

要求する入出力画像数:
項目数定数
入力画像1SrcImageCount フィールド
出力画像1DstImageCount フィールド
処理対象画像の条件

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

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

但し、入力画像が ImageType.UC8の時は、 出力画像の型は ImageType.UC8 と ImageType.S16 が許容されます。
初期値と範囲:
プロパティ初期値範囲説明
CalcModeSobelCalcMode.XModeSobelCalcMode に定義された定数ソーベル計算モード
BorderModeBorderMode.NoneBorderMode に定義された定数ボーダー処理モード
BorderValue0(任意) ボーダー値
(BorderMode が Value の場合に使用します。)

ボーダー処理について:

画像の周囲１画素については、3x3 のカーネルがはみ出すため、正しくは値を求める事が出来ません。 しかし、ボーダー処理の設定を行い入力画像を拡張することで、 擬似的に周囲１画素の結果値も出力できるようになっています。
これは、 及び BorderValue により制御されます。
BorderMode に None を指定した場合は、 この拡張処理を行わず、 出力画像の周囲１画素には値を書き込みません（元の値が保持されます）。
BorderMode に None 以外を指定した場合は、 処理前に ボーダー処理を行い、入力画像を縁の分だけ拡張した後にフィルタ処理を行います。 このため、周囲１画素の値も擬似的に計算され、結果値が格納されます。
ボーダー拡張の詳細な仕様は BorderMode を参照して下さい。

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

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

関連する FIE 関数：

fnFIE_sobel

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 SobelFilter()
        {
            // 1) インスタンスの準備.
            FVIL.Filter.CFviSobelFilter parser = new FVIL.Filter.CFviSobelFilter();
            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.CFviSobelFilter.CheckValidity(src);
            if (valid != FVIL.ErrorCode._SUCCESS)
                throw new FVIL.CFviException(valid, "FVIL.Filter.CFviSobelFilter.CheckValidity");

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

            // 5-1) パラメータ設定 (固有)
            parser.CalcMode = FVIL.Filter.SobelCalcMode.XYMode;

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

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

            // E) 処理結果画像の保存.
            FVIL.File.Function.SaveImageFile(Defs.ResultDir + "/Filter.SobelFilter.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 SobelFilter()
            ' 1) インスタンスの準備.
            Dim parser As New FVIL.Filter.CFviSobelFilter()
            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.CFviSobelFilter.CheckValidity(src)
            If valid <> FVIL.ErrorCode._SUCCESS Then
                Throw New FVIL.CFviException(valid, "FVIL.Filter.CFviSobelFilter.CheckValidity")
            End If

            ' 4) 画像処理準備 (共通)
            parser.SrcImages(0) = src
            parser.DstImages(0) = dst
            If Not parser.IsValid() Then
                ' 有効性検査.
                parser.Validate()
            End If
            ' 有効化.
            ' 5-1) パラメータ設定 (固有)
            parser.CalcMode = FVIL.Filter.SobelCalcMode.XYMode

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

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

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

Inheritance Hierarchy

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

See Also