function_base.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// This file is part of the OpenStructure project <www.openstructure.org>
//
// Copyright (C) 2008-2011 by the OpenStructure authors
// Copyright (C) 2003-2010 by the IPLT authors
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License as published by the Free
// Software Foundation; either version 3.0 of the License, or (at your option)
// any later version.
// This library is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
// details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//------------------------------------------------------------------------------

/*
  function base

  Author: Ansgar Philippsen
*/

#ifndef IMG_FUNCTION_BASE_H
#define IMG_FUNCTION_BASE_H

#include "module_config.hh"
#include "data.hh"
#include "data_observer.hh"
#include "observable.hh"
#include "pixel_sampling.hh"

namespace ost { namespace img {

// forward declaration
class NonModAlgorithm;
class ImageHandle;


/*
  Observer implementation will result in empty observer list
  upon copy construction or assignement.
*/

class DLLEXPORT_OST_IMG_BASE Function: public Data {
  typedef Observable<DataObserver> DataObservable;

 public:
  virtual ~Function();


  virtual DataType GetType() const = 0;

  virtual DataDomain GetDomain() const;


  virtual Extent GetExtent() const;
  void SetExtent(const Extent& e);

  virtual void SetSpatialOrigin(const Point& o);
  virtual Point GetSpatialOrigin() const;



  virtual Real GetReal(const Point& p) const; 

  virtual Complex GetComplex(const Point& p) const; 

  virtual Real GetIntpolReal(const Vec3 &v) const=0;
  virtual Real GetIntpolReal(const Vec2 &v) const;
  virtual Real GetIntpolReal(const Real &d) const;

  virtual Complex GetIntpolComplex(const Vec3 &v) const=0;
  virtual Complex GetIntpolComplex(const Vec2 &v) const;
  virtual Complex GetIntpolComplex(const Real &d) const;



  // use doc from Data
  virtual void Apply(NonModAlgorithm& a) const;
  virtual void ApplyIP(NonModAlgorithm& a) const;

  // use doc from Data
  virtual void Attach(DataObserver *o) const;
  virtual void Detach(DataObserver *o) const;
  virtual void Notify() const;


 protected:
  Function(DataDomain d, const Extent& e=Extent());

  Function(const Function& f);

  Function& operator=(const Function& f);

  virtual PixelSampling& Sampling();
  virtual const PixelSampling& Sampling() const;

private:
  Extent extent_;
  DataDomain domain_;

  /*
    implement logical constness for Attach and Detach
  */
  mutable DataObservable obs_;

  PixelSampling sampling_;
};

}} // namespace

#endif