nrroKernel.h

Go to the documentation of this file.

//------------------------------------------------------------------------
//
//   Joe Kniss
//     4-1-03
//                   ________    ____   ___ 
//                  |        \  /    | /  /
//                  +---+     \/     |/  /
//                  +--+|  |\    /|     < 
//                  |  ||  | \  / |  |\  \ 
//                  |      |  \/  |  | \  \ 
//                   \_____|      |__|  \__\
//                       Copyright  2003 
//                      Joe Michael Kniss
//                   <<< jmk@cs.utah.edu >>>
//               "All Your Base are Belong to Us"
//-------------------------------------------------------------------------

//nrroKernel.h

#ifndef __NRRO_KERNEL_DOT_H
#define __NRRO_KERNEL_DOT_H

#include <gage.h>

///////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////
///                      Kernels
///////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////

/////////////////////////////////////////////////////////////////////
/// forward decl of kernel obj, defined below
/////////////////////////////////////////////////////////////////////
class NrroKernel;
class Nrro;

/////////////////////////////////////////////////////////////////////
/// usefull predefined kernels
/////////////////////////////////////////////////////////////////////

extern const NrroKernel BoxKernel;
extern const NrroKernel TentKernel;
extern const NrroKernel CatmulRomKernel;
extern const NrroKernel BSplineKernel;

///////////////////////////////////////////////////////////////////////////
/// Kernel object
///////////////////////////////////////////////////////////////////////////

class NrroKernel
{
public:
   enum PARAMETERS {
      MAX_PARMS = NRRD_KERNEL_PARMS_NUM
   };

   //////////////////////////////////////////////////////
   /// defaults to catmul-rom: value
   ///  params must be 0 or MAX_PARMS in size
   NrroKernel(int kind = Cubic, const double *params = 0);
   /// copy
   NrroKernel(const NrroKernel &nk);
   virtual ~NrroKernel();

   /// assignment
   void operator=(const NrroKernel &nk);

   /// comparisons
   bool operator==(const NrroKernel &nk) const;
   bool operator!=(const NrroKernel &nk) const 
   { return !((*this) == nk); }

   enum{ //kinds of kernels supported
      Kernel_Unknown,

      Box,       
      Tent,      
      Cubic,   
      Quartic,  
      Gaussian,

      Kernel_Last
   };

   enum{ //type of kernel used
      TYPE_UNKNOWN,

      VALUE,    //value
      DERIV,    //1st derivative
      DERIV2,   //2nd derivative

      TYPE_LAST
   };

   //////////////////////////////////////
   /// these are for interactions between
   /// NrroProbe and Nrrd stuff, users
   ///  need not worry about these
   int           getGageKernelType(int type = VALUE) const;
   NrrdKernel   *getNrrdKernel(int type = VALUE) const;
   const double *getParams(int type = VALUE) const;


   //////////////////////////////////////
   /// what kind of kernel is this?
   int  getKind() const      {return _kind;}
   //////////////////////////////////////
   /// want to make it something else?
   void setKind(int kind);


protected:

   int    _kind;
   double _params[MAX_PARMS];
   double _spareParams[MAX_PARMS];
};

/////////////////////////////////////////////////////////////////////
/// some implementation
/////////////////////////////////////////////////////////////////////
inline
bool NrroKernel::operator==(const NrroKernel &nk) const
{
   if(_kind != nk._kind) return false;
   for(int i=0; i<MAX_PARMS; ++i)
   {
      if(_params[i] != nk._params[i]) return false;
      if(_spareParams[i] != nk._spareParams[i]) return false;
   }
   return true;
}



#endif

---

Send questions, comments, and bug reports to: