平均化フィルタクラス

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

Syntax

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

Remarks

マルチコア対応:

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

画像データの平均化を行うクラスです。

次のようなマトリックスによる3×3の線形フィルタを施します。
-------------
| 1 | 1 | 1 |
-------------
| 1 | 1 | 1 |
-------------
| 1 | 1 | 1 |
-------------
(div : 9)
割り切れない場合は小数点以下を切捨てます。（DOUBLEを除く）

ボーダーモード BorderMode により出力結果がかわります。 ボーダーモードが BorderMode.None の時、出力画像の周囲１画素は処理されません。 ボーダーモードが BorderMode.None 以外の時、入力画像を指定のモードでボーダー拡張しフィルタ処理を施します。 この時、出力画像の領域全面でフィルタ処理結果が得られます。 ボーダー拡張の詳細な仕様は BorderMode を参照して下さい。

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

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

初期値と範囲:
プロパティ初期値範囲説明
BorderModeBorderMode.NoneBorderMode に定義された定数ボーダー処理モード
BorderValue0(任意) ボーダー値
(BorderMode が Value の場合に使用します。)

ボーダー処理について:

画像の周囲画素において、指定されたカーネルがはみ出す部分は、正しく値を求める事が出来ません。 しかし、基本クラス(CFviFilter)の ボーダーモード(BorderMode)と ボーダー濃度値(BorderValue)を使用し、 入力画像を拡張する事で、擬似的に周囲１画素の結果値も出力できるようになっています。 BorderMode に BorderMode.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 AverageFilter()
        {
            // 1) インスタンスの準備.
            FVIL.Filter.CFviAverageFilter parser = new FVIL.Filter.CFviAverageFilter();
            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.CFviAverageFilter.CheckValidity(src);
            if (valid != FVIL.ErrorCode._SUCCESS)
                throw new FVIL.CFviException(valid, "FVIL.Filter.CFviAverageFilter.CheckValidity");

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

            // 5-1) パラメータ設定 (固有)

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

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

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

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

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

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

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

Inheritance Hierarchy

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

See Also