IMP::em2d::SpiderImageReaderWriter Class Reference

---

Detailed Description

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

Inherits IMP::em2d::ImageReaderWriter.

List of all members.

Public Member Functions
	SpiderImageReaderWriter ()
	SpiderImageReaderWriter (const String &filename, bool skip_type_check, bool force_reversed, bool skip_extra_checkings)
	Full constructor.
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.
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
std::size_t	__hash__ () const
virtual std::string	get_type_name () const =0
	Return a string identifying the type of the object.
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.
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)

Static Public Member Functions
static SpiderImageReaderWriter *	get_from (IMP::base::Object *o)
Static Public Member Functions inherited from IMP::em2d::ImageReaderWriter
static ImageReaderWriter *	get_from (IMP::base::Object *o)

Public Attributes
String	filename_
bool	force_reversed_
bool	skip_extra_checkings_
bool	skip_type_check_

---

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

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

Full constructor.

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

---

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

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

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

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

Writes an EM image in Spider format.

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

---

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

• SpiderImageReaderWriter.h