volumeformatreader.h

Go to the documentation of this file.

/* This software and supporting documentation are distributed by
 *     Institut Federatif de Recherche 49
 *     CEA/NeuroSpin, Batiment 145,
 *     91191 Gif-sur-Yvette cedex
 *     France
 *
 * This software is governed by the CeCILL-B license under
 * French law and abiding by the rules of distribution of free software.
 * You can  use, modify and/or redistribute the software under the
 * terms of the CeCILL-B license as circulated by CEA, CNRS
 * and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the
 * same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-B license and that you accept its terms.
 */

#ifndef CARTODATA_IO_VOLUMEFORMATREADER_H
#define CARTODATA_IO_VOLUMEFORMATREADER_H
//--- soma io ----------------------------------------------------------------
#include <soma-io/config/soma_config.h>
#include <soma-io/datasource/datasource.h>
#include <soma-io/image/imagereader.h>
#include <soma-io/reader/formatreader.h>
//--- cartobase --------------------------------------------------------------
#include <cartobase/object/object.h>                           // using none()
#include <cartobase/smart/rcptr.h>                                   // member
//--- system -----------------------------------------------------------------
#include <vector>
//----------------------------------------------------------------------------

namespace carto
{
  template<typename T> class Volume;
  template<typename T> class VolumeRef;
}

namespace soma
{
  class DataSourceInfo;
  
  //==========================================================================
  //   R E A D E R   O F   V O L U M E
  //==========================================================================
  template<typename T>
  class VolumeFormatReader : public FormatReader<carto::Volume<T> >
  {
    public:
      virtual ~VolumeFormatReader();
      
      //======================================================================
      //   N E W   M E T H O D S
      //======================================================================
      virtual void read( carto::Volume<T> & obj, 
                         carto::rc_ptr<DataSourceInfo> dsi, 
                         const AllocatorContext & context, 
                         carto::Object options = carto::none() );

      void attach( carto::rc_ptr<ImageReader<T> > imr );

      virtual Volume<T>* createAndRead( carto::rc_ptr<DataSourceInfo> dsi,
                                        const AllocatorContext & context,
                                        carto::Object options );

      virtual void setupAndRead( Volume<T> & obj,
                                 carto::rc_ptr<DataSourceInfo> dsi,
                                 const AllocatorContext & context,
                                 carto::Object options );

      virtual FormatReader<carto::Volume<T> >* clone() const;

      virtual std::string formatID() const;

    protected:
      carto::rc_ptr<ImageReader<T> > _imr;
  };
  
  //==========================================================================
  //   R E A D E R   O F   P O I N T E R   T O   V O L U M E
  //==========================================================================
  template<typename T>
  class VolumeRefFormatReader : public FormatReader<carto::VolumeRef<T> >
  {
    public:
      virtual ~VolumeRefFormatReader();

      //======================================================================
      //   N E W   M E T H O D S
      //======================================================================
      virtual void read( carto::VolumeRef<T> & obj, 
                         carto::rc_ptr<DataSourceInfo> dsi, 
                         const AllocatorContext & context, 
                         carto::Object options = carto::none() );

      void attach( carto::rc_ptr<ImageReader<T> > imr );

      virtual VolumeRef<T>* createAndRead( carto::rc_ptr<DataSourceInfo> dsi,
                                        const AllocatorContext & context,
                                        carto::Object options );

      virtual void setupAndRead( VolumeRef<T> & obj,
                                 carto::rc_ptr<DataSourceInfo> dsi,
                                 const AllocatorContext & context,
                                 carto::Object options );

      virtual FormatReader<carto::VolumeRef<T> >* clone() const;
      virtual std::string formatID() const;

    protected:
      carto::rc_ptr<ImageReader<T> > _imr;
  };

}
#endif