Particle Identification and Tracking
Public Member Functions | Private Member Functions | Private Attributes

utilities::Image_stack Class Reference

#include <image_stack.h>

Inheritance diagram for utilities::Image_stack:
Collaboration diagram for utilities::Image_stack:

List of all members.

Public Member Functions

 Image_stack (std::string fname)
 ~Image_stack ()
void select_plane (unsigned int plane)
 Set the plane w.
const void * get_plane_pixels () const
 Returns the data of the current plane.
Md_storeget_plane_md (const MD_parser &parser) const
 Returns the current plane's meta data.
Tuple< unsigned int, 2 > get_plane_dims () const
 Returns the plane dimensions.
WORD get_scan_step () const
 returns the plane scan_step
int get_frame_count () const
 Returns the number of planes in the image.
PIX_TYPE get_pixel_type () const
 Returns the size of the image pixels.
void initialize ()
 Initialization function.
void deinitialize ()
 Cleans up the file, but does not take the FreeImage down.

Private Member Functions

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

Private Attributes

std::string fname_
unsigned int cur_plane_
bool stack_open_
fipMultiPage src_
fipImage image_
bool convert_to_grey_
PIX_TYPE pix_type_

Constructor & Destructor Documentation

Image_stack::Image_stack ( std::string  fname)
Image_stack::~Image_stack ( )

References deinitialize().


Member Function Documentation

void Image_stack::deinitialize ( )

Cleans up the file, but does not take the FreeImage down.

References src_.

Referenced by ~Image_stack().

int Image_stack::get_frame_count ( ) const [virtual]

Returns the number of planes in the image.

Implements utilities::Image_base.

References src_.

Referenced by main().

PIX_TYPE Image_stack::get_pixel_type ( ) const [virtual]

Returns the size of the image pixels.

Implements utilities::Image_base.

References pix_type_.

utilities::Tuple< unsigned int, 2 > Image_stack::get_plane_dims ( ) const [virtual]

Returns the plane dimensions.

Implements utilities::Image_base.

References image_.

Md_store * Image_stack::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 utilities::Image_base.

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

Referenced by main().

const void * Image_stack::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 utilities::Image_base.

References image_.

WORD Image_stack::get_scan_step ( ) const [virtual]

returns the plane scan_step

Implements utilities::Image_base.

References image_.

void Image_stack::initialize ( )

Initialization function.

Opens up the file and checks the data type

References utilities::D_E, utilities::D_I, utilities::D_INDEX, utilities::D_R2, utilities::D_XPOS, utilities::D_YPOS, and fname.

Referenced by main().

void Image_stack::select_plane ( unsigned int  plane) [virtual]

Set the plane w.

Implements utilities::Image_base.

References convert_to_grey_, cur_plane_, image_, src_, and to_grey().

Referenced by main().

bool Image_stack::to_grey ( ) [private]

Converts the image to 8 bit grey scale.

References image_.

Referenced by select_plane().


Member Data Documentation

Referenced by select_plane().

unsigned int utilities::Image_stack::cur_plane_ [private]

Referenced by select_plane().

std::string utilities::Image_stack::fname_ [private]
fipImage utilities::Image_stack::image_ [private]

Referenced by get_pixel_type().

fipMultiPage utilities::Image_stack::src_ [private]

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