graphmanip.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_GRAPH_GRAPHMANIP_H
#define AIMS_GRAPH_GRAPHMANIP_H
 
#include <aims/rgb/rgb.h>
#include <cartodata/volume/volume.h>
#include <cartobase/object/object.h>
#include <cartobase/type/types.h>
#include <cartobase/object/property.h>
 
class Graph;
class GraphObject;
class Vertex;
class Edge;
 
namespace aims
{
  class AffineTransformation3d;
}
class Void;
 
namespace aims
{
 
  template<typename T> class BucketMap;
 
  struct GraphElementCode
  {
    enum StorageType
    {
      Local,
      Global,
      GlobalPacked
    };
 
    GraphElementCode() {}
    GraphElementCode( const GraphElementCode & x );
    GraphElementCode( const std::string & attrib, const std::string & ot, 
                      const std::string & dt, StorageType st );
    GraphElementCode & operator = ( const GraphElementCode & x );
 
    std::string id;
    std::string attribute;
    std::string objectType;
    std::string dataType;
    StorageType storageType;
    std::string local_file_attribute;
    std::string global_index_attribute;
    std::string global_filename;
    std::string global_attribute;
    std::string syntax;
  };
 
  typedef std::map<std::string, std::map<std::string,GraphElementCode> > 
  GraphElementTable;
 
 
  namespace DataManip
  {
 
    template <typename T> void adjustVoxelSize( T &, const T & );
 
    template <typename T> 
    void insertElement( T & dest, int index, const T & src );
    template <typename T>
    carto::PropertySet & getHeader( T & obj );
    template <typename T>
    void setHeaderInfo( T & obj, const carto::GenericObject & srcheader );
  }
 
 
  class GraphManip
  {
  public:
    typedef BucketMap<Void>* 
    (*CreateBucketFunc)( GraphObject*, const std::string & );
 
    static AffineTransformation3d talairach( const Graph & g );
    static void storeTalairach( Graph & g, const AffineTransformation3d & m,
                                bool force_old_attributes=false);
    static bool hasOldTalairachTransform( const Graph & g );
    static AffineTransformation3d getICBMTransform( const Graph & g );
    static AffineTransformation3d
      getICBM2009cTemplateTransform( const Graph & g );
    static bool buckets2Volume( Graph & g );
    static bool volume2Buckets( Graph & g, CreateBucketFunc f = 0 );
    static GraphElementCode & 
    graphElementCode( Graph &, const std::string & syntax, 
                      const std::string & id );
    static GraphElementCode & 
    graphElementCodeByAtt( Graph &, const std::string & syntax, 
                           const std::string & attrib );
    template<typename T> 
    static void storeAims( Graph & graph, GraphObject* vertex, 
                           const std::string & attribute, 
                           carto::rc_ptr<T> obj );
    template <typename T>
    static Graph* graphFromVolume(
      const carto::rc_ptr<carto::Volume<T> > & vol,
      T background = 0,
      std::map<T, std::string> *trans = 0 );
    template <typename T>
    static void graphFromVolume( const carto::rc_ptr<carto::Volume<T> > & vol ,
                                 Graph & g,
                                 T background = 0,
                                 std::map<T,std::string> *trans = 0,
                                 bool automaticBackgroundSearch = true );
    static void setAttributeColor( Graph & graph, const std::string & att,
                                   const AimsRGB & );
    static void setAttributeColor( Graph & graph, const std::string & att,
                                   const AimsRGBA & );
    static void setAttributeColor( Graph & graph, const std::string & att,
                                   const std::vector<int> & );
    std::vector<int> attributeColor( const Graph & graph,
                                     const std::string & att );
    static void completeGraph( Graph & );
 
    //Merge two graph
    //If they contain some mesh, they can be 
    //either merged 
    //or just copied
    //invNormal enable to inverse the mesh normal
    static Graph* mergeGraph( const std::string &,  Graph &,  Graph &,
                              bool mergeMesh = true, bool invNormal = false);
    static void printGraphElementTable( const Graph &,
                                        std::ostream & ostr = std::cout );
    static std::string
      defaultExtensionForObjectType( const std::string & otype,
        const std::string & dtype );
 
    static std::list<Edge *> getPath( const Vertex *from, const Vertex *to );
  };
 
}
 
 
namespace carto
{
 
  template<> inline 
  std::string DataTypeCode<aims::GraphElementCode>::dataType()
  {
    return "GraphElementCode";
  }
  
#define _TMP_ rc_ptr<std::map<std::string,std::map<std::string,aims::GraphElementCode> > > 
DECLARE_GENERIC_OBJECT_TYPE( _TMP_ )
#undef _TMP_
 
} // namespace carto
 
#endif