Filter Library

Camera

Interface Physics

ScanFilterMean.h

/*
 * ScanFilterMean.h - mean image filter.
 *
 * 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: ScanFilterMean.h 363 2006-03-09 13:21:27Z moene $
 */

#ifndef CFL_SCANFILTERMEAN_H
#define CFL_SCANFILTERMEAN_H

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

#include <cfl/ScanFilterRank.h>         // for base class

/**
 * \addtogroup cfl_filtermean Mean Filter
 * \brief mean filter.
 *

<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( CScanFilterMean );         // create various types

/**
 * \brief mean filter.
 *
 */
class CScanFilterMean : public CScanFilterRank
{
   /**
    * its dialog class.
    */
   friend class CFilterDlg_Mean;

public:
   ///
   /// \name Construction
   /// @{

   /**
    * default constructor: setup filter to run without dialog;
    * see also CScanFilterNull::CScanFilterNull().
    */
   CScanFilterMean();

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

   /**
    * create filter dialog and pre Apply() filter to view result;
    * 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::Apply().
    */
   virtual BOOL Apply();

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

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

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

   /// @}

protected:
   /**
    * store or retrieve the object's settings; see also CScanFilterNull::Serialize().
    */
//   virtual void Serialize(CArchive& ar); // provided by base class 
   DECLARE_SERIAL(CScanFilterMean)

   /**
    * the filter name.
    */
   virtual const char* GetFilterName() const
   {
      return m_lpcsFilterName;
   }

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

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

/// @} cfl_filtermean

#endif // CFL_SCANFILTERMEAN_H

/*
 * end of file
 */

---