Filter Library

Camera

Interface Physics

ScanFilterClad.h

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

#ifndef CFL_SCANFILTERCLAD_H
#define CFL_SCANFILTERCLAD_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_filterclad Clad Filter
 * \brief clad filter.
 *

<h3>Purpose</h3>

Enlarge the image's area.

<h3>Description</h3>

The clad filter enables you to enlarge the area of an image.

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

/**
 * \brief clad filter.
 *
 */
class CScanFilterClad : public CScanFilter
{
   /**
    * its dialog class.
    */
   friend class CFilterDlg_Clad;

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

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

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

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

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

   /**
    * destructor.
    */
   ~CScanFilterClad();
   
   /// @}
   /// \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 supported dragmethod(s).
    */
   DragSupportType SupportDragInput() const;

   /**
    * apply the filter to the selected area.
    */
   void SetDragInput( BOOL bL2R, CRect rcIn );

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

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

   /**
    * the current size.
    */
   SizeType GetSize() const;

   /**
    * the current width.
    */
   SizeElementType GetWidth() const;

   /**
    * the current height.
    */
   SizeElementType GetHeight() const;

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

   /**
    * set the width.
    */
   void SetWidth( SizeElementType size );

   /**
    * set the height.
    */
   void SetHeight( SizeElementType size );

   /// @}

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

   /**
    * process the given frame part (L2R, R2L frame part).
    */
   void Clad( BOOL bDoR2L );

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

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

   /**
    * the default new X-size.
    */
   static const SizeElementType def_nWidth;

   /**
    * the default new Y-size.
    */
   static const SizeElementType def_nHeight;

protected:
   /**
    * the new size.
    */
   CSize m_cSize;
};

/// @} cfl_filterclad

/**
 * the current width.
 */
inline CScanFilterClad::SizeType CScanFilterClad::GetSize() const
{
   return m_cSize;
}

/**
 * the current width.
 */
inline CScanFilterClad::SizeElementType CScanFilterClad::GetWidth() const
{
   return m_cSize.cx;
}

/**
 * the current height.
 */
inline CScanFilterClad::SizeElementType CScanFilterClad::GetHeight() const
{
   return m_cSize.cy;
}

/**
 * set the width.
 */
inline void CScanFilterClad::SetWidth( SizeElementType size )
{
   m_cSize.cx = size;
}

/**
 * set the height.
 */
inline void CScanFilterClad::SetHeight( SizeElementType size )
{
   m_cSize.cy = size;
}

#endif // CFL_SCANFILTERCLAD_H

/*
 * end of file
 */

---