Filter Library

Camera

Interface Physics

ScanFilterShift.h

/*
 * CScanFilterShift.h - shift 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: ScanFilterShift.h 350 2006-03-02 08:18:37Z moene $
 */

#ifndef CFL_SCANFILTERSHIFT_H
#define CFL_SCANFILTERSHIFT_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_filtershift Shift Filter
 * \brief shift filter.
 *

<h3>Purpose</h3>

Shift the image within an area.

<h3>Description</h3>

The shift filter enables you to shift the image within the its area.

<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( CScanFilterShift );   // declare various types for class

/**
 * \brief shift filter.
 *
 */
class CScanFilterShift : public CScanFilter
{
   /**
    * its dialog class.
    */
   friend class CFilterDlg_Shift;

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

   /**
    * the point type.
    */
   typedef CPoint DiffType;

   /**
    * the point element type.
    */
   typedef int DiffElementType;

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

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

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

   /// @}
   /// \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).
    */
   virtual DragSupportType SupportDragInput() const;

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

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

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

   /**
    * the current shift.
    */
   DiffType GetShift() const;

   /**
    * the current x-shift.
    */
   DiffElementType GetShiftX() const;

   /**
    * the current y-shift.
    */
   DiffElementType GetShiftY() const;

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

   /**
    * set the x-shift.
    */
   void SetShiftX( DiffElementType x );

   /**
    * set the x-shift.
    */
   void SetShiftY( DiffElementType y );

   /// @}

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

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

   /**
    * the default new X-size.
    */
   static const DiffElementType def_nShiftX;

   /**
    * the default new Y-size.
    */
   static const DiffElementType def_nShiftY;

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

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

protected:
   /**
    * the shift.
    */
   DiffType m_cpShift;
};

/// @} cfl_filtershift

/**
 * the current shift.
 */
inline CScanFilterShift::DiffType CScanFilterShift::GetShift() const
{
   return m_cpShift;
}

/*
 * the current x-location.
 */
inline CScanFilterShift::DiffElementType CScanFilterShift::GetShiftX() const
{
   return m_cpShift.x;
}

/*
 * the current y-location.
 */
inline CScanFilterShift::DiffElementType CScanFilterShift::GetShiftY() const
{
   return m_cpShift.y;
}

/*
 * set the x-location.
 */
inline void CScanFilterShift::SetShiftX( DiffElementType dx )
{
   m_cpShift.x = dx;
}

/*
 * set the x-location.
 */
inline void CScanFilterShift::SetShiftY( DiffElementType dy )
{
   m_cpShift.y = dy;
}

#endif // CFL_SCANFILTERSHIFT_H

/*
 * end of file
 */

---