Filter Library

Camera

Interface Physics

ScanFilterRank.h

/*
 * ScanFilterRank.h - rank image filter.
 *
 * This file is part of the Camera Filter Library.
 * Computer Aided Measurement Environment for Realtime Atomic imaging (Camera)
 *
 * Copyright (C) 2004-2006, Leiden Probe Microscopy.
 * Copyright (C) 2004-2006, Universiteit Leiden.
 *
 * Authors: Martin J. Moene
 *
 * $Id: ScanFilterRank.h 363 2006-03-09 13:21:27Z moene $
 */

#ifndef CFL_SCANFILTERRANK_H
#define CFL_SCANFILTERRANK_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_filterminimum Rank Filter
 * \brief rank base filter.
 * @{
 */

DECLARE_CLASS( CScanFilterRank );         // create various types

/**
 * \brief base class for ranking filters (mean, median, minimum, maximum).
 *
 */
class CScanFilterRank : public CScanFilter
{
   /**
    * its dialog class.
    */
   friend class CFilterDlg_Rank;

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: setup filter to run without dialog;
    * see also CScanFilterNull::CScanFilterNull().
    */
   CScanFilterRank();

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

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

   /**
    * number of columns in image.
    */
   int Rows() const;

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

   /**
    * the current x-size.
    */
   DiffElementType GetSizeX() const;

   /**
    * the current y-size.
    */
   DiffElementType GetSizeY() const;

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

   /**
    * set the size.
    */
   void SetSize( CScanFilterRank::DiffType size );

   /**
    * set the x-size.
    */
   void SetSizeX( DiffElementType x );

   /**
    * set the x-size.
    */
   void SetSizeY( DiffElementType y );

   /// @}

protected:
   /**
    * store or retrieve the object's settings; see also CScanFilterNull::Serialize().
    */
   virtual void Serialize(CArchive& ar);
   DECLARE_SERIAL(CScanFilterRank)    // in derived classes
   
   /**
    * the filter name.
    */
   virtual const char* GetFilterName() const
   {
      return "Rank";
   }
   
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_nSizeX;

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

protected:
   /**
    * the area size.
    */
   DiffType m_cpSize;
};

/// @} cfl_filterminimum

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

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

/**
 * the current size.
 */
inline CScanFilterRank::DiffType CScanFilterRank::GetSize() const
{
   return m_cpSize;
}

/*
 * the current x-size.
 */
inline CScanFilterRank::DiffElementType CScanFilterRank::GetSizeX() const
{
   return m_cpSize.x;
}

/*
 * the current y-size.
 */
inline CScanFilterRank::DiffElementType CScanFilterRank::GetSizeY() const
{
   return m_cpSize.y;
}

/*
 * set area size.
 */
inline void CScanFilterRank::SetSize( CScanFilterRank::DiffType size )
{
   m_cpSize = size;
}

/*
 * set the x-size.
 */
inline void CScanFilterRank::SetSizeX( DiffElementType x )
{
   m_cpSize.x = x;
}

/*
 * set the y-size.
 */
inline void CScanFilterRank::SetSizeY( DiffElementType y )
{
   m_cpSize.y = y;
}

#endif // CFL_SCANFILTERRANK_H

/*
 * end of file
 */

---