EMAN::UnevenMatrix Class Reference

a general data structure for a matrix with variable x dim size for different y More...

#include <polardata.h>

Inheritance diagram for EMAN::UnevenMatrix:

Classes
struct	Xdim
	struct to define x dimension size for each y, x0 is inclusive, x1 is one after the maximum, [x0, x1), so the corresponding x dim size is (x1-x0) More...

Public Member Functions
	UnevenMatrix ()
virtual	~UnevenMatrix ()
int	get_xsize (int y)
	get the x dim size for a given y More...
int	get_xmin (int y)
	get the minimal x dim value for a given y More...
int	get_xmax (int y)
	get the maximal x dim value for a given y, note: x1 is one out of the max More...
int	get_size ()
	get the total size of the data block More...

Protected Member Functions
void	alloc_data ()
	allocation memory for data array More...

Protected Attributes
float *	data
	store all data in one dimension float array for cache efficiency, we calculate the offset for x, y dimension More...
map< int, Xdim >	desc_data
	describe for each y, the x dimension's size and range More...
int	tot_size
	the total size of the data More...

Detailed Description

a general data structure for a matrix with variable x dim size for different y

Definition at line 49 of file polardata.h.

Constructor & Destructor Documentation

UnevenMatrix()

EMAN::UnevenMatrix::UnevenMatrix ( )

inline

Definition at line 52 of file polardata.h.

                               : data(0) {
                        printf("Welcome to UnevenMatrix\n");
                }

~UnevenMatrix()

virtual EMAN::UnevenMatrix::~UnevenMatrix ( )

inlinevirtual

Definition at line 55 of file polardata.h.

                                        {
                        if(data) {
                                delete data;
                                data = 0;
                        }
                        printf("Destructor of UnevenMatrix...\n");
                }

References data.

Member Function Documentation

alloc_data()

void UnevenMatrix::alloc_data ( )

protected

allocation memory for data array

Returns

int

Exceptions

InvalidValueException

if the desc_data map size is zero

Definition at line 55 of file polardata.cpp.

{
        if( desc_data.size() == 0 ) {
                LOGERR("No data space need to be allocated for UnevenMatrix, check you desc_data...");
                throw InvalidValueException((float)desc_data.size(), "desc_data size == 0");
        }
        
        int size = 0;   //total number of float need to be stored in data block
        map< int, Xdim >::const_iterator iter;
        int y = 0;      
        for( iter = desc_data.begin(); iter != desc_data.end(); ++iter ) {
                y = (*iter).first;
                size += get_xsize(y);
        }
        
        this->tot_size = size;
        try {
                this->data = new float[size];
        }
        catch( bad_alloc exception ) {
                LOGERR("memory allocation for UnevenMatrix failed");
        }
        catch(...) {
                LOGERR("Unknown error in memory allocation for UnevenMatrix");
        }
}

References data, desc_data, get_xsize(), InvalidValueException, LOGERR, tot_size, and y.

get_size()

int EMAN::UnevenMatrix::get_size ( )

inline

get the total size of the data block

Returns

int the number of float stored in data

Definition at line 92 of file polardata.h.

                                      {
                        return tot_size;
                }

References tot_size.

get_xmax()

int EMAN::UnevenMatrix::get_xmax ( int  y )

inline

get the maximal x dim value for a given y, note: x1 is one out of the max

Parameters

y	int the y value for which we need the corresponding maximal x dim value

Returns

int the maximal x dim value for a given y

Definition at line 86 of file polardata.h.

                                           {
                        return desc_data[y].x1 - 1;
                }

References desc_data, and y.

get_xmin()

int EMAN::UnevenMatrix::get_xmin ( int  y )

inline

get the minimal x dim value for a given y

Parameters

y	int the y value for which we need the corresponding minimal x dim value

Returns

int the minimal x dim value for a given y

Definition at line 79 of file polardata.h.

                                           {
                        return desc_data[y].x0;
                }

References desc_data, and y.

get_xsize()

int EMAN::UnevenMatrix::get_xsize ( int  y )

inline

get the x dim size for a given y

Parameters

y	int the y value for which we need the x dim size

Returns

in tthe x dim size

Definition at line 66 of file polardata.h.

                                            {
                        int xsize = desc_data[y].x1 - desc_data[y].x0;
                        if( xsize <= 0 ) {
                                throw InvalidValueException(xsize, "xsize <= 0");
                        }
                        else {
                                return xsize;
                        }
                }

References desc_data, InvalidValueException, and y.

Referenced by alloc_data().

Member Data Documentation

data

float* EMAN::UnevenMatrix::data

protected

store all data in one dimension float array for cache efficiency, we calculate the offset for x, y dimension

Definition at line 123 of file polardata.h.

Referenced by alloc_data(), and ~UnevenMatrix().

desc_data

map< int, Xdim > EMAN::UnevenMatrix::desc_data

protected

describe for each y, the x dimension's size and range

Definition at line 126 of file polardata.h.

Referenced by alloc_data(), get_xmax(), get_xmin(), and get_xsize().

tot_size

int EMAN::UnevenMatrix::tot_size

protected

the total size of the data

Definition at line 129 of file polardata.h.

Referenced by alloc_data(), and get_size().

---

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

• polardata.h
• polardata.cpp