EMAN::FloatSize Class Reference

FloatSize is used to describe a 1D, 2D or 3D rectangular size in floating numbers. More...

#include <geometry.h>

Public Member Functions
	FloatSize (float xx=0, float yy=0, float zz=0)
	Construct a FloatSize object. More...
	FloatSize (int xx, int yy=0, int zz=0)
	Construct a FloatSize object. More...
	FloatSize (double xx, double yy=0, double zz=0)
	Construct a FloatSize object. More...
int	get_ndim () const
	Get its dimension, 1D, 2D, or 3D. More...
float	operator[] (int i) const
	Get the ith direction's size. More...
float &	operator[] (int i)
	Get the ith direction's size. More...
	operator vector< float > () const

Private Attributes
float	data [3]

Detailed Description

FloatSize is used to describe a 1D, 2D or 3D rectangular size in floating numbers.

Definition at line 104 of file geometry.h.

Constructor & Destructor Documentation

FloatSize() [1/3]

EMAN::FloatSize::FloatSize ( float  xx = 0, float  yy = 0, float  zz = 0  )

inlineexplicit

Construct a FloatSize object.

Parameters

xx	The x direction size. Default is 0.
yy	The y direction size. Default is 0.
zz	The z direction size. Default is 0.

Definition at line 113 of file geometry.h.

                {
                        data[0] = xx;
                        data[1] = yy;
                        data[2] = zz;
                }

References data.

FloatSize() [2/3]

EMAN::FloatSize::FloatSize ( int  xx, int  yy = 0, int  zz = 0  )

inline

Construct a FloatSize object.

Parameters

xx	The x direction size. Default is 0.
yy	The y direction size. Default is 0.
zz	The z direction size. Default is 0.

Definition at line 125 of file geometry.h.

                {
                        data[0] = (float)xx;
                        data[1] = (float)yy;
                        data[2] = (float)zz;
                }

References data.

FloatSize() [3/3]

EMAN::FloatSize::FloatSize ( double  xx, double  yy = 0, double  zz = 0  )

inline

Construct a FloatSize object.

Parameters

xx	The x direction size. Default is 0.
yy	The y direction size. Default is 0.
zz	The z direction size. Default is 0.

Definition at line 137 of file geometry.h.

                {
                        data[0] = (float)xx;
                        data[1] = (float)yy;
                        data[2] = (float)zz;
                }

References data.

Member Function Documentation

get_ndim()

int EMAN::FloatSize::get_ndim ( ) const

inline

Get its dimension, 1D, 2D, or 3D.

Returns

The dimension.

Definition at line 147 of file geometry.h.

                {
                        if (data[2] > 1) {
                                return 3;
                        }
                        else if (data[1] > 1) {
                                return 2;
                        }
                        else if (data[0] > 1) {
                                return 1;
                        }
                        else {
                                return 0;
                        }
                }

References data.

Referenced by EMAN::ImageIO::check_region().

operator vector< float >()

EMAN::FloatSize::operator vector< float > ( ) const

inline

Definition at line 181 of file geometry.h.

                                                      {
                        vector<float> t(data,data+3);
                        return t;
                }

References data.

operator[]() [1/2]

float & EMAN::FloatSize::operator[] ( int  i )

inline

Get the ith direction's size.

Used as a lvalue.

Parameters

i	The ith direction, with 0 is x, 1 is y, 2 is z.

Returns

The ith direction's size.

Definition at line 176 of file geometry.h.

                {
                        return data[i];
                }

References data.

operator[]() [2/2]

float EMAN::FloatSize::operator[] ( int  i ) const

inline

Get the ith direction's size.

Used as a rvalue.

Parameters

i	The ith direction, with 0 is x, 1 is y, 2 is z.

Returns

The ith direction's size.

Definition at line 167 of file geometry.h.

                {
                        return data[i];
                }

References data.

Member Data Documentation

data

float EMAN::FloatSize::data[3]

private

Definition at line 187 of file geometry.h.

Referenced by FloatSize(), get_ndim(), operator vector< float >(), and operator[]().

---

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

• geometry.h