IMP logo
IMP Reference Guide  develop.3e83b1f578,2019/10/15
The Integrative Modeling Platform
IMP::em::SpiderMapReaderWriter Class Reference

Class to read EM maps (3D) in Spider and Xmipp formats. More...

#include <IMP/em/SpiderReaderWriter.h>

+ Inheritance diagram for IMP::em::SpiderMapReaderWriter:

Detailed Description

Class to read EM maps (3D) in Spider and Xmipp formats.

Note
: Compatible only with Xmipp 2.2 and Spider floating point maps
: A DensityHeader class must be provided

Definition at line 35 of file SpiderReaderWriter.h.

Public Member Functions

 SpiderMapReaderWriter ()
 
 SpiderMapReaderWriter (String filename, bool skip_type_check, bool force_reversed, bool skip_extra_checkings)
 Full constructor. More...
 
virtual std::string get_type_name () const
 
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
void read (const char *filename, float **data, DensityHeader &header)
 Reads a map in Spider format and transfers the data and header. More...
 
void write (const char *filename, const float *data, const DensityHeader &header)
 Writes a map in Spider format from data and header. More...
 
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
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::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Constructor & Destructor Documentation

IMP::em::SpiderMapReaderWriter::SpiderMapReaderWriter ( )

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

Definition at line 44 of file SpiderReaderWriter.h.

IMP::em::SpiderMapReaderWriter::SpiderMapReaderWriter ( String  filename,
bool  skip_type_check,
bool  force_reversed,
bool  skip_extra_checkings 
)

Full constructor.

Parameters
[in]filenamefile to read
[in]skip_type_checkif true, the check for type of image is skipped
[in]force_reversedif true, the reverse mode is enforced for reading and writing
[in]skip_extra_checkingsif true, the most stringent tests for consistency of images are skipped when reading

Definition at line 59 of file SpiderReaderWriter.h.

Member Function Documentation

virtual ::IMP::VersionInfo IMP::em::SpiderMapReaderWriter::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::em::MapReaderWriter.

Definition at line 86 of file SpiderReaderWriter.h.

void IMP::em::SpiderMapReaderWriter::read ( const char *  filename,
float **  data,
DensityHeader header 
)
virtual

Reads a map in Spider format and transfers the data and header.

Parameters
[in]filenamefile to read
[in]datapointer to the structure where to store the data
[in]headerDensityHeader class where to store the info from the header.

Reimplemented from IMP::em::MapReaderWriter.

void IMP::em::SpiderMapReaderWriter::write ( const char *  filename,
const float *  data,
const DensityHeader header 
)
virtual

Writes a map in Spider format from data and header.

Parameters
[in]filenamefile to write
[in]datapointer to the structure where data are stored
[in]headerDensityHeader class where the header info is stored data from the header.

Reimplemented from IMP::em::MapReaderWriter.


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