field.hh

Go to the documentation of this file.

/*
Copyright CEA (2014, 2017).
Copyright Université Paris XI (2014).
 
Contributor: Yann Leprince <yann.leprince@ylep.fr>.
Contributor: Denis Rivière <denis.riviere@cea.fr>.
 
This file is part of highres-cortex, a collection of software designed
to process high-resolution magnetic resonance images of the cerebral
cortex.
 
This software is governed by the CeCILL licence under French law and
abiding by the rules of distribution of free software. You can use,
modify and/or redistribute the software under the terms of the CeCILL
licence as circulated by CEA, CNRS and INRIA at the following URL:
<http://www.cecill.info/>.
 
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the licence, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
 
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of scientific
software, that may mean that it is complicated to manipulate, and that
also therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
 
The fact that you are presently reading this means that you have had
knowledge of the CeCILL licence and that you accept its terms.
*/
 
#ifndef YL_FIELD_HH_INCLUDED
#define YL_FIELD_HH_INCLUDED
 
#include <aims/vector/vector.h>
#include <aims/resampling/linearInterpolator.h>
 
namespace yl
{

class Field
{
public:
  class UndefinedField
  {
  };
};

class VectorField3d : public Field
{
public:
  // A virtual destructor is needed because this is a polymorphic class
  ~VectorField3d() {};

  Point3df evaluate(const Point3df& pos) const
  {
    Point3df ret;
    evaluate(pos, ret);
    return ret;
  };

  virtual void evaluate(const Point3df& pos, Point3df& output) const = 0;
};

class ScalarField : public Field
{
public:
  // A virtual destructor is needed because this is a polymorphic class
  ~ScalarField() {};

  virtual float evaluate(const Point3df& pos) const = 0;
 
};

class LinearlyInterpolatedVectorField3d : public VectorField3d
{
public:
  LinearlyInterpolatedVectorField3d(const carto::VolumeRef<float>& fieldx,
                                    const carto::VolumeRef<float>& fieldy,
                                    const carto::VolumeRef<float>& fieldz);
 
  virtual void evaluate(const Point3df& pos, Point3df& output) const;
private:
  aims::LinearInterpolator<float> m_interp_fieldx;
  aims::LinearInterpolator<float> m_interp_fieldy;
  aims::LinearInterpolator<float> m_interp_fieldz;
};
 
class LinearlyInterpolatedScalarFieldGradient : public VectorField3d
{
public:
  explicit LinearlyInterpolatedScalarFieldGradient(
    const carto::VolumeRef<float>& scalar_field);
  virtual void evaluate(const Point3df& pos, Point3df& output) const;
private:
  carto::rc_ptr<aims::Interpolator> m_interp_gradx;
  carto::rc_ptr<aims::Interpolator> m_interp_grady;
  carto::rc_ptr<aims::Interpolator> m_interp_gradz;
  float m_xoffset, m_yoffset, m_zoffset;
};

class LinearlyInterpolatedScalarField : public ScalarField
{
public:
  explicit LinearlyInterpolatedScalarField(const carto::VolumeRef<float>& field_volume);
 
  virtual float evaluate(const Point3df& pos) const;
private:
  aims::LinearInterpolator<float> m_interp_field;
};

class BooleanScalarField : public ScalarField
{
public:
  explicit BooleanScalarField(const carto::VolumeRef<int16_t>& field_volume);
 
  virtual float evaluate(const Point3df& pos) const;
private:
  const carto::VolumeRef<int16_t>& m_field;
  Point3df m_voxel_size;
};
 
}  // namespace yl
 
#endif // !defined(YL_FIELD_HH_INCLUDED)