EMAN2
Public Member Functions | Static Public Member Functions | Public Attributes | Private Attributes | List of all members
EMAN::V4L2IO Class Reference

Read-only. More...

#include <v4l2io.h>

Inheritance diagram for EMAN::V4L2IO:
Inheritance graph
[legend]
Collaboration diagram for EMAN::V4L2IO:
Collaboration graph
[legend]

Public Member Functions

 V4L2IO (const string &fname, IOMode rw_mode=READ_ONLY)
 
 ~V4L2IO ()
 
- 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)
 
static int globalinit (const char *fsp, int input=0, int brt=-1, int cont=-1, int gamma=-1, int expos=-1, int gain=-1)
 

Public Attributes

 DEFINE_IMAGEIO_FUNC
 

Private Attributes

char * filename
 
int v4l_file
 
int nx
 
int ny
 

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

Read-only.

Acquires images from the V4L2 interface in real-time (video4linux). ie - this will read from a framegrabber, etc.

Definition at line 45 of file v4l2io.h.

Constructor & Destructor Documentation

◆ V4L2IO()

EMAN::V4L2IO::V4L2IO ( const string &  fname,
IOMode  rw_mode = READ_ONLY 
)
explicit

◆ ~V4L2IO()

EMAN::V4L2IO::~V4L2IO ( )

Member Function Documentation

◆ globalinit()

static int EMAN::V4L2IO::globalinit ( const char *  fsp,
int  input = 0,
int  brt = -1,
int  cont = -1,
int  gamma = -1,
int  expos = -1,
int  gain = -1 
)
static

◆ is_valid()

static bool EMAN::V4L2IO::is_valid ( const void *  first_block)
static

Member Data Documentation

◆ DEFINE_IMAGEIO_FUNC

EMAN::V4L2IO::DEFINE_IMAGEIO_FUNC

Definition at line 51 of file v4l2io.h.

◆ filename

char* EMAN::V4L2IO::filename
private

Definition at line 57 of file v4l2io.h.

◆ nx

int EMAN::V4L2IO::nx
private

Definition at line 61 of file v4l2io.h.

◆ ny

int EMAN::V4L2IO::ny
private

Definition at line 62 of file v4l2io.h.

◆ v4l_file

int EMAN::V4L2IO::v4l_file
private

Definition at line 58 of file v4l2io.h.


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