EMAN::Df3IO Class Reference

#include <df3io.h>

Inheritance diagram for EMAN::Df3IO:

Collaboration diagram for EMAN::Df3IO:

Public Member Functions
	Df3IO (const string &fname, IOMode rw_mode=READ_ONLY)
	~Df3IO ()
Public Member Functions inherited from EMAN::ImageIO
	ImageIO (const string &fname, IOMode rw)
virtual	~ImageIO ()
virtual int	read_header (Dict &dict, int image_index=0, const Region *area=0, bool is_3d=false)=0
	Read the header from an image. More...
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
	Write a header to an image. More...
virtual int	read_data (float *data, int image_index=0, const Region *area=0, bool is_3d=false)=0
	Read the data from an image. More...
virtual int	read_data_8bit (unsigned char *data, int image_index=0, const Region *area=0, bool is_3d=false, float minval=0.0f, float maxval=0.0f)
	Read the data from an image as an 8 bit array, regardless of format. More...
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
	Write data to an image. More...
virtual int	read_ctf (Ctf &ctf, int image_index=0)
	Read CTF data from this image. More...
virtual void	write_ctf (const Ctf &ctf, int image_index=0)
	Write CTF data to this image. More...
virtual void	flush ()=0
	Flush the IO buffer. More...
virtual int	get_nimg ()
	Return the number of images in this image file. More...
virtual bool	is_complex_mode ()=0
	Is this an complex image or not. More...
virtual bool	is_image_big_endian ()=0
	Is this image in big endian or not. More...
virtual bool	is_single_image_format () const
	Is this image format only storing 1 image or not. More...
template<class T >
void	become_host_endian (T *data, size_t n=1)
	Convert data of this image into host endian format. More...
string	get_filename () const

Static Public Member Functions
static bool	is_valid (const void *first_block, off_t file_size=0)

Public Attributes
	DEFINE_IMAGEIO_FUNC

Private Attributes
unsigned short	nx
unsigned short	ny
unsigned short	nz
bool	is_new_file
float	rendermin
float	rendermax
int	renderbits

Additional Inherited Members
Public Types inherited from EMAN::ImageIO
enum	IOMode { READ_ONLY = 1 , READ_WRITE = 2 , WRITE_ONLY = 3 }
Protected Member Functions inherited from EMAN::ImageIO
virtual void	init ()=0
	Do some initialization before doing the read/write. More...
void	check_read_access (int image_index)
	Validate 'image_index' in file reading. More...
void	check_read_access (int image_index, const float *data)
	Validate 'image_index' and 'data' in file reading. More...
void	check_write_access (IOMode rw_mode, int image_index, int max_nimg=0)
	Validate rw_mode and image_index in file writing. More...
void	check_write_access (IOMode rw_mode, int image_index, int max_nimg, const float *data)
	Validate rw_mode, image_index, and data pointer in file writing. More...
void	check_region (const Region *area, const FloatSize &max_size, bool is_new_file=false, bool inbounds_only=true)
	Validate image I/O region. More...
void	check_region (const Region *area, const IntSize &max_size, bool is_new_file=false, bool inbounds_only=true)
	Validate image I/O region. More...
FILE *	sfopen (const string &filename, IOMode mode, bool *is_new=0, bool overwrite=false)
	Run fopen safely. More...
Protected Attributes inherited from EMAN::ImageIO
string	filename
IOMode	rw_mode
FILE *	file = nullptr
bool	initialized = false

Detailed Description

Definition at line 54 of file df3io.h.

Constructor & Destructor Documentation

Df3IO()

Df3IO::Df3IO ( const string &  fname, IOMode  rw_mode = READ_ONLY  )

explicit

Definition at line 40 of file df3io.cpp.

:       ImageIO(fname, rw),
        is_new_file(false), rendermin(0.0), rendermax(0.0), renderbits(16)
{
}

~Df3IO()

Df3IO::~Df3IO

(

)

Definition at line 46 of file df3io.cpp.

{
        if (file) {
                fclose(file);
                file = 0;
        }
}

References EMAN::ImageIO::file.

Member Function Documentation

is_valid()

bool Df3IO::is_valid ( const void *  first_block, off_t  file_size = 0  )

static

Definition at line 264 of file df3io.cpp.

{
        ENTERFUNC;
 
        if (!first_block) {
                return false;
        }
 
        const unsigned short *data = static_cast < const unsigned short *>(first_block);
        unsigned short nx = data[0];
        unsigned short ny = data[1];
        unsigned short nz = data[2];
 
        if(ByteOrder::is_data_big_endian(&nx) && ByteOrder::is_data_big_endian(&ny) && ByteOrder::is_data_big_endian(&nz)) {
                return true;
        }
 
        EXITFUNC;
        return false;
}

References ENTERFUNC, EXITFUNC, EMAN::ByteOrder::is_data_big_endian(), nx, ny, and nz.

Referenced by EMAN::EMUtil::get_image_type().

Member Data Documentation

DEFINE_IMAGEIO_FUNC

EMAN::Df3IO::DEFINE_IMAGEIO_FUNC

Definition at line 60 of file df3io.h.

is_new_file

bool EMAN::Df3IO::is_new_file

private

Definition at line 64 of file df3io.h.

nx

unsigned short EMAN::Df3IO::nx

private

Definition at line 63 of file df3io.h.

Referenced by is_valid().

ny

unsigned short EMAN::Df3IO::ny

private

Definition at line 63 of file df3io.h.

Referenced by is_valid().

nz

unsigned short EMAN::Df3IO::nz

private

Definition at line 63 of file df3io.h.

Referenced by is_valid().

renderbits

int EMAN::Df3IO::renderbits

private

Definition at line 67 of file df3io.h.

rendermax

float EMAN::Df3IO::rendermax

private

Definition at line 66 of file df3io.h.

rendermin

float EMAN::Df3IO::rendermin

private

Definition at line 65 of file df3io.h.

---

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

• df3io.h
• df3io.cpp