src/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 namespace creaImageIO
  27 {
  28         /**
  29         * \ingroup View
  30         */
  31
  32         class ImageExtent;
  33     //=====================================================================
  34
  35     //=====================================================================
  36     ///Abstract class that handles views, attributes and previews (GUI) for Gimmick.
  37         class GimmickView: public MultiThreadImageReaderUser
  38     {
  39     public:
  40       /// Ctor
  41       GimmickView(boost::shared_ptr<Gimmick>, int number_of_threads = 0 );
  42       /// Virtual destructor
  43       virtual ~GimmickView();
  44       /// Initializes the view :
  45       /// Creates the TreeViews for all the TreeHandler of the Controller
  46       ///
  47       virtual void Initialize();
  48
  49       /// Type of map from View name to TreeView*
  50       /// (This map is equivalent for Views of the TreeHandlerMap of Gimmick)
  51       typedef std::map<std::string, TreeView*> TreeViewMapType;
  52
  53       /// Returns the TreeViewMap (ref)
  54       TreeViewMapType& GetTreeViewMap() { return mTreeViewMap; }
  55       /// Returns the TreeViewMap (const ref)
  56       const TreeViewMapType& GetTreeViewMap() const
  57       { return mTreeViewMap; }
  58
  59       /// Finalize
  60       virtual void Finalize();
  61
  62           ///Returns the maximal priority
  63       int GetMaximalPriority(){return mReader.GetMaximalPriority();}
  64
  65       ///Adds the selected Images to the given vector
  66       virtual void GetSelectedImagesInVector(std::vector<vtkImageData*>& s, int dim)
  67         { GimmickError("INTERNAL ERROR : GetSelectedImagesInVector not implemented"); }
  68
  69       ///Adds the selected Images to the given vector and validates to see if they comply with the given parameter (4D)
  70       virtual void GetSelectedImages(std::vector<vtkImageData*>& s, int dim)
  71           { GimmickError("INTERNAL ERROR : GetSelectedImages not implemented"); }
  72
  73       virtual void GetSelectedFiles(std::vector<std::string>& s)
  74       { GimmickError("INTERNAL ERROR : GetSelectedFiles not implemented"); }
  75
  76           virtual void GetImages(int dim, std::vector<std::string> files, std::vector<vtkImageData*>& s)
  77           { GimmickError("INTERNAL ERROR : GetImages not implemented"); }
  78
  79       virtual void OnSelectionChange(const std::vector<tree::Node*>& s, bool isSelection, int selection, bool mProcess)
  80       { GimmickError("INTERNAL ERROR : OnSelectionChange not implemented"); }
  81
  82            virtual void ClearSelection()
  83       { GimmickError("INTERNAL ERROR : ClearSelection not implemented"); }
  84
  85           ///Adds a file to ignore
  86           virtual void AddIgnoreFile(tree::Node* toRemove)
  87           { GimmickError("INTERNAL ERROR : AddIgnoreFile not implemented"); }
  88
  89           ///Copies selected files
  90           virtual void CopyFiles(const std::vector<std::string>& filenames)
  91           { GimmickError("INTERNAL ERROR : CopyFiles not implemented"); }
  92
  93           ///Edits the fields of a given node
  94           virtual void CreateEditFieldsDialog(tree::Node* node, std::vector<std::string> names, std::vector<std::string> keys)
  95           { GimmickError("INTERNAL ERROR : EditFields not implemented"); }
  96
  97           /// Anonymize or de-anonymize data
  98           void Anonymize(std::vector<std::string> i_filenames, int type);
  99
 100
 101           /// Display all Dicom Tags
 102           virtual void DumpTags(const std::string filename)
 103           {GimmickError("INTERNAL ERROR : DumpTags not implemented"); }
 104
 105             ///Edits the fields of a given node
 106           virtual void ExportToStorage(const std::vector<std::string> keys)
 107           { GimmickError("INTERNAL ERROR : ExportToStorage not implemented"); }
 108
 109            ///Copies selected files
 110           virtual void SaveAs(const std::vector<std::string>& filenames)
 111           { GimmickError("INTERNAL ERROR : SaveAs not implemented"); }
 112
 113           /// No selected image
 114           bool NoValidateSelected();
 115
 116       ///Validates the dimension compliance of the images with the maximum and minimum given, and between their sizes
 117       bool ValidateSelected (tree::Node* sel, int min_dim, int max_dim);
 118
 119       ///Reads the vector of images, builds it in the dimension required and returns them in the supplied vector.
 120           void ReadImagesNotThreaded(std::vector<vtkImageData*>& s,std::vector<std::string> files, int dim);
 121
 122       ///Reads the vector of images, builds it in the dimension required and returns them in the supplied vector.
 123           void ReadImagesNotThreadedInVector(std::vector<vtkImageData*>& s,std::vector<std::string> files, int dim);
 124
 125 ///Requests the reading of an image with priority and index in the
 126       /// current selection (-1 if not in selection)
 127       //void RequestReading(tree::Node* n, int prio, int selection_index , ImagePointerHolder *p);
 128           void RequestReading(tree::Node* n, int prio, int selection_index , boost::shared_ptr<ImagePointerHolder> p);
 129
 130       ///Obtains the message of the state
 131       std::string GetMessage(){return mMess;}
 132
 133      ///Obtains the message of the state
 134       void SetMessage(std::string mess){mMess=mess;}
 135
 136           ///Resets the data of the extent and begins a new selection
 137           void ResetExtent();
 138
 139       /// Create the tree views
 140       void CreateTreeViews();
 141
 142           /// Create a tree view with a given name
 143           void CreateSingleTreeView(std::string &i_name);
 144
 145       /// Create the tree view for TreeHandler provided
 146       virtual void CreateTreeView( TreeHandler* )
 147       { GimmickError("INTERNAL ERROR : CreateTreeView not implemented"); }
 148
 149       /// Updates the TreeView of given name from level l to bottom
 150       /// (calls the virtual method TreeView::UpdateLevel(l))
 151       virtual void UpdateTreeViewLevel(const std::string&, int l);
 152
 153           // Multi-thread image reader callback
 154           void OnMultiThreadImageReaderEvent(const std::string& filename,
 155                                        MultiThreadImageReaderUser::EventType t,
 156                                        vtkImageData* image);
 157
 158       vtkImageData* GetDefaultImage() { return mReader.GetImage(""); }
 159
 160       //=============================================
 161       typedef boost::signal<void (bool)>  ValidationSignalType;
 162       typedef ValidationSignalType::slot_function_type ValidationCallbackType;
 163       //=============================================
 164
 165      //==================================================================
 166       /// Adds the function f to the list of functions to call
 167       /// when the addition progresses.
 168       /// f is of type ProgressCallbackType which is:
 169       /// void (*ProgressCallbackType)(Progress&)
 170       /// To pass a member function 'f' of an instance 'c' of a class 'C'
 171       /// as callback you have to 'bind' it, i.e. call:
 172       /// ConnectValidationObserver ( boost::bind( &C::f , c, _1 ) );
 173       void ConnectValidationObserver(ValidationCallbackType callback);
 174      //==================================================================
 175
 176         void modifyValidationSignal(bool ivalid);
 177
 178     private:
 179
 180         double OrderTheFileNameVector(std::vector<std::string> &im);
 181
 182       /// Controller which manages the interaction with the model
 183       boost::shared_ptr< Gimmick> mGimmick;
 184
 185       /// The views
 186       TreeViewMapType mTreeViewMap;
 187
 188       /// The message that results from the validation
 189       std::string mMess;
 190
 191       /// Multi-thread image reader
 192       MultiThreadImageReader mReader;
 193
 194       /// Internal type of image reading event
 195       /// If the image pointer is non null then the image is available (loaded)
 196       /// else it has been unloaded
 197       struct ImageEventType
 198       {
 199         ImageEventType( tree::Node* no = 0,
 200                         int sel_index = -1)
 201 //                      ImagePointerHolder* ph= 0)
 202           : node(no), index(sel_index){}//,  pointerHolder(ph){}
 203         ImageEventType(vtkImageData* im )
 204           : image(im) {}
 205         tree::Node* node;
 206         vtkImageData* image;
 207                 int index;
 208                 boost::shared_ptr<ImagePointerHolder> pointerHolder;
 209       };
 210       typedef std::map<std::string,ImageEventType> ImageEventTypeMap;
 211       /// Map of images' names to ImageEventType
 212       /// Used to associated a filename to a the data of a request
 213       ImageEventTypeMap mImageEventMap;
 214
 215       // queue of image event
 216       typedef std::deque<ImageEventType> ImageEventQueueType;
 217
 218       //ImageEventQueueType mImageEventQueue;
 219
 220           ///The current image extent
 221           boost::shared_ptr<ImageExtent> mImageExtent;
 222
 223           ///The validation signal
 224           ValidationSignalType mValidationSignal;
 225
 226           ///Boolean that determines if the selection is valid
 227           bool valid;
 228
 229           ///Boolean that determines if the reader has been started
 230           bool mReaderStarted;
 231
 232         };
 233   // EO class GimmickView
 234     //=====================================================================
 235
 236
 237 } // EO namespace creaImageIO
 238
 239 // EOF
 240 #endif