src2/creaImageIOGimmickView.h

   1 #ifndef __creaImageIOGimmickView_h_INCLUDED__
   2 #define __creaImageIOGimmickView_h_INCLUDED__
   3
   4 #include <creaImageIOGimmick.h>
   5 #include <creaImageIOTreeView.h>
   6 #include <creaImageIOSystem.h>
   7
   8 //#include <map>
   9 #include <vtkImageData.h>
  10 #include <creaImageIOMultiThreadImageReader.h>
  11
  12 // Signal/slot mechanism for progress events
  13 #include <boost/signal.hpp>
  14 #include <boost/bind.hpp>
  15
  16 #define GIMMICK_NO_IMAGE_SELECTION 0
  17 #define GIMMICK_2D_IMAGE_SELECTION 2
  18 #define GIMMICK_3D_IMAGE_SELECTION 3
  19 #define GIMMICK_4D_IMAGE_SELECTION 4
  20
  21 #define NATIVE 0
  22 #define _2D 2
  23 #define _3D 3
  24
  25
  26 namespace creaImageIO
  27 {
  28         /**
  29         * \ingroup View
  30         */
  31     //=====================================================================
  32
  33     //=====================================================================
  34     ///Abstract class that handles views, attributes and previews (GUI) for Gimmick.
  35         class GimmickView: public MultiThreadImageReaderUser
  36     {
  37     public:
  38       /// Ctor
  39       GimmickView(Gimmick*, int number_of_threads = 0 );
  40       /// Virtual destructor
  41       virtual ~GimmickView();
  42       /// Initializes the view :
  43       /// Creates the TreeViews for all the TreeHandler of the Controller
  44       ///
  45       virtual void Initialize();
  46
  47       /// Type of map from View name to TreeView*
  48       /// (This map is equivalent for Views of the TreeHandlerMap of Gimmick)
  49       typedef std::map<std::string, TreeView*> TreeViewMapType;
  50
  51       /// Returns the TreeViewMap (ref)
  52       TreeViewMapType& GetTreeViewMap() { return mTreeViewMap; }
  53       /// Returns the TreeViewMap (const ref)
  54       const TreeViewMapType& GetTreeViewMap() const
  55       { return mTreeViewMap; }
  56
  57       /// Finalize
  58       virtual void Finalize();
  59
  60           //Returns the maximal priority
  61           int GetMaximalPriority(){return mReader.GetMaximalPriority();}
  62
  63           ///Returns the selected Images and validates to see if they comply with the given parameter(<4D)
  64           vtkImageData* GetSelectedImage(int dim);
  65       ///Adds the selected Images to the given vector and validates to see if they comply with the given parameter (4D)
  66       virtual void GetSelectedImages(std::vector<vtkImageData*>& s, int dim)
  67           { GimmickError("INTERNAL ERROR : GetSelectedImages not implemented"); }
  68
  69       virtual void GetSelectedFiles(std::vector<std::string>& s)
  70       { GimmickError("INTERNAL ERROR : GetSelectedFiles not implemented"); }
  71       virtual void OnSelectionChange(std::vector<tree::Node*>& s)
  72       { GimmickError("INTERNAL ERROR : OnSelectionChange not implemented"); }
  73
  74       ///Validates the dimension compliance of the images with the maximum and minimum given, and between their sizes
  75       bool ValidateSelected (std::vector<tree::Node*>& sel, int min_dim, int max_dim);
  76
  77       ///Reads the vector of nodes, builds images in the dimension required and returns them in the supplied vector.
  78       void ReadImagesNotThreaded(std::vector<vtkImageData*>& s,std::vector<tree::Node*> im, int dim);
  79       ///Requests the reading of an image with priority and index in the
  80       /// current selection (-1 if not in selection)
  81       void RequestReading(tree::Node* n, int prio, int selection_index);
  82
  83       ///Returns true if the ImageEventQueue is empty
  84       bool IsQueueEmpty(){return mImageEventQueue.empty();}
  85       ///Clears the queue
  86       void ClearQueue(){mImageEventQueue.clear();}
  87       ///Returns the next in line EventType's image
  88       vtkImageData* GetNextImageQueued(){return mImageEventQueue.front().image;}
  89       ///Returns the next in line EventType's node
  90       tree::Node* GetNextNodeQueued(){return mImageEventQueue.front().node;}
  91       ///Returns the next in line EventType's index in selection
  92       int GetNextSelectionIndexQueued(){return mImageEventQueue.front().index;}
  93       ///Unqueus the next in line EventType
  94       void UnqueueNext(){mImageEventQueue.pop_front();}
  95
  96
  97       ///Obtains the message of the state
  98       std::string GetMessage(){return mMess;}
  99       ///Obtains the message of the state
 100       void SetMessage(std::string mess){mMess=mess;}
 101
 102       /// Create the tree views
 103       void CreateTreeViews();
 104
 105       /// Create the tree view for TreeHandler provided
 106       virtual void CreateTreeView( TreeHandler*)
 107       { GimmickError("INTERNAL ERROR : CreateTreeView not implemented"); }
 108
 109       /// Updates the TreeView of given name from level l to bottom
 110       /// (calls the virtual method TreeView::UpdateLevel(l))
 111       virtual void UpdateTreeViewLevel(const std::string&, int l);
 112           // Multi-thread image reader callback
 113           void OnMultiThreadImageReaderEvent(const std::string& filename,
 114                                        MultiThreadImageReaderUser::EventType t,
 115                                        vtkImageData* image);
 116
 117       vtkImageData* GetDefaultImage() { return mReader.GetImage(""); }
 118
 119
 120       //=============================================
 121       typedef boost::signal<void (bool)>  ValidationSignalType;
 122       typedef ValidationSignalType::slot_function_type ValidationCallbackType;
 123       //=============================================
 124
 125      //==================================================================
 126       /// Adds the function f to the list of functions to call
 127       /// when the addition progresses.
 128       /// f is of type ProgressCallbackType which is:
 129       /// void (*ProgressCallbackType)(Progress&)
 130       /// To pass a member function 'f' of an instance 'c' of a class 'C'
 131       /// as callback you have to 'bind' it, i.e. call:
 132       /// ConnectValidationObserver ( boost::bind( &C::f , c, _1 ) );
 133       void ConnectValidationObserver(ValidationCallbackType callback);
 134      //==================================================================
 135
 136
 137     private:
 138       /// Controller which manages the interaction with the model
 139       Gimmick* mGimmick;
 140       /// The views
 141       TreeViewMapType mTreeViewMap;
 142       /// The message that results from the validation
 143       std::string mMess;
 144
 145       /// Multi-thread image reader
 146       MultiThreadImageReader mReader;
 147       /// Internal type of image reading event
 148       /// If the image pointer is non null then the image is available (loaded)
 149       /// else it has been unloaded
 150       struct ImageEventType
 151       {
 152         ImageEventType( tree::Node* no = 0,
 153                         vtkImageData* im = 0,
 154                         int sel_index = -1)
 155           : node(no), image(im), index(sel_index) {}
 156         ImageEventType(vtkImageData* im )
 157           : image(im) {}
 158         tree::Node* node;
 159         vtkImageData* image;
 160         int index;
 161       };
 162       typedef std::map<std::string,ImageEventType> ImageEventTypeMap;
 163       /// Map of images' names to ImageEventType
 164       /// Used to associated a filename to a the data of a request
 165       ImageEventTypeMap mImageEventMap;
 166       // queue of image event
 167       typedef std::deque<ImageEventType> ImageEventQueueType;
 168       ImageEventQueueType mImageEventQueue;
 169
 170           ValidationSignalType mValidationSignal;
 171
 172         };
 173   // EO class GimmickView
 174     //=====================================================================
 175
 176
 177   /*
 178
 179
 180
 181
 182
 183
 184
 185
 186         //====================================================================
 187         // General
 188         //====================================================================
 189
 190     /// Returns the size of the current selection
 191     virtual int GetSelectionSize() { return 0; }
 192     /// Returns true if there is a valid selection
 193     virtual bool IsSelectionValid(){ return false; }
 194     /// Returns the vector of full filenames of selected images
 195     virtual void GetSelectedFiles(std::vector<std::string>&){ return; }
 196     /// Returns the vector of images corresponding to selection
 197     virtual void GetSelectedImages(std::vector<vtkImageData*>&){ return; }
 198     /// Returns the vector of DicomNode corresponding to selection
 199     virtual void GetSelectedDicomNodes(std::vector<DicomNode*>&){ return; }
 200    /// Returns the DicomNode corresponding to the tree item
 201     virtual DicomNode* GetDicomNodeOfItem(const TreeItemId& i);
 202
 203
 204         /// Type of list of DicomDatabase
 205     typedef std::vector<DicomDatabase*> DicomDatabaseListType;
 206     /// Returns the list of DicomDatabase open
 207     virtual DicomDatabaseListType& GetDicomDatabaseList()
 208     { return null; }
 209     /// Returns the list of DicomDatabase open (const)
 210     virtual const DicomDatabaseListType& GetDicomDatabaseList() const
 211     { return null; }
 212
 213         protected:
 214         ///Opens an existing database, or else, creates a local database.
 215     virtual void OpenOrNewDatabase(bool open){ return; }
 216         ///Shows the help
 217         virtual void ShowHelp();
 218
 219         private:
 220         ///Gets the extension of the database
 221         const std::string& GetDatabaseExtension() { return null; }
 222         ///Sets the extension of the database
 223     virtual void SetDatabaseExtension(const std::string& ext){ return; }
 224
 225
 226         //====================================================================
 227     // Preview Display Related
 228         //====================================================================
 229
 230
 231     ///Shows the image sent as a parameter
 232         private:
 233          virtual void ShowImage(vtkImageData* image){ return; }
 234
 235         //====================================================================
 236     // Favorites Related
 237         //====================================================================
 238
 239
 240         public:
 241         ///Loads or creates a favorites database
 242     virtual void LoadOrCreateFavoritesDatabase(){ return; }
 243         private:
 244         ///Creates the user settings directory
 245     void CreateUserSettingsDirectory(){ return; }
 246         ///Obtains the user settings directory
 247         const std::string& GetUserSettingsDirectory(){ return null; }
 248
 249         //====================================================================
 250         // Attribute Display Related
 251         //====================================================================
 252
 253
 254         ///Shows the Information regarding the node sent as a parameter
 255         private:
 256      virtual void ShowInformation(DicomNode*){ return; }
 257
 258         //====================================================================
 259     // Tree Display Related
 260     //====================================================================
 261
 262         protected:
 263     /// Completely rebuilds the view with
 264     /// current DicomDatabaseList
 265     virtual void RebuildView(){ return; }
 266         /// Recursively updates the part of the view corresponding
 267     /// to the DicomDatabase passed
 268     /// i.e. creates items for the DicomNode which do not have
 269     ///      deletes obsolete items (whose DicomNode has been deleted)
 270     virtual void UpdateDicomDatabaseView(DicomDatabase*){ return; }
 271     /// Recursively updates the part of the view corresponding
 272     /// to the DicomNode provided.
 273     /// parent is its parent in the tree (where to insert / remove it)
 274         virtual void UpdateDicomNodeView(DicomNode* n, const TreeItemId& parent){ return; }
 275
 276         private:
 277         ///Type definition of the data regarding the tree
 278     typedef WxGimmickTreeItemData TreeItemData;
 279         ///Gets the item data of the tree item passed as a parameter
 280     TreeItemData* GetItemData(const TreeItemId& id){ return null; }
 281     ///Type definition of the data insid a node of the tree
 282     typedef WxGimmickDicomNodeData NodeData;
 283
 284
 285         //====================================================================
 286     // Class Attributes
 287     //====================================================================
 288
 289
 290         int mSelectionType;
 291     int mSelectionMaxImageDimension;
 292     int mCurrentSelectionImageSize[4];
 293
 294         ///Existent Database List
 295     DicomDatabaseListType mDicomDatabaseList;
 296         ///Favorites database
 297     DicomDatabase* mFavoriteDatabase;
 298
 299         ///Path to the database list file
 300     std::string mDatabaseListFile;
 301         ///Extension of the database
 302     std::string mDatabaseExtension;
 303
 304     bool mJustStarted;
 305
 306     int  mFirstDicomDatabaseIconIndex;
 307
 308    // Previewer
 309     vtkImageViewer2* mViewer;
 310
 311     int mx1,mx2,my1,my2,mz1,mz2;
 312     double mspx,mspy,mspz;
 313
 314     // Image preview :
 315     // Multi-thread image reader
 316     MultiThreadImageReader mReader;
 317     // map of images name to node
 318     std::map<std::string,DicomNode*> mImageFileNameToNode;
 319   */
 320
 321 } // EO namespace creaImageIO
 322
 323 // EOF
 324 #endif