emdata_io.h

Go to the documentation of this file.

/*
 * Author: Steven Ludtke, 04/10/2003 (sludtke@bcm.edu)
 * Probable contributing author: Liwei Peng
 * 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 emdata__io_h__
#define emdata__io_h__
 
 
private:
void _read_image(ImageIO *imageio, int img_index = 0,
                                bool header_only = false,
                                const Region * region = 0, bool is_3d = false);
 
void _write_image(ImageIO *imageio,
                                 int img_index = 0,
                                 EMUtil::ImageType imgtype = EMUtil::IMAGE_UNKNOWN,
                                 bool header_only = false,
                                 const Region * region = 0,
                                 EMUtil::EMDataType filestoragetype = EMUtil::EM_FLOAT,
                                 bool use_host_endian = true);
 
public:
void read_image(const string & filename, int img_index = 0,
                                bool header_only = false,
                                const Region * region = 0, bool is_3d = false,
                                EMUtil::ImageType imgtype = EMUtil::IMAGE_UNKNOWN);
 
void read_binedimage(const string & filename, int img_index = 0, int binfactor=0, bool fast = false, bool is_3d = false);
 
 
void write_image(const string & filename,
                                 int img_index = 0,
                                 EMUtil::ImageType imgtype = EMUtil::IMAGE_UNKNOWN,
                                 bool header_only = false,
                                 const Region * region = 0,
                                 EMUtil::EMDataType filestoragetype = EMUtil::EM_FLOAT,
                                 bool use_host_endian = true);
 
 
void append_image(const string & filename,
                                  EMUtil::ImageType imgtype = EMUtil::IMAGE_UNKNOWN,
                                  bool header_only = false);
 
void write_lst(const string & filename,
                           const string & reffile="", int refn=-1,
                           const string & comment="");
 
 
static vector<std::shared_ptr<EMData>> read_images(const string & filename,
                                                                          vector<int> img_indices = vector<int>(),
                                                                          EMUtil::ImageType imgtype = EMUtil::IMAGE_UNKNOWN,
                                                                          bool header_only = false);
 
static bool write_images(const string & filename,
                                                                          vector<std::shared_ptr<EMData>> imgs,
                                                                          EMUtil::ImageType imgtype = EMUtil::IMAGE_UNKNOWN,
                                                                          bool header_only = false,
                                                                          const Region * region = nullptr,
                                                                          EMUtil::EMDataType filestoragetype = EMUtil::EM_FLOAT,
                                                                          bool use_host_endian = true);
 
friend ostream& operator<<(ostream& out, const EMData& obj);
 
#endif  //emdata__io_h__