src/README.txt

   1 /*
   2 # ---------------------------------------------------------------------
   3 #
   4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   5 #                        pour la Santé)
   6 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   7 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   8 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   9 #
  10 #  This software is governed by the CeCILL-B license under French law and
  11 #  abiding by the rules of distribution of free software. You can  use,
  12 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  13 #  license as circulated by CEA, CNRS and INRIA at the following URL
  14 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  15 #  or in the file LICENSE.txt.
  16 #
  17 #  As a counterpart to the access to the source code and  rights to copy,
  18 #  modify and redistribute granted by the license, users are provided only
  19 #  with a limited warranty  and the software's author,  the holder of the
  20 #  economic rights,  and the successive licensors  have only  limited
  21 #  liability.
  22 #
  23 #  The fact that you are presently reading this means that you have had
  24 #  knowledge of the CeCILL-B license and that you accept its terms.
  25 # ------------------------------------------------------------------------
  26 */
  27
  28 New architecture created on 04/02/09 following a MVC approach
  29
  30 Elements of the architecture:
  31
  32 * Data structure: Attributed tree
  33 --------------------------------------
  34 in namespace creaImageIO::tree
  35 Tree :   Attributed tree structure
  36          inherits Node
  37          holds a vector of root TreeNode
  38 TreeData : Abstract class to store user data on a tree
  39 Node :
  40          belong to a Tree,
  41          holds a pointer on parent Node,
  42          holds a vector of children Node
  43 NodeData : Abstract class to store user data on a tree node
  44 Descriptor : Descriptor of the structure a tree (number of levels, descriptors of each level, ...)
  45
  46          holds a vector of LevelDescriptor
  47 LevelDescriptor :
  48          holds a vector of TreeAttributeDescriptor
  49 AttributeDescriptor :
  50          stores name, dicom group/elem, flags
  51 Comparator: Abstract definition of a comparator of Node
  52             Comparison is done by operator()(Node* const &, Node* const &)
  53 ComparatorWithOrder : Abstract Comparator whose order can be reversed
  54                     Concrete comparison is done by method compare(Node* const &, Node* const &)
  55 LexicographicalComparator :  A Comparator which stores a vector of Comparators and which performs lexicographical comparison
  56
  57 IntComparator    : Compares the values of a given Attribute of the Nodes which is decoded as an int    value
  58 FloatComparator  : Compares the values of a given Attribute of the Nodes which is decoded as a  float  value
  59 StringComparator : Compares the values of a given Attribute of the Nodes which is decoded as a  string value
  60
  61
  62 * Models : TreeHandler and descendants
  63 --------------------------------------
  64
  65 TreeHandler : Abstract class which 'handles' a Tree structure.
  66             Can:
  67             Load the children of a given Node
  68
  69 SQLiteTreeHandler : Concrete TreeHandler which manages a tree stored in a sqlite database
  70 CppSQLite3.h / CppSQLite3.cpp : C++ interface to sqlite db
  71 ...
  72
  73 ImageFinder : Parses (recursively) a part of a filesystem to look for known images and load their attributes in order to add the images to a Tree (submission via a TreeHandler::AddBranch)
  74
  75
  76 * Image handling
  77 ----------------
  78
  79 creaImageIOImageReader.h/cpp :
  80 SpecificImageReader
  81 ImageReader
  82
  83 creaImageIOMultiThreadImageReader.h/cpp
  84 creaImageIOIndexedHeap.h/cpp
  85
  86 * Views :
  87 ---------
  88 TreeView
  89 WxTreeView
  90 WxGimmickView
  91 QTreeView
  92 QGimmickView
  93 ...
  94
  95 * Controller :
  96 --------------
  97 Gimmick
  98 ...