IMP::em2d::SpiderImageReaderWriter Class Reference

#include <IMP/em2d/SpiderImageReaderWriter.h>

Inherits IMP::em2d::ImageReaderWriter.

Public Member Functions
	SpiderImageReaderWriter ()
	SpiderImageReaderWriter (const String &filename, bool skip_type_check, bool force_reversed, bool skip_extra_checkings)
	Full constructor. More...
void	read (const String &filename, em::ImageHeader &header, cv::Mat &data) const
void	read_from_floats (const String &filename, em::ImageHeader &header, cv::Mat &data) const
void	read_from_ints (const String &, em::ImageHeader &, cv::Mat &) const
void	write (const String &filename, em::ImageHeader &header, const cv::Mat &data) const
void	write_to_floats (const String &filename, em::ImageHeader &header, const cv::Mat &data) const
	Writes an EM image in Spider format. More...
void	write_to_ints (const String &, em::ImageHeader &, const cv::Mat &) const
Public Member Functions inherited from IMP::em2d::ImageReaderWriter
virtual void	read (const String &filename, em::ImageHeader &header, cv::Mat &data) const =0
virtual void	read_from_floats (const String &filename, em::ImageHeader &header, cv::Mat &data) const =0
virtual void	read_from_ints (const String &filename, em::ImageHeader &header, cv::Mat &data) const =0
virtual void	write (const String &filename, em::ImageHeader &header, const cv::Mat &data) const =0
virtual void	write_to_floats (const String &filename, em::ImageHeader &header, const cv::Mat &data) const =0
virtual void	write_to_ints (const String &filename, em::ImageHeader &header, const cv::Mat &data) const =0
Public Member Functions inherited from IMP::base::Object
virtual void	clear_caches ()
virtual IMP::base::VersionInfo	get_version_info () const =0
	Get information about the module and version of the object.
void	set_check_level (CheckLevel l)
void	set_log_level (LogLevel l)
	Set the logging level used in this object. More...
void	set_was_used (bool tf) const
void	show (std::ostream &out=std::cout) const
const std::string &	get_name () const
void	set_name (std::string name)

Public Attributes
String	filename_
bool	force_reversed_
bool	skip_extra_checkings_
bool	skip_type_check_

Additional Inherited Members
Protected Member Functions inherited from IMP::base::Object
	Object (std::string name)
	Construct an object with the given name. More...
Related Functions inherited from IMP::base::Object
typedef IMP::base::Vector < IMP::base::WeakPointer < Object > >	ObjectsTemp

Detailed Description

Class to read and write EM images in Spider format. They are stored in the header and data passed as arguments

Definition at line 31 of file SpiderImageReaderWriter.h.

Constructor & Destructor Documentation

IMP::em2d::SpiderImageReaderWriter::SpiderImageReaderWriter

(

)

Empty constructor. It does not force reversed header and does not skip any of the tests

Note

reversed is only used in case that the type_check is skipped

Definition at line 44 of file SpiderImageReaderWriter.h.

IMP::em2d::SpiderImageReaderWriter::SpiderImageReaderWriter	(	const String &	filename,
		bool	skip_type_check,
		bool	force_reversed,
		bool	skip_extra_checkings
	)

Parameters

[in]	filename	file to read
[in]	skip_type_check	if true, the check for type of image is skipped
[in]	force_reversed	if true, the reverse mode is enforced for reading and writting
[in]	skip_extra_checkings	if true, the most stringent tests for consistency of images are skipped when reading

Definition at line 59 of file SpiderImageReaderWriter.h.

Member Function Documentation

void IMP::em2d::SpiderImageReaderWriter::read_from_floats	(	const String &	filename,
		em::ImageHeader &	header,
		cv::Mat &	data
	)		const

Reads an image file in Spider format and stores the content int the header and data parameters

Parameters

[in]	filename	file to read
[in]	header	header to store the info
[in]	data	a matrix to store the grid of data of the image

The header format is already in Spider format, just read it

Definition at line 91 of file SpiderImageReaderWriter.h.

Here is the call graph for this function:

void IMP::em2d::SpiderImageReaderWriter::write_to_floats	(	const String &	filename,
		em::ImageHeader &	header,
		const cv::Mat &	data
	)		const

Parameters

[in]	filename	file to write
[in]	header	header with the image info
[in]	data	a matrix with the grid of data of the image

The image header is already in Spider format, just write it

Definition at line 134 of file SpiderImageReaderWriter.h.

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• SpiderImageReaderWriter.h