MultidimArrayGeneric Class Reference

#include <multidim_array_generic.h>

Collaboration diagram for MultidimArrayGeneric:

Public Member Functions
	MultidimArrayGeneric ()
	MultidimArrayGeneric (MultidimArrayBase *array, DataType _datatype)
	MultidimArrayGeneric (MultidimArrayGeneric &mdim, int select_slice)
	~MultidimArrayGeneric ()
void	init ()
void	clear ()
void	setDatatype (DataType imgType)
void	aliasSlice (MultidimArrayGeneric &mdim, int select_slice)
void	link (MultidimArrayBase *array)
void	resize (size_t Ndim, int Zdim, int Ydim, int Xdim, bool copy=true)
void	setDimensions (int Xdim, int Ydim, int Zdim, size_t Ndim)
void	resize (ArrayDim &adim, bool copy=true)
void	resize (MultidimArrayGeneric &mdim, bool copy=true)
void	selfReverseX ()
void	selfReverseY ()
void	selfReverseZ ()
template<typename T >
void	getArrayPointer (T *&M) const
void *	getArrayPointer () const
template<typename T >
void	getMultidimArrayPointer (MultidimArray< T > *&M) const
void	window (MultidimArrayGeneric &result, int z0, int y0, int x0, int zF, int yF, int xF, double init_value=0.) const
template<class T >
void	_window (MultidimArray< T > &result, int z0, int y0, int x0, int zF, int yF, int xF, double init_value=0.) const
void	selfWindow (int z0, int y0, int x0, int zF, int yF, int xF, double init_value=0.)
void	patch (MultidimArrayGeneric &patchArray, int x, int y)
template<typename T >
void	getSlice (int k, MultidimArray< T > &M, char axis='Z', bool reverse=false, size_t n=0) const
void	getSlice (int k, MultidimArrayGeneric *M, char axis='Z', bool reverse=false, size_t n=0) const
template<typename T1 >
void	setSlice (int k, const MultidimArray< T1 > &v, size_t n=0)
void	setSlice (int k, const MultidimArrayGeneric *v, size_t n=0)
void	getDimensions (size_t &Xdim, size_t &Ydim, size_t &Zdim, size_t &Ndim) const
void	getDimensions (size_t &Xdim, size_t &Ydim, size_t &Zdim) const
void	getDimensions (size_t &Xdim, size_t &Ydim) const
void	getDimensions (ArrayDim &adim)
void	setXmippOrigin ()
void	maxIndex (ArrayCoord &pos)
double	computeAvg () const
void	computeStats (double &avg, double &stddev, double &minval, double &maxval) const
void	computeDoubleMinMax (double &minval, double &maxval) const
void	rangeAdjust (const MultidimArrayGeneric &example, const MultidimArray< int > *mask=NULL)
MultidimArrayGeneric &	operator= (const MultidimArrayGeneric &input)
void	operator*= (double op1)
void	operator+= (const MultidimArrayGeneric &op1)
double	operator() (size_t n, int k, int i, int j) const
bool	operator== (const MultidimArrayGeneric &mdA) const
bool	equal (const MultidimArrayGeneric &op, double accuracy=XMIPP_EQUAL_ACCURACY) const
double	operator() (int i, int j) const
MultidimArrayBase &	operator() ()
const MultidimArrayBase &	operator() () const
template<typename T >
void	getImage (MultidimArray< T > &M) const
template<typename T >
void	setImage (MultidimArray< T > &M)
template<typename T1 >
void	window (MultidimArray< T1 > &result, int n0, int z0, int y0, int x0, int nF, int zF, int yF, int xF, T1 init_value=0) const

Public Attributes
DataType	datatype
MultidimArrayBase *	im

Protected Attributes
bool	destroyData

Detailed Description

MultidimArrayGeneric class to handle arrays with independence of the data type

Definition at line 111 of file multidim_array_generic.h.

Constructor & Destructor Documentation

MultidimArrayGeneric() [1/3]

MultidimArrayGeneric::MultidimArrayGeneric ( )

inline

Definition at line 124 of file multidim_array_generic.h.

    {
        init();
    }

MultidimArrayGeneric() [2/3]

MultidimArrayGeneric::MultidimArrayGeneric	(	MultidimArrayBase *	array,
		DataType	_datatype
	)

Constructor with pointer to array to be linked and datatype definition of the linked array.

Definition at line 28 of file multidim_array_generic.cpp.

{
    im = array;
    datatype = _datatype;
    destroyData = false;
}

MultidimArrayGeneric() [3/3]

MultidimArrayGeneric::MultidimArrayGeneric	(	MultidimArrayGeneric &	mdim,
		int	select_slice
	)

Definition at line 35 of file multidim_array_generic.cpp.

{
    init();
    setDatatype(mdim.datatype);

#define ALIAS(type) ((MultidimArray<type>*)(im))->aliasSlice(*((MultidimArray<type>*)mdim.im), select_slice);

    SWITCHDATATYPE(mdim.datatype, ALIAS)
#undef ALIAS
}

~MultidimArrayGeneric()

MultidimArrayGeneric::~MultidimArrayGeneric

(

)

Destructor.

Definition at line 46 of file multidim_array_generic.cpp.

{
    if (im != NULL  && destroyData)
        delete im;
}

Member Function Documentation

_window()

template<class T >

void MultidimArrayGeneric::_window ( MultidimArray< T > &  result, int  z0, int  y0, int  x0, int  zF, int  yF, int  xF, double  init_value = 0.  ) const

inline

Definition at line 253 of file multidim_array_generic.h.

    {
#define WINDOW(type) ((MultidimArray<type>*)im)->window(result, z0,y0,x0,zF,yF,xF,(T)init_value);
        SWITCHDATATYPE(datatype,WINDOW)
#undef WINDOW

    }

aliasSlice()

void MultidimArrayGeneric::aliasSlice	(	MultidimArrayGeneric &	mdim,
		int	select_slice
	)

Definition at line 162 of file multidim_array_generic.cpp.

{
    setDatatype(mdim.datatype);

#define ALIAS(type) ((MultidimArray<type>*)(im))->aliasSlice(*((MultidimArray<type>*)mdim.im), select_slice);

    SWITCHDATATYPE(mdim.datatype, ALIAS)
#undef ALIAS
}

clear()

void MultidimArrayGeneric::clear

(

)

Definition at line 58 of file multidim_array_generic.cpp.

{
    if (im != NULL && destroyData)
    {
        im->clear();
        delete im;
        init();
    }
}

computeAvg()

double MultidimArrayGeneric::computeAvg ( ) const

inline

Compute average

Definition at line 372 of file multidim_array_generic.h.

    {
        return im->computeAvg();
    }

computeDoubleMinMax()

void MultidimArrayGeneric::computeDoubleMinMax ( double &  minval, double &  maxval  ) const

inline

Compute minimum and maximum as double values.

Definition at line 397 of file multidim_array_generic.h.

    {
#define COMPUTESDOUBLEMINMAX(type) ((MultidimArray<type>*)(im))->computeDoubleMinMax(minval, maxval);
        SWITCHDATATYPE(datatype,  COMPUTESDOUBLEMINMAX)
#undef COMPUTESDOUBLEMINMAX

    }

computeStats()

void MultidimArrayGeneric::computeStats ( double &  avg, double &  stddev, double &  minval, double &  maxval  ) const

inline

Compute statistics.

The average, standard deviation, minimum and maximum value are returned.

Definition at line 382 of file multidim_array_generic.h.

    {
#define COMPUTESTATS(type) type Tminval(0); \
                           type Tmaxval(0); \
                           ((MultidimArray<type>*)(im))->computeStats(avg, stddev, Tminval, Tmaxval);\
                           minval = Tminval;\
                           maxval = Tmaxval;

        SWITCHDATATYPE(datatype,  COMPUTESTATS)
#undef COMPUTESTATS

    }

equal()

bool MultidimArrayGeneric::equal	(	const MultidimArrayGeneric &	op,
		double	accuracy = XMIPP_EQUAL_ACCURACY
	)		const

Equality.

Returns true if this object has got the same shape (origin and size) than the argument and the same values (within accuracy).

Definition at line 147 of file multidim_array_generic.cpp.

{
    if (datatype != op.datatype)
    {
        return false;
    }

#define COMPARE(type) return ((MultidimArray<type>*)im)->equal(*(MultidimArray<type>*)op.im,accuracy);
    SWITCHDATATYPE(datatype,COMPARE)
#undef COMPARE
}

getArrayPointer() [1/2]

template<typename T >

void MultidimArrayGeneric::getArrayPointer ( T *&  M ) const

inline

Return a pointer to internal multidimarray casted to template T.

Definition at line 212 of file multidim_array_generic.h.

    {
#define GETMULTIDIMARRAY(type) M = (T*) (((MultidimArray<type>*) im)->data);
        SWITCHDATATYPE(datatype,GETMULTIDIMARRAY)
#undef GETMULTIDIMARRAY

    }

getArrayPointer() [2/2]

void* MultidimArrayGeneric::getArrayPointer ( ) const

inline

Definition at line 220 of file multidim_array_generic.h.

    {
        void *res;
#define GETMULTIDIMARRAY(type) res = (void *) (((MultidimArray<type>*) im)->data);
        SWITCHDATATYPE(datatype,GETMULTIDIMARRAY)
#undef GETMULTIDIMARRAY
        return res;
    }

getDimensions() [1/4]

void MultidimArrayGeneric::getDimensions ( size_t &  Xdim, size_t &  Ydim, size_t &  Zdim, size_t &  Ndim  ) const

inline

Get the dimensions of the linked array.

Definition at line 336 of file multidim_array_generic.h.

    {
        im->getDimensions(Xdim,Ydim,Zdim,Ndim);
    }

getDimensions() [2/4]

void MultidimArrayGeneric::getDimensions ( size_t &  Xdim, size_t &  Ydim, size_t &  Zdim  ) const

inline

Definition at line 341 of file multidim_array_generic.h.

    {
        size_t Ndim;
        im->getDimensions(Xdim,Ydim,Zdim,Ndim);
    }

getDimensions() [3/4]

void MultidimArrayGeneric::getDimensions ( size_t &  Xdim, size_t &  Ydim  ) const

inline

Definition at line 347 of file multidim_array_generic.h.

    {
        size_t Zdim, Ndim;
        im->getDimensions(Xdim,Ydim,Zdim,Ndim);
    }

getDimensions() [4/4]

void MultidimArrayGeneric::getDimensions ( ArrayDim &  adim )

inline

Definition at line 353 of file multidim_array_generic.h.

    {
        im->getDimensions(adim);
    }

getImage()

template<typename T >

void MultidimArrayGeneric::getImage ( MultidimArray< T > &  M ) const

inline

Copy the image in MultidimarrayGeneric to a specific T MultidimArray

Definition at line 490 of file multidim_array_generic.h.

    {
#define TYPECAST(type) typeCast(*(MultidimArray<type>*)(im), M);
        SWITCHDATATYPE(datatype, TYPECAST)
#undef TYPECAST

    }

getMultidimArrayPointer()

template<typename T >

void MultidimArrayGeneric::getMultidimArrayPointer ( MultidimArray< T > *&  M ) const

inline

Return a pointer to internal multidimarray casted to template T.

Definition at line 233 of file multidim_array_generic.h.

    {
#define GETMULTIDIMARRAY(type) M = (MultidimArray<T>*) ((MultidimArray<type>*) im);
        SWITCHDATATYPE(datatype,GETMULTIDIMARRAY)
#undef GETMULTIDIMARRAY

    }

getSlice() [1/2]

template<typename T >

void MultidimArrayGeneric::getSlice ( int  k, MultidimArray< T > &  M, char  axis = 'Z', bool  reverse = false, size_t  n = 0  ) const

inline

Copy a specific slice of the linked array.

Definition at line 289 of file multidim_array_generic.h.

    {
#define GETSLICE(type) ((MultidimArray<type>*) im)->getSlice(k, M, axis, reverse, n);
        SWITCHDATATYPE(datatype,GETSLICE)
#undef GETSLICE

    }

getSlice() [2/2]

void MultidimArrayGeneric::getSlice ( int  k, MultidimArrayGeneric *  M, char  axis = 'Z', bool  reverse = false, size_t  n = 0  ) const

inline

Copy a specific slice of the linked array.

Definition at line 300 of file multidim_array_generic.h.

    {
#define GETSLICE(type) getSlice(k, *(MultidimArray<type>*)M->im, axis, reverse, n);
        SWITCHDATATYPE(M->datatype,GETSLICE)
#undef GETSLICE

    }

init()

void MultidimArrayGeneric::init

(

void

)

Definition at line 51 of file multidim_array_generic.cpp.

{
    im = NULL;
    datatype = DT_Unknown;
    destroyData = true;
}

link()

void MultidimArrayGeneric::link

(

MultidimArrayBase *

array

)

Link the internal array base to a specific multidimarray object.

Definition at line 68 of file multidim_array_generic.cpp.

{
    im = array;
    destroyData = false;
}

maxIndex()

void MultidimArrayGeneric::maxIndex ( ArrayCoord &  pos )

inline

Definition at line 366 of file multidim_array_generic.h.

    {
        im->maxIndex(pos);
    }

operator()() [1/4]

double MultidimArrayGeneric::operator() ( size_t  n, int  k, int  i, int  j  ) const

inline

Get constant access

Definition at line 443 of file multidim_array_generic.h.

    {
        double ret;
#define GETVALUE(type) ret =  NZYX_ELEM(*(MultidimArray<type>*)im,n,k,i,j);
        SWITCHDATATYPE(datatype,GETVALUE)
#undef GETVALUE
        return ret;
    }

operator()() [2/4]

double MultidimArrayGeneric::operator() ( int  i, int  j  ) const

inline

Get constant access

Definition at line 465 of file multidim_array_generic.h.

    {
        double ret;
#define GETVALUE(type) ret = A2D_ELEM(*(MultidimArray<type>*)im,i,j);
        SWITCHDATATYPE(datatype,GETVALUE)
#undef GETVALUE
        return ret;
    }

operator()() [3/4]

MultidimArrayBase& MultidimArrayGeneric::operator() ( )

inline

Get array

Definition at line 475 of file multidim_array_generic.h.

    {
        return *im;
    }

operator()() [4/4]

const MultidimArrayBase& MultidimArrayGeneric::operator() ( ) const

inline

Get array

Definition at line 481 of file multidim_array_generic.h.

    {
        return *im;
    }

operator*=()

void MultidimArrayGeneric::operator*= ( double  op1 )

inline

*=

Definition at line 427 of file multidim_array_generic.h.

    {
#define OPERATORTIMESEQUAL(type) *((MultidimArray<type>*)(im)) *= (type)op1;
        SWITCHDATATYPE(datatype,OPERATORTIMESEQUAL)
#undef OPERATORTIMESEQUAL
    }

operator+=()

void MultidimArrayGeneric::operator+= ( const MultidimArrayGeneric &  op1 )

inline

+=

Definition at line 435 of file multidim_array_generic.h.

    {
#define OPERATORPLUSEQUAL(type) *((MultidimArray<type>*)(im)) += *((MultidimArray<type>*)(op1.im));
        SWITCHDATATYPE(datatype,OPERATORPLUSEQUAL)
#undef OPERATORPLUSEQUAL
    }

operator=()

MultidimArrayGeneric& MultidimArrayGeneric::operator= ( const MultidimArrayGeneric &  input )

inline

Assignment

Definition at line 416 of file multidim_array_generic.h.

    {
        if (&input != this && input.datatype != DT_Unknown)
        {
            setDatatype(input.datatype);
            *im = *input.im;
        }
        return *this;
    }

operator==()

bool MultidimArrayGeneric::operator==

(

const MultidimArrayGeneric &

mdA

)

const

equal operator

Definition at line 133 of file multidim_array_generic.cpp.

{
    if (datatype != mdA.datatype)
    {
        return false;

    }

#define COMPARE(type) return ( ((MultidimArray<type>*)im)->equal(*(MultidimArray<type>*)mdA.im) );
    SWITCHDATATYPE(datatype,COMPARE)
#undef COMPARE
}

patch()

void MultidimArrayGeneric::patch ( MultidimArrayGeneric &  patchArray, int  x, int  y  )

inline

Definition at line 277 of file multidim_array_generic.h.

    {
#define PATCH(type) ((MultidimArray<type>*)im)->patch(*((MultidimArray<type>*)(patchArray.im)), x, y);
        SWITCHDATATYPE(datatype, PATCH)
#undef PATCH

    }

rangeAdjust()

void MultidimArrayGeneric::rangeAdjust ( const MultidimArrayGeneric &  example, const MultidimArray< int > *  mask = NULL  )

inline

Range adjust using an example

Definition at line 408 of file multidim_array_generic.h.

    {
#define RANGEADJUST(type) ((MultidimArray<type>*)(im))->rangeAdjust(*(MultidimArray<type>*)(example.im),mask);
        SWITCHDATATYPE(datatype,RANGEADJUST)
#undef RANGEADJUST
    }

resize() [1/3]

void MultidimArrayGeneric::resize ( size_t  Ndim, int  Zdim, int  Ydim, int  Xdim, bool  copy = true  )

inline

Call the resize function of the linked array.

Definition at line 168 of file multidim_array_generic.h.

    {
        im->resize(Ndim,Zdim,Ydim,Xdim,copy);
    }

resize() [2/3]

void MultidimArrayGeneric::resize ( ArrayDim &  adim, bool  copy = true  )

inline

Definition at line 180 of file multidim_array_generic.h.

    {
        im->resize(adim, copy);
    }

resize() [3/3]

void MultidimArrayGeneric::resize ( MultidimArrayGeneric &  mdim, bool  copy = true  )

inline

Definition at line 185 of file multidim_array_generic.h.

    {
        ArrayDim adim;
        mdim.getDimensions(adim);
        im->resize(adim, copy);
    }

selfReverseX()

void MultidimArrayGeneric::selfReverseX ( )

inline

Reverse matrix values over X axis, keep in this object.

Definition at line 193 of file multidim_array_generic.h.

    {
        im->selfReverseX();
    }

selfReverseY()

void MultidimArrayGeneric::selfReverseY ( )

inline

Reverse matrix values over Y axis, keep in this object.

Definition at line 198 of file multidim_array_generic.h.

    {
        im->selfReverseY();
    }

selfReverseZ()

void MultidimArrayGeneric::selfReverseZ ( )

inline

Reverse matrix values over Z axis, keep in this object.

Definition at line 203 of file multidim_array_generic.h.

    {
        im->selfReverseZ();
    }

selfWindow()

void MultidimArrayGeneric::selfWindow ( int  z0, int  y0, int  x0, int  zF, int  yF, int  xF, double  init_value = 0.  )

inline

Definition at line 263 of file multidim_array_generic.h.

    {
        if (im->mmapOn)
            REPORT_ERROR(ERR_MMAP, "Cannot resize the image when it is mapped to file.");

#define WINDOW(type) ((MultidimArray<type>*)im)->selfWindow(z0,y0,x0,zF,yF,xF,(type)init_value);

        SWITCHDATATYPE(datatype,WINDOW)
#undef WINDOW

    }

setDatatype()

void MultidimArrayGeneric::setDatatype

(

DataType

imgType

)

Definition at line 75 of file multidim_array_generic.cpp.

{
    clear();
    datatype = imgType;
    destroyData = true;

    switch (datatype)
    {
    case DT_Float:
        {
            MultidimArray<float> *imT = new MultidimArray<float>;
            im = imT;
        }
        break;
    case DT_UInt:
        {
            MultidimArray<unsigned int> *imT = new MultidimArray<unsigned int>;
            im = imT;
        }
        break;
    case DT_Int:
        {
            MultidimArray<int> *imT = new MultidimArray<int>;
            im = imT;
        }
        break;
    case DT_UShort:
        {
            MultidimArray<unsigned short> *imT = new MultidimArray<unsigned short>;
            im = imT;
        }
        break;
    case DT_Short:
        {
            MultidimArray<short> *imT = new MultidimArray<short>;
            im = imT;
        }
        break;
    case DT_UHalfByte:
    case DT_UChar:
        {
            MultidimArray<unsigned char> *imT = new MultidimArray<unsigned char>;
            im = imT;
        }
        break;
    case DT_SChar:
        {
            MultidimArray<char> *imT = new MultidimArray<char>;
            im = imT;
        }
        break;
    case DT_Unknown:
        REPORT_ERROR(ERR_IMG_UNKNOWN,"");
    default:
        REPORT_ERROR(ERR_NOT_IMPLEMENTED, "Datatype not implemented.");
    }
}

setDimensions()

void MultidimArrayGeneric::setDimensions ( int  Xdim, int  Ydim, int  Zdim, size_t  Ndim  )

inline

Change the internal size, the allocated memory is the same, so make sure that you are not changing the total size

Definition at line 175 of file multidim_array_generic.h.

    {
        im->setDimensions(Xdim,Ydim,Zdim,Ndim);
    }

setImage()

template<typename T >

void MultidimArrayGeneric::setImage ( MultidimArray< T > &  M )

inline

Copy in MultidimarrayGeneric an image from a specific T MultidimArray

Definition at line 501 of file multidim_array_generic.h.

    {
#define TYPECAST(type) typeCast(M, *(MultidimArray<type>*)(im));
        SWITCHDATATYPE(datatype, TYPECAST)
#undef TYPECAST

    }

setSlice() [1/2]

template<typename T1 >

void MultidimArrayGeneric::setSlice ( int  k, const MultidimArray< T1 > &  v, size_t  n = 0  )

inline

Set a specific slice of the linked array.

Definition at line 312 of file multidim_array_generic.h.

    {
#define SETSLICE(type) ((MultidimArray<type>*) im)->setSlice(k, v, n);

        SWITCHDATATYPE(datatype,SETSLICE)

#undef SETSLICE

    }

setSlice() [2/2]

void MultidimArrayGeneric::setSlice ( int  k, const MultidimArrayGeneric *  v, size_t  n = 0  )

inline

Set a specific slice of the linked array.

Definition at line 325 of file multidim_array_generic.h.

    {
#define SETSLICE(type) setSlice(k,*(MultidimArray<type>*) v->im, n);
        SWITCHDATATYPE(v->datatype,SETSLICE);
#undef SETSLICE

    }

setXmippOrigin()

void MultidimArrayGeneric::setXmippOrigin ( )

inline

Set Xmipp origin.

Definition at line 361 of file multidim_array_generic.h.

    {
        im->setXmippOrigin();
    }

window() [1/2]

void MultidimArrayGeneric::window ( MultidimArrayGeneric &  result, int  z0, int  y0, int  x0, int  zF, int  yF, int  xF, double  init_value = 0.  ) const

inline

Get a Window from the image

Definition at line 242 of file multidim_array_generic.h.

    {
#define WINDOW(type) _window(*((MultidimArray<type>*)(result.im)), z0,y0,x0,zF,yF,xF,init_value);
        SWITCHDATATYPE(result.datatype,WINDOW)
#undef WINDOW

    }

window() [2/2]

template<typename T1 >

void MultidimArrayGeneric::window ( MultidimArray< T1 > &  result, int  n0, int  z0, int  y0, int  x0, int  nF, int  zF, int  yF, int  xF, T1  init_value = 0  ) const

inline

Get window.

Definition at line 512 of file multidim_array_generic.h.

    {
#define WINDOW(type) ((MultidimArray<type>*)(im))->window(result, n0, z0, y0, x0, nF, zF, yF, xF, init_value);
        SWITCHDATATYPE(datatype, WINDOW)
#undef WINDOW

    }

Member Data Documentation

datatype

DataType MultidimArrayGeneric::datatype

Definition at line 114 of file multidim_array_generic.h.

destroyData

bool MultidimArrayGeneric::destroyData

protected

Definition at line 119 of file multidim_array_generic.h.

im

MultidimArrayBase* MultidimArrayGeneric::im

Definition at line 115 of file multidim_array_generic.h.

---

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

• xmippCore/core/multidim_array_generic.h
• xmippCore/core/multidim_array_generic.cpp