itkStandardMeshRepresenter.h

/*
 * This file is part of the statismo library.
 *
 * Author: Marcel Luethi (marcel.luethi@unibas.ch)
 *
 * Copyright (c) 2011 University of Basel
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 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.
 *
 * Neither the name of the project's author 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 ITK_STANDARD_MESH_REPRESENTER_H
#define ITK_STANDARD_MESH_REPRESENTER_H

#include <boost/unordered_map.hpp>

#include <itkMesh.h>
#include <itkObject.h>

#include "statismoITKConfig.h" // this needs to be the first include file

#include "CommonTypes.h"
#include "Exceptions.h"
#include "Representer.h"

#include "itkPixelConversionTraits.h"

namespace statismo {
template <>
struct RepresenterTraits<itk::Mesh<float, 3u> > {

    typedef itk::Mesh<float, 3u> MeshType;

    typedef MeshType::Pointer DatasetPointerType;
    typedef MeshType::Pointer DatasetConstPointerType;

    typedef MeshType::PointType PointType;
    typedef MeshType::PointType ValueType;
};

}

namespace itk {

// helper function to compute the hash value of an itk point (needed by unorderd_map)
template <typename PointType>
size_t hash_value(const PointType& pt) {
    size_t hash_val = 0;
    for (unsigned i = 0; i < pt.GetPointDimension(); i++) {
        boost::hash_combine( hash_val, pt[i] );
    }
    return hash_val;
}


template <class TPixel, unsigned MeshDimension>
class StandardMeshRepresenter : public statismo::Representer<itk::Mesh<TPixel, MeshDimension> >, public Object {
  public:

    /* Standard class typedefs. */
    typedef StandardMeshRepresenter            Self;
    typedef Object  Superclass;
    typedef SmartPointer<Self>                Pointer;
    typedef SmartPointer<const Self>          ConstPointer;


    typedef itk::Mesh<TPixel, MeshDimension> MeshType;
    typedef typename statismo::Representer<MeshType > RepresenterBaseType;
    typedef typename RepresenterBaseType::DomainType DomainType;
    typedef typename RepresenterBaseType::PointType PointType;
    typedef typename RepresenterBaseType::ValueType ValueType;
    typedef typename RepresenterBaseType::DatasetPointerType DatasetPointerType;
    typedef typename RepresenterBaseType::DatasetConstPointerType DatasetConstPointerType;
    typedef typename MeshType::PointsContainer PointsContainerType;

    itkSimpleNewMacro( Self );

    itkTypeMacro( StandardMeshRepresenter, Object );


    static StandardMeshRepresenter* Create() {
        return new StandardMeshRepresenter();
    }

    void Load(const H5::Group& fg);
    StandardMeshRepresenter* Clone() const;

    typedef MeshType DatasetType;

    // An unordered map is used to cache pointid for corresonding points
    typedef boost::unordered_map<PointType, unsigned> PointCacheType;

    StandardMeshRepresenter();
    virtual ~StandardMeshRepresenter();

    unsigned GetDimensions() const {
        return MeshDimension;
    }
    std::string GetName() const {
        return "itkStandardMeshRepresenter";
    }
    typename RepresenterBaseType::RepresenterDataType GetType() const {
        return RepresenterBaseType::POLYGON_MESH;
    }
    std::string GetVersion() const {
        return "0.1";
    }

    const DomainType& GetDomain() const {
        return m_domain;
    }

    void SetReference(DatasetPointerType ds);

    statismo::VectorType PointToVector(const PointType& pt) const;


    DatasetPointerType DatasetToSample(DatasetConstPointerType ds) const;

    statismo::VectorType SampleToSampleVector(DatasetConstPointerType sample) const;

    DatasetPointerType SampleVectorToSample(const statismo::VectorType& sample) const;

    ValueType PointSampleFromSample(DatasetConstPointerType sample, unsigned ptid) const;

    ValueType PointSampleVectorToPointSample(const statismo::VectorType& pointSample) const;

    statismo::VectorType PointSampleToPointSampleVector(const ValueType& v) const;

    void Save(const H5::Group& fg) const;

    virtual unsigned GetNumberOfPoints() const;

    virtual unsigned GetPointIdForPoint(const PointType& point) const;

    DatasetConstPointerType GetReference() const {
        return m_reference;
    }

    void Delete() const {
        this->UnRegister();
    }


    void DeleteDataset(DatasetPointerType d) const { };
    DatasetPointerType CloneDataset(DatasetConstPointerType mesh) const;

  private:

    typename MeshType::Pointer LoadRef(const H5::Group& fg) const;
    typename MeshType::Pointer LoadRefLegacy(const H5::Group& fg) const;

    // returns the closest point for the given mesh
    unsigned FindClosestPoint(const MeshType* mesh, const PointType pt) const ;

    DatasetConstPointerType m_reference;
    DomainType m_domain;
    mutable PointCacheType m_pointCache;
};


} // namespace itk



#include "itkStandardMeshRepresenter.hxx"

#endif /* ITK_STANDARD_MESH_REPRESENTER */