transformationgraph3d.h

Go to the documentation of this file.

/* This software and supporting documentation are distributed by
 *     Institut Federatif de Recherche 49
 *     CEA/NeuroSpin, Batiment 145,
 *     91191 Gif-sur-Yvette cedex
 *     France
 *
 * This software is governed by the CeCILL-B license under
 * French law and abiding by the rules of distribution of free software.
 * You can  use, modify and/or redistribute the software under the
 * terms of the CeCILL-B license as circulated by CEA, CNRS
 * and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the
 * same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-B license and that you accept its terms.
 */
 
#ifndef AIMS_TRANSFORMATION_TRANSFORMATIONGRAPH3D_H
#define AIMS_TRANSFORMATION_TRANSFORMATIONGRAPH3D_H
 
#include <graph/graph/graph.h>
#include <soma-io/transformation/transformation.h>
#include <cartobase/allocator/allocator.h>
 
 
namespace aims
{

  class TransformationGraph3d : public Graph
  {
  public:
    TransformationGraph3d();
    virtual ~TransformationGraph3d();

    void updateIds();
    Vertex* referentialById( const std::string & id ) const;
    Vertex* referentialByCode( const std::string & id,
                               carto::Object header,
                               const std::vector<std::string> & refs ) const;
    Vertex* referentialByCode( const std::string & id,
                               const carto::DictionaryInterface *header,
                               const std::vector<std::string> & refs ) const;
    Edge* transformationById( const std::string & id ) const;
    static std::string referential( const Vertex *v );
    static carto::rc_ptr<soma::Transformation3d> transformation(
      const Edge *edge );
    carto::rc_ptr<soma::Transformation3d> transformation(
      const std::string & id ) const;

    const carto::AllocatorContext & allocatorContext() const
    { return _allocator; }

    void setAllocatorContext( const carto::AllocatorContext & alloc )
    { _allocator = alloc; }

    Edge* getTransformation( const std::string & src_ref,
                             const std::string & dst_ref ) const;
    Edge* getTransformation( const std::string & src_ref,
                             const std::string & dst_ref,
                             bool allow_compose );
    Edge* getTransformation( const Vertex *src_ref,
                             const Vertex *dst_ref ) const;
    Edge* getTransformation( Vertex *src_ref,
                             Vertex *dst_ref,
                             bool allow_compose );

    Edge *getTransformation_raw( const Vertex *src_ref,
                                 const Vertex *dst_ref ) const;
    Edge *getTransformation_raw( const std::string & src_ref,
                                 const std::string & dst_ref ) const;

    Edge *registerTransformation( const std::string & src_ref,
                                  const std::string & dst_ref,
                                  carto::rc_ptr<soma::Transformation3d>,
                                  bool deduced=false );
    Edge *registerTransformation( Vertex *src_ref, Vertex *dst_ref,
                                  carto::rc_ptr<soma::Transformation3d>,
                                  bool deduced=false );
    Edge *registerTransformation( const std::string & src_ref,
                                  const std::string & dst_ref,
                                  const std::string & filename );
    Edge *registerTransformation( Vertex *src_ref, Vertex *dst_ref,
                                  const std::string & filename );
    void registerReferentialAlias( const std::string & uuid,
                                   const std::string & existing_id );
    void mergeReferentials( const std::string & uuid,
                            const std::string & existing_id );

    void loadTransformationsGraph( carto::Object desc,
                                   const std::string & dirname );
    carto::Object asDict( bool affine_only = false, bool allow_read = false,
                          bool embed_affines = false,
                          const std::string & rel_to_path = "" ) const;
    void clearCache( bool chain_only=false );
    void registerInverseTransformations( bool loadAffines = false );
    std::list<Edge *> loadAffineTransformations();

    carto::rc_ptr<soma::Transformation3d> getTransformChain(
      const Vertex *src_ref, const Vertex *dst_ref ) const;
    carto::rc_ptr<soma::Transformation3d> getTransformChain(
      const std::string & src_ref, const std::string & dst_ref ) const;
 
    carto::rc_ptr<soma::Transformation3d>
      loadTransformation( Edge *edge, bool affine_only=false ) const;

    std::vector<std::string> updateFromObjectHeader(
      carto::Object header, bool includeDiskSpace = false );
    std::vector<std::string>  updateFromObjectHeader(
      const carto::DictionaryInterface *header,
      bool includeDiskSpace = false );

    static carto::rc_ptr<soma::Transformation3d> transformToDiskSpace(
      const carto::DictionaryInterface *header );
 
  private:
    mutable std::map<std::string, Vertex *> _refs_by_id;
    mutable std::map<std::string, Edge *> _tr_by_id;
    std::set<std::pair<const Vertex *, const Vertex *> > _disconnected;
    carto::AllocatorContext _allocator;
 
  };
 
}
 
namespace carto
{
 
  template <> inline
  std::string DataTypeCode<aims::TransformationGraph3d>::objectType()
  { return "TransformationGraph3d"; }
 
  template <> inline
  std::string DataTypeCode<aims::TransformationGraph3d>::dataType()
  { return "VOID"; }
 
  template <> inline
  std::string DataTypeCode<aims::TransformationGraph3d>::name()
  {
    return "TransformationGraph3d";
  }
 
  DECLARE_GENERIC_OBJECT_TYPE( carto::rc_ptr<soma::Transformation3d> )
}
 
#endif