Filter Library Camera Interface Physics

CScanFilterBGS_Planar Class Reference
[Background Subtraction Filter (Plane)Background Subtraction Filter (Plane)]

#include <ScanFilterBGS_Manual.h>

Inheritance diagram for CScanFilterBGS_Planar:

CScanFilter CScanFilter List of all members.

Detailed Description

This is the class for the ... Filter.

Author:
J.W.M. Frenken

M.J. Rost

Definition at line 91 of file ScanFilterBGS_Manual.h.

Public Types

enum  eSubtractPolicy {
  spSeparate, spLeftToRight, spRightToLeft, spSeparate,
  spLeftToRight, spRightToLeft
}
 plane subtract policy More...
enum  eSubtractPolicy {
  spSeparate, spLeftToRight, spRightToLeft, spSeparate,
  spLeftToRight, spRightToLeft
}
 plane subtract policy More...
typedef CScanBaseBuffer::ValueType ValueType
 the scan base buffer datatype.
typedef CScanBaseBuffer::ValueType ValueType
 the scan base buffer datatype.

Public Member Functions

Camera--Filter Interface
virtual void ReadFilterSettings ()
 configure filter with settings as provided by the application on the filterlist window (e.g.
virtual void WriteFilterSettings () const
 save filter settings e.g.
virtual LPCTSTR GetParameters () const
 provide current filter parameter(s) for filter-scripting capture in the main application; see also CScanFilterNull::GetParameters().
virtual BOOL SetParameters (LPCTSTR lpParameters)
 set parameters for filter-script execution of filter; see also CScanFilterNull::SetParameters().
virtual DragSupportType SupportDragInput () const
 the supported dragmethod(s).
virtual void SetDragInput (BOOL bL2R, CRect rcIn)
 apply the filter to the selected area.
virtual BOOL EditModeless (CWnd *pParentWnd)
 start filter dialog to edit parameters; no filter operations; see also CScanFilterNull::EditModeless().
virtual BOOL RunModeless (CWnd *pParentWnd, CDocument *pDoc)
 create filter dialog and pre Apply() filter to view result; see also CScanFilterNull::RunModeless().
virtual BOOL Apply ()
 let ApplyCore() perform the filter processing; catch MFC and std exceptions; see also CScanFilterNull::Apply().
virtual BOOL ApplyCore ()
 check parameters, take care of a properly sized output buffer, set its name and copy filter parameters and process; see also CScanFilterNull::ApplyCore().
Accessors
eSubtractPolicy SubtractPolicy () const
 set the subtract policy: separate for each part, or using left-to-right plane, or right-to-left plane.
Mutators
void SubtractPolicy (eSubtractPolicy p)
 the curent subtract policy: separate for each part, or using left-to-right plane, or right-to-left plane.
Camera--Filter Interface
virtual void ReadFilterSettings ()
 configure filter with settings as provided by the application on the filterlist window (e.g.
virtual void WriteFilterSettings () const
 save filter settings e.g.
virtual LPCTSTR GetParameters () const
 provide current filter parameter(s) for filter-scripting capture in the main application; see also CScanFilterNull::GetParameters().
virtual BOOL SetParameters (LPCTSTR lpParameters)
 set parameters for filter-script execution of filter; see also CScanFilterNull::SetParameters().
virtual DragSupportType SupportDragInput () const
 the supported dragmethod(s).
virtual void SetDragInput (BOOL bL2R, CRect rcIn)
 apply the filter to the selected area.
virtual BOOL EditModeless (CWnd *pParentWnd)
 start filter dialog to edit parameters; no filter operations; see also CScanFilterNull::EditModeless().
virtual BOOL RunModeless (CWnd *pParentWnd, CDocument *pDoc)
 create filter dialog and pre Apply() filter to view result; see also CScanFilterNull::RunModeless().
virtual BOOL Apply ()
 let ApplyCore() perform the filter processing; catch MFC and std exceptions; see also CScanFilterNull::Apply().
virtual BOOL ApplyCore ()
 check parameters, take care of a properly sized output buffer, set its name and copy filter parameters and process; see also CScanFilterNull::ApplyCore().
Accessors
eSubtractPolicy SubtractPolicy () const
 the current subtract policy: separate for each part, or using left-to-right plane, or right-to-left plane.
Mutators
void SubtractPolicy (eSubtractPolicy p)
 set the subtract policy: separate for each part, or using left-to-right plane, or right-to-left plane.

Static Public Attributes

static LPCTSTR m_lpcsFilterName
 the filter name.
static LPCTSTR m_lpcsShortFilterName
 the class short filtername.

Protected Member Functions

virtual void Serialize (CArchive &ar)
 store or retrieve the object's settings; see also CScanFilterNull::Serialize().
void CalculatePlanes ()
 calculate the plane(s) for both parts or for the selected area.
double SumOfArea ()
 the image's selected area amplitude sum: expected to be zero.
SPerformanceTestResult GetPerformanceTestResult ()
 measure algorithm performance.
virtual void Serialize (CArchive &ar)
 store or retrieve the object's settings; see also CScanFilterNull::Serialize().
void CalculatePlanes ()
 calculate the plane(s) for both parts or for the selected area.
double SumOfArea ()
 the image's selected area amplitude sum: expected to be zero.
SPerformanceTestResult GetPerformanceTestResult ()
 measure algorithm performance.

Protected Attributes

eSubtractPolicy m_eSubtractPolicy
 subtract policy.
CRect m_rcSourceRect
 the user specified area to work on.
CRect m_rcSourceArea
 the effectively used selected area to work on.
cil::LinearRegressionParameters m_parametersL2R
 linear regression parameters A, B and C for Left--Right.
cil::LinearRegressionParameters m_parametersR2L
 linear regression parameters A, B and C for Right--Left.
eSubtractPolicy m_subtractPolicy
 subtract policy.

Friends

class CFilterDlg_BGS_Planar
 its dialog class.


Member Enumeration Documentation

enum CScanFilterBGS_Planar::eSubtractPolicy

Enumerator:
spSeparate  use a separate plane for each image part
spLeftToRight  use the L2R plane for both parts
spRightToLeft  use the R2L plane for both parts
spSeparate  use a separate plane for each image part
spLeftToRight  use the L2R plane for both parts
spRightToLeft  use the R2L plane for both parts

Definition at line 103 of file ScanFilterBGS_Manual.h.

enum CScanFilterBGS_Planar::eSubtractPolicy

Enumerator:
spSeparate  use a separate plane for each image part
spLeftToRight  use the L2R plane for both parts
spRightToLeft  use the R2L plane for both parts
spSeparate  use a separate plane for each image part
spLeftToRight  use the L2R plane for both parts
spRightToLeft  use the R2L plane for both parts

Definition at line 103 of file ScanFilterBGS_Planar.h.


Member Function Documentation

void CScanFilterBGS_Planar::ReadFilterSettings (  )  [virtual]

via registry); see also CScanFilterNull::ReadFilterSettings().

Reimplemented from CScanFilter.

Definition at line 109 of file ScanFilterBGS_Manual.cpp.

References gCflRegistrySubkey, m_lpcsFilterName, Q_INVALID, and SetParameters().

void CScanFilterBGS_Planar::WriteFilterSettings (  )  const [virtual]

for use with the filterlist window (e.g. via registry); see also ReadFilterSettings().

Reimplemented from CScanFilter.

Definition at line 128 of file ScanFilterBGS_Manual.cpp.

References gCflRegistrySubkey, GetParameters(), m_lpcsFilterName, and Q_INVALID.

virtual void CScanFilterBGS_Planar::ReadFilterSettings (  )  [virtual]

via registry); see also CScanFilterNull::ReadFilterSettings().

Reimplemented from CScanFilter.

virtual void CScanFilterBGS_Planar::WriteFilterSettings (  )  const [virtual]

for use with the filterlist window (e.g. via registry); see also ReadFilterSettings().

Reimplemented from CScanFilter.


The documentation for this class was generated from the following files:
Camera Filter Library documentation © 2004-2007 by Leiden Probe Microscopy