Filter Library

Camera

Interface Physics

ScanFilterLowPass.h

/*
 * ScanFilterLowPass.h - low-pass filter (frequency domain).
 *
 * This file is part of the Camera Filter Library.
 * Computer Aided Measurement Environment for Realtime Atomic imaging (Camera)
 *
 * Copyright (C) 2004-2005, Leiden Probe Microscopy.
 * Copyright (C) 2004-2005, Universiteit Leiden.
 *
 * Authors: M. Seynen (original), Martin J. Moene
 *
 * $Id: ScanFilterLowPass.h 242 2005-06-29 07:57:25Z moene $
 */

#ifndef CFL_SCANFILTERLOWPASS_H
#define CFL_SCANFILTERLOWPASS_H

#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000

#include <cfl/ScanFilter.h>             // for base class
#include <cfl/ScanBaseBuffer.h>         // for ValueType
#include <cfl/ScanFilterFourierBase.h>  // for base class
#include <cfl/ProgressDlg.h>            // for class CProgressDlg

/**
 * \addtogroup cfl_filterlowpass Low-pass Filter (Frequency Domain)
 * \brief low-pass filter (frequency domain).
 *

<h3>Purpose</h3>

<h3>Description</h3>

<h3>Algorithm</h3>


\f[
   \textrm{B} = \textrm{A}
\f]

<h3>Examples</h3>
Try to find some interesting pictures for most filters.

<h3>Contact</h3>
Dipl.phys. M.J. Rost<br>
Huygens Laboratorium<br>
Universiteit Leiden<br>
Niels Bohrweg 2<br>
2333 CA Leiden, The Netherlands<br>
<br>
Tel: +31 71 5275600<br>
Fax: +31 71 5275404<br>
<br>
E-mail: rost@physics.LeidenUniv.nl<br>
Web: http://www.geocities.com/marcel_rost/<br>

 *
 * @{
 */

DECLARE_CLASS( CScanFilterLowPass );         // create various types

/**
 * \brief FFT lowpass filter.
 *
 */
class CScanFilterLowPass : public CScanFilterFourierBase
{
   friend class CFilterDlg_LowPass;

public:
   /**
    * the parent class.
    */
   typedef CScanFilterFourierBase Super;

   /**
    * the size type.
    */
   typedef CScanBaseBuffer::SizeType SizeType;

   /**
    * the real type.
    */
   typedef CScanFilterFourierBase::RealType RealType;

   /**
    * the Fourier element type.
    */
   typedef CScanBaseBuffer::FourierElementType FourierElementType;

   ///
   /// \name Construction
   /// @{

   /**
    * default constructor.
    */
   CScanFilterLowPass();

   /**
    * destructor.
    */
   virtual ~CScanFilterLowPass();

   /// @}
   /// \name Camera--Filter Interface
   /// @{

   /**
    * \brief configure filter with settings as provided by the application on the
    * filterlist window (e.g. via registry); see also CScanFilterNull::ReadFilterSettings().
    */
   virtual void ReadFilterSettings( );

   /**
    * \brief save filter settings e.g. for use with the filterlist window (e.g. via registry);
    * see also ReadFilterSettings().
    */
   virtual void WriteFilterSettings( ) const;

   /**
    * provide current filter parameter(s) for filter-scripting capture
    * in the main application;
    * see also CScanFilterNull::GetParameters().
    */
   virtual LPCTSTR GetParameters() const;

   /**
    * set parameters for filter-script execution of filter;
    * see also CScanFilterNull::SetParameters().
    */
   virtual BOOL SetParameters( LPCTSTR lpParameters );

   /**
    * start filter dialog to edit parameters; no filter operations;
    * see also CScanFilterNull::EditModeless().
    */
//   virtual BOOL EditModeless( CWnd *pParentWnd );

   /**
    * create filter dialog and prepare filter for Apply();
    * see also CScanFilterNull::RunModeless().
    */
   virtual BOOL RunModeless( CWnd *pParentWnd, CDocument *pDoc );

   /**
    * check parameters, take care of a properly sized output buffer,
    * set its name and copy filter parameters and process;
    * see also CScanFilterNull::ApplyCore().
    */
   virtual BOOL Apply();

   /// @}
   /// \name Predicates
   /// @{

   /// @}
   /// \name Accessors
   /// @{

   /**
    * the cut off.
    */
   double GetCutOff() const;

   /**
    * the soft edge.
    */
   double GetSoftEdge() const;

   /// @}
   /// \name Mutators
   /// @{

   /**
    * set the cut off.
    */
   void SetCutOff( double cutOff );

   /**
    * set the soft edge.
    */
   void SetSoftEdge( double softEdge );

   /// @}

protected:
   /**
    * store or retrieve the object's settings.
    */
   virtual void Serialize( CArchive& ar );
   DECLARE_SERIAL( CScanFilterLowPass )

   /**
    * create a thread that computes the result.
    */
   static UINT ComputationThreadFunction( LPVOID lpContext );

   /**
    * called by working thread.
    */
   BOOL Compute( CProgressDlg *pDlg );

   /**
    * compute a frame.
    */
   void ComputePart( FourierElementType** in, FourierElementType** out );

public:
   /**
    * the filter name.
    */
   static LPCTSTR m_lpcsFilterName;

   /**
    * the class short filtername.
    */
   static LPCTSTR m_lpcsShortFilterName;

   /**
    * the default cut-off value.
    */
   static const RealType def_dCutOff;

   /**
    * the default new Y-size.
    */
   static const RealType def_dSoftEdge;

private:

   /**
    * the cut-off.
    */
   RealType m_dCutOff;

   /**
    * the soft edge.
    */
   RealType m_dSoftEdge;

   /**
    * the computation thread arguments type.
    */
   class ThreadArgs
   {
   public:
      /**
       * constructor
       */
      ThreadArgs( CProgressDlg* Dlg, CScanFilterLowPass* This ) :
         pDlg( Dlg ), pThis( This ), bReturn( 0 )
      {
         ; // do nothing
      }

      BOOL bReturn;                     ///< the thread return value
      CProgressDlg *pDlg;               ///< the progress dialog
      CScanFilterLowPass *pThis;        ///< the filter
   };
};

///@} cfl_filterlowpass

/**
 * the cut off.
 */

inline CScanFilterLowPass::RealType CScanFilterLowPass::GetCutOff() const
{
   return m_dCutOff;
}

/**
 * the soft edge.
 */
inline CScanFilterLowPass::RealType CScanFilterLowPass::GetSoftEdge() const
{
   return m_dSoftEdge;
}

/**
 * set the cut off.
 */
inline void CScanFilterLowPass::SetCutOff( RealType cutOff )
{
   m_dCutOff = cutOff;
}

/**
 * set the soft edge.
 */
inline void CScanFilterLowPass::SetSoftEdge( RealType softEdge )
{
   m_dSoftEdge = softEdge;
}

#endif // CFL_SCANFILTERLOWPASS_H

/*
 * end of file
 */

---