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