Filter Library Camera Interface Physics

CScanFilterNCCFFT Class Reference
[Fast Normalized Cross-Correlation Filter]

#include <ScanFilterNCCFFT.h>

Inheritance diagram for CScanFilterNCCFFT:

CScanFilter List of all members.

Detailed Description

Definition at line 67 of file ScanFilterNCCFFT.h.

Public Types

enum  SubtractionType { bgNone, bgMean, bgBackground, bgDimension_ }
 normalization type. More...
enum  NormalizationType { nmNone, nmNormal, nmPhase, nmDimension_ }
 normalization type. More...
enum  NormalizationSubType { nsZeroMean, nsEnergy, nsPlanar, nsDimension_ }
 normalization sub-type. More...
typedef CScanBaseBuffer::ValueType ValueType
 the value type.
typedef ValueType InputPixelType
 the input pixel type.
typedef ValueType OutputPixelType
 the output pixel type.
typedef double ScaleType
 the scale type.

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 BOOL RunModeless (CWnd *pParentWnd, CDocument *pDoc)
 create filter dialog and pre Apply() filter to view result; see also CScanFilterNull::RunModeless().
virtual BOOL Apply ()
 check parameters, take care of a properly sized output buffer, set its name and copy filter parameters and process; see also CScanFilterNull::Apply().
virtual DWORD GetNrOfInBuffers () const
 the number of input buffers is 2.
virtual CScanBaseBufferGetInputBuffer (UINT nNr)
 the requested input buffer.
virtual void SetInputBuffer (UINT nNr, CScanBaseBuffer *lpsbIn)
 set the given input buffer.
Predicates
bool DoRelaxFFTSize () const
 true if the FFT size has been relaxed (allow overlap).
Accessors
SubtractionType GetSubtractionType () const
 the normalization type.
NormalizationType GetNormalizationType () const
 the normalization type.
NormalizationSubType GetNormalizationSubType () const
 the normalization sub-type.
ScaleType GetScale (NormalizationType type) const
 the scale factor.
Mutators
void SetSubtractionType (SubtractionType subtract)
 set the subtraction type.
void SetNormalizationType (NormalizationType norm)
 set the normalization type.
void SetNormalizationSubType (NormalizationSubType normsub)
 set the normalization sub-type.
void SetRelaxFFTSize (bool relax_fft_size)
 relax the FFT image size and allow overlap in the transformation.
void SetScale (NormalizationType type, ScaleType scale)
 set the scale factor.

Static Public Attributes

static LPCTSTR m_lpcsFilterName
 the filter name.
static LPCTSTR m_lpcsShortFilterName
 the class short filtername.
static const ScaleType m_defScale
 the default scale factor.

Protected Member Functions

virtual void Serialize (CArchive &ar)
 store or retrieve the object's settings; see also CScanFilterNull::Serialize().

Protected Attributes

CScanBaseBufferm_lpsbIn2
 the second input buffer.
SubtractionType m_subtract
 the normalization type.
NormalizationType m_norm
 the normalization type.
NormalizationSubType m_normsub
 the normalization sub-type.
bool m_relax_fft_size
 use minimal FFT size.
ScaleType m_scale [nmDimension_]
 the scale factors (one for each normalization type).

Friends

class CFilterDlg_NCCFFT
 its dialog class.


Member Enumeration Documentation

enum CScanFilterNCCFFT::SubtractionType

Enumerator:
bgNone  none
bgMean  normal
bgBackground  linear regression, planar background
bgDimension_  the number of entries

Definition at line 93 of file ScanFilterNCCFFT.h.

enum CScanFilterNCCFFT::NormalizationType

Enumerator:
nmNone  none
nmNormal  normal
nmPhase  phase
nmDimension_  the number of entries

Definition at line 104 of file ScanFilterNCCFFT.h.

enum CScanFilterNCCFFT::NormalizationSubType

Enumerator:
nsZeroMean  zero-mean
nsEnergy  energy
nsPlanar  planer bg subtr for image-under-template
nsDimension_  the number of entries

Definition at line 115 of file ScanFilterNCCFFT.h.


Member Function Documentation

void CScanFilterNCCFFT::ReadFilterSettings (  )  [virtual]

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

Reimplemented from CScanFilter.

Definition at line 135 of file ScanFilterNCCFFT.cpp.

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

void CScanFilterNCCFFT::WriteFilterSettings (  )  const [virtual]

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

Reimplemented from CScanFilter.

Definition at line 154 of file ScanFilterNCCFFT.cpp.

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


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