imageio.h

Go to the documentation of this file.

/*
 * Author: Steven Ludtke, 04/10/2003 (sludtke@bcm.edu)
 * Copyright (c) 2000-2006 Baylor College of Medicine
 *
 * This software is issued under a joint BSD/GNU license. You may use the
 * source code in this file under either license. However, note that the
 * complete EMAN2 and SPARX software packages have some GPL dependencies,
 * so you are responsible for compliance with the licenses of these packages
 * if you opt to use BSD licensing. The warranty disclaimer below holds
 * in either instance.
 *
 * This complete copyright notice must be included in any revised version of the
 * source code. Additional authorship citations may be added, but existing
 * author citations must be preserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * */

#ifndef eman__imageio_h__
#define eman__imageio_h__ 1

#include "byteorder.h"
#include "emutil.h"

using std::vector;
using std::string;

namespace EMAN
{
        class Region;
        class FloatSize;
        class IntSize;
        class Ctf;

        class ImageIO
        {
          public:
                enum IOMode
                { READ_ONLY = 1, READ_WRITE = 2, WRITE_ONLY = 3 };
          public:
                virtual ~ ImageIO();

                virtual int read_header(Dict & dict, int image_index = 0,
                                                                const Region * area = 0, bool is_3d = false) = 0;

                virtual int write_header(const Dict & dict,
                                                                 int image_index = 0,
                                                                 const Region * area = 0,
                                                                 EMUtil::EMDataType filestoragetype = EMUtil::EM_FLOAT,
                                                                 bool use_host_endian = true) = 0;

                virtual int read_data(float *data, int image_index = 0,
                                                          const Region * area = 0, bool is_3d = false) = 0;

                virtual int write_data(float *data,
                                                           int image_index = 0,
                                                           const Region * area = 0,
                                                           EMUtil::EMDataType filestoragetype = EMUtil::EM_FLOAT,
                                                           bool use_host_endian = true) = 0;

                virtual int read_ctf(Ctf & ctf, int image_index = 0);

                virtual void write_ctf(const Ctf & ctf, int image_index = 0);

                virtual void flush() = 0;

                virtual int get_nimg();

                virtual bool is_complex_mode() = 0;

                virtual bool is_image_big_endian() = 0;

                virtual bool is_single_image_format() const
                {
                        return true;
                }

                template < class T > void become_host_endian(T * data, size_t n = 1)
                {
                        if (is_image_big_endian() != ByteOrder::is_host_big_endian()) {
                                ByteOrder::swap_bytes(data, n);
                        }
                }

        protected:
                virtual void init() = 0;

                void check_read_access(int image_index);

                void check_read_access(int image_index, const float *data);

                void check_write_access(IOMode rw_mode, int image_index, int max_nimg = 0);

                void check_write_access(IOMode rw_mode, int image_index, int max_nimg,
                                                                const float *data);

                void check_region(const Region * area, const FloatSize & max_size,
                                                  bool is_new_file = false, bool inbounds_only=true);

                void check_region(const Region * area, const IntSize & max_size,
                                                  bool is_new_file = false, bool inbounds_only=true);

                FILE *sfopen(const string & filename, IOMode mode,
                                         bool * is_new = 0, bool overwrite = false);

                void getRenderMinMax(float * data, const int nx, const int ny, float& rendermin, float& rendermax, const int nz = 1);
        };

#define DEFINE_IMAGEIO_FUNC \
                int read_header(Dict & dict, int image_index = 0, const Region* area = 0, bool is_3d = false); \
                int write_header(const Dict & dict, int image_index = 0, const Region * area = 0, EMUtil::EMDataType filestoragetype = EMUtil::EM_FLOAT, bool use_host_endian = true); \
                int read_data(float* data, int image_index = 0, const Region* area = 0, bool is_3d = false); \
                int write_data(float* data, int image_index = 0, const Region * area = 0, EMUtil::EMDataType filestoragetype = EMUtil::EM_FLOAT, bool use_host_endian = true); \
                void flush(); \
                bool is_complex_mode(); \
                bool is_image_big_endian(); \
                void init()

}


#endif  //eman__imageio_h__