Filter Library

Camera

Interface Physics

ScanFilterThreshold.h

/*
 * ScanFilterThreshold.h - threshold 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: Martin J. Moene
 *
 * $Id: ScanFilterThreshold.h 356 2006-03-06 10:46:16Z moene $
 */

#ifndef CFL_SCANFILTERTHRESHOLD_H
#define CFL_SCANFILTERTHRESHOLD_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_filtermean Boxcar 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( CScanFilterThreshold );         // create various types

/**
 * \brief mean filter.
 *
 */
class CScanFilterThreshold : public CScanFilter
{
   /**
    * its dialog class.
    */
   friend class CFilterDlg_Threshold;

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

   /**
    * the input pixel type.
    */
   typedef ValueType InputPixelType;

   /**
    * the output pixel type.
    */
   typedef ValueType OutputPixelType;

   /**
    * threshold mode.
    */
   enum ThresholdMode
   {
      tmBelow,                  ///< threshold below
      tmAbove,                  ///< threshold above
      tmOutside,                ///< threshold outside
   };

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

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

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

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

//    /**
//     * no partial data.
//     */
//   virtual BOOL CanDoPartialData() const;
// 
//    /**
//     * has dialog (default true).
//     */
//    virtual BOOL CanDoDialogEntry() const;

   /**
    * \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 );

//    /**
//     * the supported dragmethod(s).
//     */
//    virtual DragSupportType SupportDragInput() const;
//
//    /**
//     * apply the filter to the selected area.
//     */
//    virtual void SetDragInput( BOOL bL2R, CRect rcIn );
//
//    /**
//     * 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::Apply().
    */
   virtual BOOL Apply();

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

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

   /**
    * number of columns in image.
    */
   int Columns() const
   {
      return m_lpsbIn->Columns();
   }

   /*
    * number of columns in image.
    */
   int Rows() const
   {
      return m_lpsbIn->Rows();
   }

   /**
    * the threshold mode.
    */
   ThresholdMode GetThresholdMode() const
   {
      return m_mode;
   }

   /**
    * the lower threshold value.
    */
   InputPixelType GetLowerThreshold() const
   {
      return m_lower;
   }

   /**
    * the upper threshold value.
    */
   InputPixelType GetUpperThreshold() const
   {
      return m_upper;
   }

   /**
    * the outside value.
    */
   OutputPixelType GetOutsideValue() const
   {
      return m_outside;
   }

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

   /**
    * the threshold mode.
    */
   void SetThresholdMode( ThresholdMode mode )
   {
      m_mode = mode;
   }

   /**
    * set the lower threshold value.
    */
   void SetLowerThreshold( InputPixelType lower )
   {
      m_lower = lower;
   }

   /**
    * set the upper threshold value.
    */
   void SetUpperThreshold( InputPixelType upper )
   {
      m_upper = upper;
   }

   /**
    * set the outside value.
    */
   void SetOutsideValue( OutputPixelType outside )
   {
      m_outside = outside;
   }

    /// @}

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

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

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

protected:
   /**
    * the threshold mode.
    */
   ThresholdMode m_mode;

   /**
    * the lower threshold value.
    */
   InputPixelType m_lower;

   /**
    * the upper threshold value.
    */
   InputPixelType m_upper;

   /**
    * the outside output value.
    */
   OutputPixelType m_outside;
};

/// @} cfl_filtermean

#endif // CFL_SCANFILTERTHRESHOLD_H

/*
 * end of file
 */

---