WMFiberResampling.h 3.26 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
//---------------------------------------------------------------------------
//
// 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 WMFIBERRESAMPLING_H
#define WMFIBERRESAMPLING_H

#include <string>

30 31 32 33 34 35
#include <core/dataHandler/WDataSetFibers.h>
#include <core/kernel/WModule.h>
#include <core/kernel/WModuleInputData.h>
#include <core/kernel/WModuleOutputData.h>

#include "WResampling_I.h"
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75

/**
 * This modules takes a fiber dataset and samples it in regular steps. This is useful when importing fiber datasets from other tools sampled at
 * different steps sizes.
 *
 * \ingroup modules
 */
class WMFiberResampling: public WModule
{
public:
    /**
     * Default constructor.
     */
    WMFiberResampling();

    /**
     * Destructor.
     */
    virtual ~WMFiberResampling();

    /**
     * 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 to 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 boost::shared_ptr< WModule > factory() const;

76 77 78 79 80 81
    /**
     * Get the icon for this module in XPM format.
     * \return the icon.
     */
    virtual const char** getXPMIcon() const;

82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
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:
    /**
     * The fiber dataset which is going to be filtered.
     */
102
    boost::shared_ptr< WModuleInputData< WDataSetFibers > > m_fiberIC;
103 104 105 106

    /**
     * The output connector used to provide the calculated data to other modules.
     */
107
    boost::shared_ptr< WModuleOutputData< WDataSetFibers > > m_fiberOC;
108 109

    /**
110
     * Strategies for coloring fibers.
111
     */
112
    WStrategyHelper< WObjectNDIP< WResampling_I > > m_strategy;
113 114 115
};

#endif  // WMFIBERRESAMPLING_H