soma-io  5.1.2
imagereader.h
Go to the documentation of this file.
1 /* This software and supporting documentation are distributed by
2  * Institut Federatif de Recherche 49
3  * CEA/NeuroSpin, Batiment 145,
4  * 91191 Gif-sur-Yvette cedex
5  * France
6  *
7  * This software is governed by the CeCILL-B license under
8  * French law and abiding by the rules of distribution of free software.
9  * You can use, modify and/or redistribute the software under the
10  * terms of the CeCILL-B license as circulated by CEA, CNRS
11  * and INRIA at the following URL "http://www.cecill.info".
12  *
13  * As a counterpart to the access to the source code and rights to copy,
14  * modify and redistribute granted by the license, users are provided only
15  * with a limited warranty and the software's author, the holder of the
16  * economic rights, and the successive licensors have only limited
17  * liability.
18  *
19  * In this respect, the user's attention is drawn to the risks associated
20  * with loading, using, modifying and/or developing or reproducing the
21  * software by the user in light of its specific status of free software,
22  * that may mean that it is complicated to manipulate, and that also
23  * therefore means that it is reserved for developers and experienced
24  * professionals having in-depth computer knowledge. Users are therefore
25  * encouraged to load and test the software's suitability as regards their
26  * requirements in conditions enabling the security of their systems and/or
27  * data to be ensured and, more generally, to use and operate it in the
28  * same conditions as regards security.
29  *
30  * The fact that you are presently reading this means that you have had
31  * knowledge of the CeCILL-B license and that you accept its terms.
32  */
33 
34 #ifndef SOMAIO_IMAGE_IMAGEREADER_H
35 #define SOMAIO_IMAGE_IMAGEREADER_H
36 //--- soma-io ----------------------------------------------------------------
38 #include <soma-io/datasourceinfo/datasourceinfo.h> // member
39 //--- cartobase --------------------------------------------------------------
40 #include <cartobase/object/object.h> // to use none()
41 //--- system -----------------------------------------------------------------
42 #include <vector>
43 //----------------------------------------------------------------------------
44 
45 namespace soma
46 {
47 
55  template<typename T>
57  {
58  public:
59  ImageReader();
60  virtual ~ImageReader();
61 
78  virtual void read( T * dest, DataSourceInfo & dsi,
79  std::vector<int> & pos,
80  std::vector<int> & size,
81  std::vector<long> & stride,
82  carto::Object options = carto::none() );
83 
90  virtual void updateParams( DataSourceInfo & dsi );
92  virtual void resetParams();
93  virtual ImageReader<T>* cloneReader() const = 0;
96  virtual std::string formatID() const = 0;
97 
98  virtual bool open( DataSourceInfo & dsi );
99  virtual void close( DataSourceInfo & dsi );
100  virtual bool isOpen( const DataSourceInfo & dsi ) const;
101  };
102 
103 }
104 
105 #endif
Informative object used by IO system.
ImageReader is a low level Image reader.
Definition: imagereader.h:57
virtual std::string formatID() const =0
Format identifier (abstract).
virtual void close(DataSourceInfo &dsi)
virtual ~ImageReader()
Definition: imagereader_d.h:71
virtual ImageReader< T > * cloneReader() const =0
virtual bool isOpen(const DataSourceInfo &dsi) const
virtual void read(T *dest, DataSourceInfo &dsi, std::vector< int > &pos, std::vector< int > &size, std::vector< long > &stride, carto::Object options=carto::none())
Reading a region of a Image/Volume at a given resolution to a pre-allocated buffer.
Definition: imagereader_d.h:83
virtual void resetParams()
Abstract : empty specialized ImageReader's parameters.
Definition: imagereader_d.h:58
virtual void updateParams(DataSourceInfo &dsi)
Abstract : set specialized ImageReader's parameters.
Definition: imagereader_d.h:53
virtual bool open(DataSourceInfo &dsi)
Definition: imagereader_d.h:97
Object none()
Definition: allocator.h:49