]> Creatis software - creaImageIO.git/blob - src/creaImageIOImageReader.h
#3185 creaImageIO Feature New Normal - Clean code
[creaImageIO.git] / src / creaImageIOImageReader.h
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
29 #ifndef __creaImageIOImageReader_h_INCLUDED__
30 #define __creaImageIOImageReader_h_INCLUDED__
31
32 #include <creaImageIOSystem.h>
33 #include <creaImageIOAbstractImageReader.h>
34
35 namespace creaImageIO
36 {
37
38  
39   /**
40    * \ingroup IO
41    * \brief Generic image reader which uses all the specific concrete image reader of the lib (tif, jpg, dicom, ...)
42    */
43   class CREAIMAGEIO_EXPORT ImageReader : virtual public AbstractImageReader
44   {
45   public:
46     ImageReader();
47     ~ImageReader();
48
49     /// Pushes back all kwown extensions (without dot) in the vector given
50     void PushBackExtensions(std::vector<std::string>&);
51
52     /// Returns true iff the file is readable
53     bool CanRead( const std::string& filename);
54     /// Reads and returns the image data. 
55     /// Returns an "Unreadable image" picture if fails
56     vtkImageData* ReadImage( const std::string& filename);
57     
58     /// Reads the attributes of the image.
59     /// Requested attributes names are provided as keys 
60     /// in a string to string map
61     /// On return, the values of the map are the values 
62     /// of the attributes (empty string if not available).
63     void ReadAttributes(const std::string& filename, 
64                         tree::AttributeMapType& attr);
65
66     /// Exclude specific readers 
67     /// TO DO...
68         /// Another function to read attributes for a file
69         void getAttributes(const std::string filename,
70                 std::map <std::string , std::string> &infos, std::vector<std::string> i_attr);
71     
72
73
74   protected:
75     
76     /// Register a reader
77     void Register( boost::shared_ptr<AbstractImageReader> );
78
79         std::vector<boost::shared_ptr<AbstractImageReader> > mReader;
80     vtkImageData* mUnreadableImage;
81
82     std::string mLastFilename;
83         boost::shared_ptr<AbstractImageReader> mLastReader;
84
85         bool ShallNotRead( const std::string& filename );
86
87         void UnRegister(const std::string i_val);
88
89         std::vector <std::string> mUnReader;
90     
91   private:
92
93   }; // class ImageReader
94   //=====================================================================
95
96
97
98 } // namespace creaImageIO
99
100
101
102 #endif // #ifndef __creaImageIOImageReader_h_INCLUDED__