WMGaussFiltering.h

//---------------------------------------------------------------------------
//
// Project: OpenWalnut ( http://www.openwalnut.org )
//
// Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
// For more information see http://www.openwalnut.org/copying
//
// This file is part of OpenWalnut.
//
// OpenWalnut 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 of the License, or
// (at your option) any later version.
//
// OpenWalnut 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 OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
//
//---------------------------------------------------------------------------
 
#ifndef WMGAUSSFILTERING_H
#define WMGAUSSFILTERING_H
 
#include <map>
#include <memory>
#include <string>
#include <vector>
 
#include <osg/Geode>
#include <osg/Node>
#include <osg/Uniform>
 
#include "core/dataHandler/WDataSetScalar.h"
#include "core/kernel/WModule.h"
#include "core/kernel/WModuleInputData.h"
 
/**
 * Gauss filtering for WDataSetScalar
 *
 * \problem It works only on double value sets so far.
 * \reminder The boundary values will not be touched and considered to be zero.
 *
 * \ingroup modules
 */
class WMGaussFiltering : public WModule
{
public:
    /**
     * Standard constructor.
     */
    WMGaussFiltering();
 
    /**
     * Destructor.
     */
    ~WMGaussFiltering();
 
    /**
     * Gives back the name of this module.
     * \return the module's name.
     */
    virtual const std::string getName() const;
 
    /**
     * Gives back a description of this module.
     * \return description of module.
     */
    virtual const std::string getDescription() const;
 
    /**
     * Due to the prototype design pattern used to build modules, this method returns a new instance of this method. NOTE: it
     * should never be initialized or modified in some other way. A simple new instance is required.
     *
     * \return the prototype used to create every module in OpenWalnut.
     */
    virtual std::shared_ptr< WModule > factory() const;
 
    /**
     * Get the icon for this module in XPM format.
     * \return The icon.
     */
    virtual const char** getXPMIcon() const;
 
protected:
    /**
     * Entry point after loading the module. Runs in separate thread.
     */
    virtual void moduleMain();
 
    /**
     * Initialize the connectors this module is using.
     */
    virtual void connectors();
 
    /**
     * Initialize the properties for this module.
     */
    virtual void properties();
 
private:
    /**
     * A condition used to notify about changes in several properties.
     */
    std::shared_ptr< WCondition > m_propCondition;
 
    /**
     * The number of iterations to use for filtering
     */
    WPropInt m_iterations;
 
    /**
     * 1D or 3D filtering flag
     */
    WPropBool m_3DMaskMode;
 
    /**
     * Simple convolution using a small gauss-like mask
     * \param vals the valueset to work on
     * \param nX number of positions in x direction
     * \param nY number of positions in y direction
     * \param nZ number of positions in z direction
     * \param x index for x direction
     * \param y index for x direction
     * \param z index for x direction
     * \param offset the offset to add to the index (useful for addressing vector/tensor elements)
     *
     * \return the filtered value for a given position
     */
    template< typename T > double filterAtPosition(  std::shared_ptr< WValueSet< T > > vals,
                                                     size_t nX, size_t nY, size_t nZ, size_t x, size_t y, size_t z, size_t offset );
 
    /**
     * Run the filter over the field.
     * \param vals the valueset to work on
     * \param grid the grid for the valueset
     * \param prog the progress used for this filter iteration
     *
     * \return the filtered array of values.
     */
    template< typename T > std::vector< double > filterField( std::shared_ptr< WValueSet< T > > vals,
                                                              std::shared_ptr< WGridRegular3D > grid,
                                                              std::shared_ptr< WProgress > prog );
 
 
    /**
     * Run the 1D Gaussian filter over the field
     * \param newVals result of the filtering
     * \param vals the values to work on
     * \param prog the progress used for this filter iteration
     * \param Nx dimension along the filter
     * \param Ny first dimension perpendicular to the filter
     * \param Nz second dimension perpendicular to the filter
     * \param dx element offset along the filter
     * \param dy element offset perpendicular to the filter
     * \param dz second element offset perpendicular to the filter
     */
    template< typename T >
    void filterField1D( std::vector<T>* newVals,
                        const std::vector<T>&vals,
                        std::shared_ptr< WProgress > prog,
                        size_t Nx, size_t Ny, size_t Nz, size_t dx, size_t dy, size_t dz );
 
 
    /**
     * Run the 1D Gaussian filter over the field
     * \param newVals result of the filtering
     * \param vals the values to work on
     * \param prog the progress used for this filter iteration
     * \param Nx dimension along the filter
     * \param Ny first dimension perpendicular to the filter
     * \param Nz second dimension perpendicular to the filter
     * \param dx element offset along the filter
     * \param dy element offset perpendicular to the filter
     * \param dz second element offset perpendicular to the filter
     */
    template< typename T >
    void filterField1D( std::vector<double>* newVals,
                        std::shared_ptr< WValueSet< T > > vals,
                        std::shared_ptr< WProgress > prog,
                        size_t Nx, size_t Ny, size_t Nz, size_t dx, size_t dy, size_t dz );
    /**
     * Run the filter iteratively over the field. The number of iterations is determined by m_iterations.
     *
     * \param vals the valueset to work on
     * \param iterations the number of iterations. If this value is <=1 then the filter gets applied exactly once.
     *
     * \return the filtered valueset.
     */
    template< typename T > std::shared_ptr< WValueSet< double > > iterativeFilterField( std::shared_ptr< WValueSet< T > > vals,
                                                                                          unsigned int iterations );
 
    std::shared_ptr< WModuleInputData< WDataSetScalar > > m_input;  //!< Input connector required by this module.
    std::shared_ptr< WModuleOutputData< WDataSetScalar > > m_output; //!< The only output of this filter module.
    std::shared_ptr< WDataSetScalar > m_dataSet; //!< Pointer providing access to the treated data set in the whole module.
};
#endif  // WMGAUSSFILTERING_H