Particle Identification and Tracking
Public Member Functions | Private Member Functions | Private Attributes | List of all members
iden::Image_series Class Reference

#include <image_series.h>

+ Inheritance diagram for iden::Image_series:
+ Collaboration diagram for iden::Image_series:

Public Member Functions

 Image_series ()
 
 ~Image_series ()
 
void select_plane (unsigned int plane)
 Set the plane w. More...
 
const void * get_plane_pixels () const
 Returns the data of the current plane. More...
 
utilities::Md_storeget_plane_md (const MD_parser &parser) const
 Returns the current plane's meta data. More...
 
utilities::Tuple< unsigned int, 2 > get_plane_dims () const
 Returns the plane dimensions. More...
 
WORD get_scan_step () const
 returns the plane scan_step More...
 
int get_frame_count () const
 Returns the number of planes in the image. More...
 
bool init (const std::string &base_name)
 
PIX_TYPE get_pixel_type () const
 Returns the size of the image pixels. More...
 

Private Member Functions

bool to_grey ()
 Converts the image to 8 bit grey scale. More...
 

Private Attributes

std::string basename_
 
std::string dirname_
 
unsigned int cur_plane_
 
bool image_open_
 
fipImage image_
 
unsigned int padding_
 
unsigned int planecount_
 
PIX_TYPE pix_type_
 

Constructor & Destructor Documentation

Image_series::Image_series ( )
Image_series::~Image_series ( )

References image_.

Member Function Documentation

int Image_series::get_frame_count ( ) const
virtual

Returns the number of planes in the image.

Implements iden::Image_base.

References planecount_.

Referenced by main().

iden::PIX_TYPE Image_series::get_pixel_type ( ) const
virtual

Returns the size of the image pixels.

Implements iden::Image_base.

References iden::ERROR, image_, iden::U16, and iden::U8.

utilities::Tuple< unsigned int, 2 > Image_series::get_plane_dims ( ) const
virtual

Returns the plane dimensions.

Implements iden::Image_base.

References image_.

Md_store * Image_series::get_plane_md ( const MD_parser parser) const
virtual

Returns the current plane's meta data.

Returns a pointer that needs to be cleaned up.

Implements iden::Image_base.

References image_, and iden::MD_parser::parse_md().

Referenced by main().

const void * Image_series::get_plane_pixels ( ) const
virtual

Returns the data of the current plane.

This pointer is managed internally and should not be deleted. This pointer is only good until the object is closed or until the plane is changed, which ever comes first. To determine how to cast this pointer call get_pixel_type.

Implements iden::Image_base.

References image_.

WORD Image_series::get_scan_step ( ) const
virtual

returns the plane scan_step

Implements iden::Image_base.

References image_.

bool Image_series::init ( const std::string &  base_name)
void Image_series::select_plane ( unsigned int  plane)
virtual
bool Image_series::to_grey ( )
private

Converts the image to 8 bit grey scale.

References image_.

Referenced by select_plane().

Member Data Documentation

std::string iden::Image_series::basename_
private

Referenced by init(), and select_plane().

unsigned int iden::Image_series::cur_plane_
private

Referenced by select_plane().

std::string iden::Image_series::dirname_
private

Referenced by init(), and select_plane().

fipImage iden::Image_series::image_
private
bool iden::Image_series::image_open_
private
unsigned int iden::Image_series::padding_
private

Referenced by init(), and select_plane().

PIX_TYPE iden::Image_series::pix_type_
private

Referenced by select_plane().

unsigned int iden::Image_series::planecount_
private

Referenced by get_frame_count(), init(), and select_plane().


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