ImplicitSurface.h

Go to the documentation of this file.

/*

Copyright (c) 2017, Dr Franck P. Vidal (franck.p.vidal@fpvidal.net),
http://www.fpvidal.net/
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

3. Neither the name of the Bangor University nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/


#ifndef __ImplicitSurface_h
#define __ImplicitSurface_h


//******************************************************************************
//  Include
//******************************************************************************
#ifndef __gVirtualXRayConfig_h
#include "gVirtualXRay/gVirtualXRayConfig.h"
#endif

#include <vector>

#ifndef __Types_h
#include "gVirtualXRay/Types.h"
#endif

#ifndef __Image_h
#include "gVirtualXRay/Image.h"
#endif


//******************************************************************************
//  namespace
//******************************************************************************
namespace gVirtualXRay {


class PolygonMesh;


//==============================================================================
//==============================================================================
class ImplicitSurface
//------------------------------------------------------------------------------
{
//******************************************************************************
public:
    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    typedef enum DensityFunctionTypeTag
    {
        SPHERE,             
        
        BLOBBY_MOLECULE,    
        
        META_BALL,          
        
        SOFT_OBJECT         
    } DensityFunctionType;


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    class DensityFunctionParameterType
    {
    //**************************************************************************
    public:
        //----------------------------------------------------------------------

        //----------------------------------------------------------------------
        DensityFunctionParameterType(
            const DensityFunctionType aDensityFunctionType = BLOBBY_MOLECULE,
            RATIONAL_NUMBER a = 1,
            RATIONAL_NUMBER b = 1):
        //----------------------------------------------------------------------
            m_density_function(aDensityFunctionType),
            m_a(a),
            m_b(b)
        //----------------------------------------------------------------------
        {}


        DensityFunctionType m_density_function;
    
    
        RATIONAL_NUMBER m_a;
    
    
        RATIONAL_NUMBER m_b;
    };


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    ImplicitSurface();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    ~ImplicitSurface();


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    RATIONAL_NUMBER evaluate(RATIONAL_NUMBER r,
            const DensityFunctionParameterType& aParameter) const;


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void resetControlPoints();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void resetControlLines();


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void addControlPoint(const DensityFunctionParameterType& aParameter,
            const VEC3& aControlPoint);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void addControlLine(const DensityFunctionParameterType& aParameter,
            const VEC3& aControlPoint1,
            const VEC3& aControlPoint2);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    unsigned int getNumberOfControlPoints() const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    unsigned int getNumberOfControlLineSegments() const;


    void setControlPointParameters(unsigned int aPointID,
        DensityFunctionType aDentityFunction,
        float aParameter1,
        float aParameter2 = 0.0);
                                

    void setControlLineSegmentParameters(unsigned int aLineSegmentID,
        DensityFunctionType aDentityFunction,
        float aParameter1,
        float aParameter2 = 0.0);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    const VEC3& getControlPoint(unsigned int anIndex) const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    VEC3& getControlPoint(unsigned int anIndex);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    const std::pair<VEC3, VEC3>& getControlLine(unsigned int anIndex) const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    std::pair<VEC3, VEC3>& getControlLine(unsigned int anIndex);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void voxelise(const Vec3ui& aNumberOfVoxels,
            const VEC3& aCenter,
            const VEC3& aVoxelSize,
            unsigned char aVerboseLevel = 0);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void voxelize(const Vec3ui& aNumberOfVoxels,
            const VEC3& aCenter,
            const VEC3& aVoxelSize,
            unsigned char aVerboseLevel = 0);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void writeVoxelData(const char* aFileName) const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void writeVoxelData(const std::string& aFileName) const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void writePolygonMesh(const char* aFileName);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void writePolygonMesh(const std::string& aFileName);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void extractIsoSurface(const RATIONAL_NUMBER& aThreshold = 0, 
        unsigned char aVerboseLevel = 0);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void extractIsoSurface(const RATIONAL_NUMBER& aLowerThreshold, 
        const RATIONAL_NUMBER& anUpperThreshold, 
        unsigned char aVerboseLevel = 0);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    PolygonMesh& getPolygonMesh();
    
    
    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    const PolygonMesh& getPolygonMesh() const;


    const Image<RATIONAL_NUMBER>& getVolume() const;


    Image<RATIONAL_NUMBER>& getVolume();

    
//******************************************************************************
protected:
    RATIONAL_NUMBER evaluateSphere(RATIONAL_NUMBER r) const;
    
    
    RATIONAL_NUMBER evaluateBlobbyMolecule(RATIONAL_NUMBER r,
                                           RATIONAL_NUMBER a,
                                           RATIONAL_NUMBER b) const;
    
    
    RATIONAL_NUMBER evaluateMetaBall(RATIONAL_NUMBER r,
                                     RATIONAL_NUMBER a,
                                     RATIONAL_NUMBER b) const;
    
    
    RATIONAL_NUMBER evaluateSoftObject(RATIONAL_NUMBER r,
                                       RATIONAL_NUMBER a,
                                       RATIONAL_NUMBER b) const;

    
    Image<RATIONAL_NUMBER> m_volume;
    
    
    PolygonMesh m_mesh_data;
    
    
    VEC3 m_centre;

    
    std::vector<std::pair<DensityFunctionParameterType, VEC3> >
            m_control_point_set;
    
    
    std::vector<std::pair<DensityFunctionParameterType,
            std::pair<VEC3, VEC3> > > m_control_line_set;
};


} // namespace gVirtualXRay


//******************************************************************************
#include "ImplicitSurface.inl"


#endif // __ImplicitSurface_h