Filter Library

Camera

Interface Physics

ScanFilterMath.h

/*
 * ScanFilterMath.h - math 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: ScanFilterMath.h 270 2005-10-19 15:00:48Z moene $
 */

#ifndef CFL_SCANFILTERMATH_H
#define CFL_SCANFILTERMATH_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_filtermath Math Filter
 * \brief add or subtract buffers.
 *

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

/**
 * \brief add or subtract buffers.
 *
 */
class CScanFilterMath : public CScanFilter
{
   /**
    * its dialog class.
    */
   friend class FilterDlg_Math;

public:
   /**
    * the value type.
    */
   typedef CScanBaseBuffer::ValueType ValueType;

   /**
    * the pointer type.
    */
   typedef ValueType* Pointer;

   /**
    * the const pointer type.
    */
   typedef const ValueType* ConstPointer;

   /**
    * the size type.
    */
   typedef CSize SizeType;

   /**
    * the size element type.
    */
   typedef DWORD SizeElementType;

   /**
    * math types to perform.
    */
   enum MathOperationType
   {
      MATH_ADD,         ///< A + B
      MATH_SUBAB,       ///< A - B
      MATH_SUBBA,       ///< B - A
      MATH_MUL,         ///< A * B
   };

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

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

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

   /// @}
   /// \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();

   /**
    * the number of input buffers is 2.
    */
   virtual DWORD GetNrOfInBuffers() const;

   /**
    * the requested input buffer.
    */
   virtual CScanBaseBuffer* GetInputBuffer( UINT nNr );

   /**
    * set the given input buffer.
    */
   virtual void SetInputBuffer( UINT nNr, CScanBaseBuffer *lpsbIn );

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

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

   MathOperationType GetMathOperation() const;

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

   void SetMathOperation( MathOperationType );

   /// @}

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

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

   /**
    * the default offset.
    */
   static const MathOperationType def_MathOperation;

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

   /**
    * process the given frame part (L2R, R2L frame part).
    */
   void Process( ConstPointer in1, ConstPointer end1, ConstPointer in2, Pointer out );

protected:
   /**
    * the second input buffer.
    */
   CScanBaseBuffer *m_lpsbIn2;

   /**
    * current math setting.
    */
   MathOperationType m_MathOperation;
};

/// @}  cfl_filtermath

/**
 * the current offset.
 */
inline CScanFilterMath::MathOperationType CScanFilterMath::GetMathOperation() const
{
   return m_MathOperation;
}

/**
 * set the offset.
 */
inline void CScanFilterMath::SetMathOperation( MathOperationType op )
{
   m_MathOperation = op;
}

#endif // CFL_SCANFILTERMATH_H

/*
 * end of file
 */

---