WMDataCreatorVector.cpp

//---------------------------------------------------------------------------
//
// 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/>.
//
//---------------------------------------------------------------------------
 
#include <algorithm>
#include <memory>
#include <string>
 
#include "WDataCreatorRandom.h"
#include "WDataCreatorSingleDirection.h"
#include "WDataCreatorSphere.h"
#include "WMDataCreatorVector.h"
#include "WMDataCreatorVector.xpm"
#include "core/common/WAssert.h"
#include "core/common/WProgress.h"
#include "core/common/WStrategyHelper.h"
#include "core/dataHandler/WDataSetVector.h"
#include "core/dataHandler/WGridRegular3D.h"
#include "core/kernel/WKernel.h"
 
WMDataCreatorVector::WMDataCreatorVector():
    WModule(),
    m_strategy( "Dataset Creators", "Select one of the dataset creators and configure it to your needs.", NULL,
                "Creator", "A list of all known creators." )
{
    // add some strategies here
    m_strategy.addStrategy( WDataCreatorRandom::SPtr( new WDataCreatorRandom() ) );
    m_strategy.addStrategy( WDataCreatorSingleDirection::SPtr( new WDataCreatorSingleDirection() ) );
 
    // NOTE: the sphere strategy does not support vectors -> if you want them, create a scalar sphere and derive from it.
}
 
WMDataCreatorVector::~WMDataCreatorVector()
{
    // cleanup
    removeConnectors();
}
 
std::shared_ptr< WModule > WMDataCreatorVector::factory() const
{
    return std::shared_ptr< WModule >( new WMDataCreatorVector() );
}
 
const char** WMDataCreatorVector::getXPMIcon() const
{
    return WMDataCreatorVector_xpm;
}
 
const std::string WMDataCreatorVector::getName() const
{
    return "Data Creator Vector";
}
 
const std::string WMDataCreatorVector::getDescription() const
{
    return "Allows the user to create vector data sets on a regular grid by providing a bunch of data creation schemes.";
}
 
void WMDataCreatorVector::connectors()
{
    // initialize connectors
    m_output = WModuleOutputData< WDataSetVector >::createAndAdd( shared_from_this(), "out", "The data that has been created" );
 
    // call WModule's initialization
    WModule::connectors();
}
 
void WMDataCreatorVector::properties()
{
    m_propCondition = std::shared_ptr< WCondition >( new WCondition() );
 
    // how much voxels?
    m_nbVoxelsX = m_properties->addProperty( "Voxels X", "The number of voxels in X direction.", 128, m_propCondition );
    m_nbVoxelsX->setMin( 2 );
    m_nbVoxelsX->setMax( 4096 );
    m_nbVoxelsY = m_properties->addProperty( "Voxels Y", "The number of voxels in Y direction.", 128, m_propCondition );
    m_nbVoxelsY->setMin( 2 );
    m_nbVoxelsY->setMax( 4096 );
    m_nbVoxelsZ = m_properties->addProperty( "Voxels Z", "The number of voxels in Z direction.", 128, m_propCondition );
    m_nbVoxelsZ->setMin( 2 );
    m_nbVoxelsZ->setMax( 4096 );
 
    // grid transform information
    m_origin = m_properties->addProperty( "Origin", "Coordinate of the origin (voxel 0,0,0).", WPosition( 0.0, 0.0, 0.0 ), m_propCondition );
    m_size = m_properties->addProperty( "Size", "The size of the dataset along the X,Y, and Z axis in the OpenWalnut coordinate system.",
                                        WPosition( 128.0, 128.0, 128.0 ), m_propCondition );
 
    // now, setup the strategy helper.
    m_properties->addProperty( m_strategy.getProperties() );
 
    // call WModule's initialization
    WModule::properties();
}
 
void WMDataCreatorVector::moduleMain()
{
    // let the main loop awake if the data changes or the properties changed.
    m_moduleState.setResetable( true, true );
    m_moduleState.add( m_propCondition );
    // we need to wake up if some strategy prop changed
    m_moduleState.add( m_strategy.getProperties()->getUpdateCondition() );
 
    // signal ready state
    ready();
 
    // loop until the module container requests the module to quit
    while( !m_shutdownFlag() )
    {
        debugLog() << "Creating dataset";
 
        // create a new WGridRegular3D
        WGridTransformOrtho transform( m_size->get( true ).x() / static_cast< double >( m_nbVoxelsX->get( true ) - 1 ), // NOLINT
                                       //  - its not std::transform
                                       m_size->get( true ).y() / static_cast< double >( m_nbVoxelsY->get( true ) - 1 ),
                                       m_size->get( true ).z() / static_cast< double >( m_nbVoxelsZ->get( true ) - 1 )
        );
        // apply transform to new origin
        transform.translate( m_origin->get( true ) );
        WGridRegular3D::SPtr grid( new WGridRegular3D( m_nbVoxelsX->get(), m_nbVoxelsY->get(), m_nbVoxelsZ->get(), transform ) );
 
        WProgress::SPtr progress( new WProgress( "Creating Dataset", grid->size() ) );
        m_progress->addSubProgress( progress );
 
        // get the current strategy
        WValueSetBase::SPtr valueSet = m_strategy()->operator()( progress, grid, 1, 3 );
 
        debugLog() << "Created dataset with " << grid->size() << " voxels.";
 
        // build dataset
        WDataSetVector::SPtr ds( new WDataSetVector( valueSet, grid ) );
 
        // done. Notify user.
        progress->finish();
        m_progress->removeSubProgress( progress );
 
        // done. update output
        m_output->updateData( ds );
 
        // Now, the moduleState variable comes into play. The module can wait for the condition, which gets fired whenever the input receives data
        // or an property changes. The main loop now waits until something happens.
        debugLog() << "Waiting ...";
        m_moduleState.wait();
    }
}