Filter Library

Camera

Interface Physics

ScanFilterTest.h

/*
 * ScanFilterTest.h -
 *
 * 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: ScanFilterTest.h 236 2005-06-27 09:03:17Z moene $
 */

#ifndef CFL_SCANFILTERTEST_H
#define CFL_SCANFILTERTEST_H

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

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

/**
 * \addtogroup cfl_filtertest Test Filter
 * \brief test filter.
 *

<h3>Purpose</h3>

Generate test patterns or copy or negate input buffer.

<h3>Description</h3>

This filter lets you create several data patterns.

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

/**
 * \brief test filter.
 *
 */
class CScanFilterTest : public CScanFilter
{
   /**
    * its dialog class.
    */
   friend class CFilterDlg_Test;

public:
   /**
    * the various test patterns.
    */
   enum ModeType
   {
      MODE_SIN,         ///< create sine pattern
      MODE_SAW,         ///< create saw pattern
      MODE_RAMP,        ///< create ramp pattern
      MODE_ZERO,        ///< empty buffer
      MODE_NEG,         ///< negate input buffer
      MODE_COPY,        ///< copy input buffer
      MODE_BOX,         ///< create box pattern
      MODE_RIPPLE,      ///< create ripple pattern
      MODE_NOISE        ///< create noise pattern
   };

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

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

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

   /**
    * can do partial data (in this case meaning?).
    */
   virtual BOOL CanDoPartialData() const { return TRUE; };

   /// @}
   /// \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 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::ApplyCore().
    */
   virtual BOOL Apply();

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

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

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

protected:
   /**
    * the left to right mode.
    */
   ModeType m_eModeL2R;

   /**
    * the right to left mode.
    */
   ModeType m_eModeR2L;
};

// @} cfl_filtertest

#endif // CFL_SCANFILTERTEST_H

/*
 * end of file
 */

---