Vectorial_MultidimArray Class Reference

#include <vectorial.h>

Public Member Functions
Shape
void	resize (int Zdim, int Ydim, int Xdim)
void	resize (const MultidimArray< double > &V)
void	clear ()
void	printShape () const
void	initZeros ()
void	setXmippOrigin ()
Component access
void	vector_at (int k, int i, int j, Matrix1D< double > &result) const
const MultidimArray< double > &	X () const
MultidimArray< double > &	X ()
const MultidimArray< double > &	Y () const
MultidimArray< double > &	Y ()
const MultidimArray< double > &	Z () const
MultidimArray< double > &	Z ()
double	X (int k, int i, int j) const
double &	X (int k, int i, int j)
double	Y (int k, int i, int j) const
double &	Y (int k, int i, int j)
double	Z (int k, int i, int j) const
double &	Z (int k, int i, int j)
Utilities
void	normalize_all_vectors ()
void	module (MultidimArray< double > &result) const
void	write (const FileName &fn) const
Arithmetic operations
Vectorial_MultidimArray	operator+ (const Vectorial_MultidimArray &op1) const
Vectorial_MultidimArray	operator- (const Vectorial_MultidimArray &op1) const
Vectorial_MultidimArray	operator* (const Vectorial_MultidimArray &op1) const
Vectorial_MultidimArray	operator/ (const Vectorial_MultidimArray &op1) const
Vectorial_MultidimArray	operator^ (const Vectorial_MultidimArray &op1) const
void	operator+= (const Vectorial_MultidimArray &op1)
void	operator-= (const Vectorial_MultidimArray &op1)
void	operator*= (const Vectorial_MultidimArray &op1)
void	operator/= (const Vectorial_MultidimArray &op1)
void	operator^= (const Vectorial_MultidimArray &op1)
Vectorial_MultidimArray	operator+ (double op1) const
Vectorial_MultidimArray	operator- (double op1) const
Vectorial_MultidimArray	operator* (double op1) const
Vectorial_MultidimArray	operator/ (double op1) const
Vectorial_MultidimArray	operator^ (double op1) const
void	operator+= (const double &op1)
void	operator-= (const double &op1)
void	operator*= (const double &op1)
void	operator/= (const double &op1)
void	operator^= (const double &op1)

Detailed Description

Vectorial volume.

A vectorial volume is a "normal" MultidimArray whose elements are vectors instead of single elements are doubles, floats, ... You can access independently to any of the three components as a whole volume, ie, a volume with all the X components, another with all Y components, ... or access to the vector at a given position (logical positions as in ), the X component at that position or the X component at a given multidimensional array position.

You can perform arithmetic operations on these vectors, and other common operations such as resize, printShape, ...

Definition at line 65 of file vectorial.h.

Member Function Documentation

clear()

void Vectorial_MultidimArray::clear ( )

inline

Clear.

Definition at line 96 of file vectorial.h.

    {
        __X.clear();
        __Y.clear();
        __Z.clear();
    }

initZeros()

void Vectorial_MultidimArray::initZeros ( )

inline

Init zeros.

Definition at line 112 of file vectorial.h.

    {
        __X.initZeros();
        __Y.initZeros();
        __Z.initZeros();
    }

module()

void Vectorial_MultidimArray::module ( MultidimArray< double > &  result ) const

inline

Module of all vectors.

A volume with all vector modules at each position is returned.

Definition at line 253 of file vectorial.h.

    {
        result.resize(__X);

        FOR_ALL_ELEMENTS_IN_MULTIDIM_VECTORIAL_MATRIX3D(*this)
        DIRECT_MULTIDIM_ELEM(result,  n) = sqrt(
                                               DIRECT_MULTIDIM_ELEM(__X,n) * DIRECT_MULTIDIM_ELEM(__X,n) +
                                               DIRECT_MULTIDIM_ELEM(__Y,n) * DIRECT_MULTIDIM_ELEM(__Y,n) +
                                               DIRECT_MULTIDIM_ELEM(__Z,n) * DIRECT_MULTIDIM_ELEM(__Z,n));
    }

normalize_all_vectors()

void Vectorial_MultidimArray::normalize_all_vectors ( )

inline

Substitute each vector by its unit vector.

Definition at line 235 of file vectorial.h.

    {
        FOR_ALL_ELEMENTS_IN_MULTIDIM_VECTORIAL_MATRIX3D(*this)
        {
            double mod = sqrt(
                             DIRECT_MULTIDIM_ELEM(__X,n) * DIRECT_MULTIDIM_ELEM(__X,n) +
                             DIRECT_MULTIDIM_ELEM(__Y,n) * DIRECT_MULTIDIM_ELEM(__Y,n) +
                             DIRECT_MULTIDIM_ELEM(__Z,n) * DIRECT_MULTIDIM_ELEM(__Z,n));
            DIRECT_MULTIDIM_ELEM(__X,n) /= mod;
            DIRECT_MULTIDIM_ELEM(__Y,n) /= mod;
            DIRECT_MULTIDIM_ELEM(__Z,n) /= mod;
        }
    }

operator*() [1/2]

Vectorial_MultidimArray Vectorial_MultidimArray::operator* ( const Vectorial_MultidimArray &  op1 ) const

inline

v3=v1*v2.

Definition at line 310 of file vectorial.h.

    {
        Vectorial_MultidimArray temp;
        OPERATION(arrayByArray, *this, op1, temp, '*');
        return temp;
    }

operator*() [2/2]

Vectorial_MultidimArray Vectorial_MultidimArray::operator* ( double  op1 ) const

inline

v3=v1*k.

Definition at line 395 of file vectorial.h.

    {
        Vectorial_MultidimArray temp;
        OPERATION2(arrayByScalar, *this, op1, temp, '*');
        return temp;
    }

operator*=() [1/2]

void Vectorial_MultidimArray::operator*= ( const Vectorial_MultidimArray &  op1 )

inline

v3*=v2.

Definition at line 351 of file vectorial.h.

    {
        OPERATION(arrayByArray, *this, op1, *this, '*');
    }

operator*=() [2/2]

void Vectorial_MultidimArray::operator*= ( const double &  op1 )

inline

v3*=k.

Definition at line 436 of file vectorial.h.

    {
        OPERATION2(arrayByScalar, *this, op1, *this, '*');
    }

operator+() [1/2]

Vectorial_MultidimArray Vectorial_MultidimArray::operator+ ( const Vectorial_MultidimArray &  op1 ) const

inline

v3=v1+v2.

Definition at line 292 of file vectorial.h.

    {
        Vectorial_MultidimArray temp;
        OPERATION(arrayByArray, *this, op1, temp, '+');
        return temp;
    }

operator+() [2/2]

Vectorial_MultidimArray Vectorial_MultidimArray::operator+ ( double  op1 ) const

inline

v3=v1+k.

Definition at line 377 of file vectorial.h.

    {
        Vectorial_MultidimArray temp;
        OPERATION2(arrayByScalar, *this, op1, temp, '+');
        return temp;
    }

operator+=() [1/2]

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

inline

v3+=v2.

Definition at line 337 of file vectorial.h.

    {
        OPERATION(arrayByArray, *this, op1, *this, '+');
    }

operator+=() [2/2]

void Vectorial_MultidimArray::operator+= ( const double &  op1 )

inline

v3+=k.

Definition at line 422 of file vectorial.h.

    {
        OPERATION2(arrayByScalar, *this, op1, *this, '+');
    }

operator-() [1/2]

Vectorial_MultidimArray Vectorial_MultidimArray::operator- ( const Vectorial_MultidimArray &  op1 ) const

inline

v3=v1-v2.

Definition at line 301 of file vectorial.h.

    {
        Vectorial_MultidimArray temp;
        OPERATION(arrayByArray, *this, op1, temp, '-');
        return temp;
    }

operator-() [2/2]

Vectorial_MultidimArray Vectorial_MultidimArray::operator- ( double  op1 ) const

inline

v3=v1-k.

Definition at line 386 of file vectorial.h.

    {
        Vectorial_MultidimArray temp;
        OPERATION2(arrayByScalar, *this, op1, temp, '-');
        return temp;
    }

operator-=() [1/2]

void Vectorial_MultidimArray::operator-= ( const Vectorial_MultidimArray &  op1 )

inline

v3-=v2.

Definition at line 344 of file vectorial.h.

    {
        OPERATION(arrayByArray, *this, op1, *this, '-');
    }

operator-=() [2/2]

void Vectorial_MultidimArray::operator-= ( const double &  op1 )

inline

v3-=k.

Definition at line 429 of file vectorial.h.

    {
        OPERATION2(arrayByScalar, *this, op1, *this, '-');
    }

operator/() [1/2]

Vectorial_MultidimArray Vectorial_MultidimArray::operator/ ( const Vectorial_MultidimArray &  op1 ) const

inline

v3=v1/v2.

Definition at line 319 of file vectorial.h.

    {
        Vectorial_MultidimArray temp;
        OPERATION(arrayByArray, *this, op1, temp, '/');
        return temp;
    }

operator/() [2/2]

Vectorial_MultidimArray Vectorial_MultidimArray::operator/ ( double  op1 ) const

inline

v3=v1/k.

Definition at line 404 of file vectorial.h.

    {
        Vectorial_MultidimArray temp;
        OPERATION2(arrayByScalar, *this, op1, temp, '/');
        return temp;
    }

operator/=() [1/2]

void Vectorial_MultidimArray::operator/= ( const Vectorial_MultidimArray &  op1 )

inline

v3/=v2.

Definition at line 358 of file vectorial.h.

    {
        OPERATION(arrayByArray, *this, op1, *this, '/');
    }

operator/=() [2/2]

void Vectorial_MultidimArray::operator/= ( const double &  op1 )

inline

v3/=k.

Definition at line 443 of file vectorial.h.

    {
        OPERATION2(arrayByScalar, *this, op1, *this, '/');
    }

operator^() [1/2]

Vectorial_MultidimArray Vectorial_MultidimArray::operator^ ( const Vectorial_MultidimArray &  op1 ) const

inline

v3=v1^v2.

Definition at line 328 of file vectorial.h.

    {
        Vectorial_MultidimArray temp;
        OPERATION(arrayByArray, *this, op1, temp, '^');
        return temp;
    }

operator^() [2/2]

Vectorial_MultidimArray Vectorial_MultidimArray::operator^ ( double  op1 ) const

inline

v3=v1^k.

Definition at line 413 of file vectorial.h.

    {
        Vectorial_MultidimArray temp;
        OPERATION2(arrayByScalar, *this, op1, temp, '^');
        return temp;
    }

operator^=() [1/2]

void Vectorial_MultidimArray::operator^= ( const Vectorial_MultidimArray &  op1 )

inline

v3^=v2.

Definition at line 365 of file vectorial.h.

    {
        OPERATION(arrayByArray, *this, op1, *this, '^');
    }

operator^=() [2/2]

void Vectorial_MultidimArray::operator^= ( const double &  op1 )

inline

v3^=k.

Definition at line 450 of file vectorial.h.

    {
        OPERATION2(arrayByScalar, *this, op1, *this, '^');
    }

printShape()

void Vectorial_MultidimArray::printShape ( ) const

inline

Print shape.

Definition at line 105 of file vectorial.h.

    {
        __X.printShape();
    }

resize() [1/2]

void Vectorial_MultidimArray::resize ( int  Zdim, int  Ydim, int  Xdim  )

inline

Resize.

Definition at line 78 of file vectorial.h.

    {
        __X.resize(Zdim, Ydim, Xdim);
        __Y.resize(Zdim, Ydim, Xdim);
        __Z.resize(Zdim, Ydim, Xdim);
    }

resize() [2/2]

void Vectorial_MultidimArray::resize ( const MultidimArray< double > &  V )

inline

Resize with pattern.

Definition at line 87 of file vectorial.h.

    {
        __X.resize(V);
        __Y.resize(V);
        __Z.resize(V);
    }

setXmippOrigin()

void Vectorial_MultidimArray::setXmippOrigin ( )

inline

Set Xmipp origin.

Definition at line 121 of file vectorial.h.

    {
        __X.setXmippOrigin();
        __Y.setXmippOrigin();
        __Z.setXmippOrigin();
    }

vector_at()

void Vectorial_MultidimArray::vector_at ( int  k, int  i, int  j, Matrix1D< double > &  result  ) const

inline

Vector at a position, result as argument.

Definition at line 134 of file vectorial.h.

    {
        if (VEC_XSIZE(result)!=3)
            result.resize(3);
        XX(result) = __X(k, i, j);
        YY(result) = __Y(k, i, j);
        ZZ(result) = __Z(k, i, j);
    }

write()

void Vectorial_MultidimArray::write ( const FileName &  fn ) const

inline

Write.

Given a FileName, this function saves 3 volumes named "_X", "_Y" and "_Z".

Definition at line 269 of file vectorial.h.

    {
        Image<double> V;

        V() = __X;
        V.write(fn.insertBeforeExtension("_X"));
        V() = __Y;
        V.write(fn.insertBeforeExtension("_Y"));
        V() = __Z;
        V.write(fn.insertBeforeExtension("_Z"));
    }

X() [1/4]

const MultidimArray< double >& Vectorial_MultidimArray::X ( ) const

inline

Constant access to X component.

X components are a MultidimArray.

Definition at line 147 of file vectorial.h.

    {
        return __X;
    }

X() [2/4]

MultidimArray< double >& Vectorial_MultidimArray::X ( )

inline

Access to X components.

Definition at line 154 of file vectorial.h.

    {
        return __X;
    }

X() [3/4]

double Vectorial_MultidimArray::X ( int  k, int  i, int  j  ) const

inline

Constant access to a particular X component.

Definition at line 189 of file vectorial.h.

    {
        return A3D_ELEM(__X, k, i, j);
    }

X() [4/4]

double& Vectorial_MultidimArray::X ( int  k, int  i, int  j  )

inline

Access to a particular X component.

Definition at line 196 of file vectorial.h.

    {
        return A3D_ELEM(__X, k, i, j);
    }

Y() [1/4]

const MultidimArray< double >& Vectorial_MultidimArray::Y ( ) const

inline

Constant access to Y component.

Definition at line 161 of file vectorial.h.

    {
        return __Y;
    }

Y() [2/4]

MultidimArray< double >& Vectorial_MultidimArray::Y ( )

inline

Access to Y components.

Definition at line 168 of file vectorial.h.

    {
        return __Y;
    }

Y() [3/4]

double Vectorial_MultidimArray::Y ( int  k, int  i, int  j  ) const

inline

Constant access to a particular Y component.

Definition at line 203 of file vectorial.h.

    {
        return A3D_ELEM(__Y, k, i, j);
    }

Y() [4/4]

double& Vectorial_MultidimArray::Y ( int  k, int  i, int  j  )

inline

Access to a particular Y component.

Definition at line 210 of file vectorial.h.

    {
        return A3D_ELEM(__Y, k, i, j);
    }

Z() [1/4]

const MultidimArray< double >& Vectorial_MultidimArray::Z ( ) const

inline

Constant access to Z component.

Definition at line 175 of file vectorial.h.

    {
        return __Z;
    }

Z() [2/4]

MultidimArray< double >& Vectorial_MultidimArray::Z ( )

inline

Access to Z components.

Definition at line 182 of file vectorial.h.

    {
        return __Z;
    }

Z() [3/4]

double Vectorial_MultidimArray::Z ( int  k, int  i, int  j  ) const

inline

Constant access to a particular Z component.

Definition at line 217 of file vectorial.h.

    {
        return A3D_ELEM(__Z, k, i, j);
    }

Z() [4/4]

double& Vectorial_MultidimArray::Z ( int  k, int  i, int  j  )

inline

Access to a particular Z component.

Definition at line 224 of file vectorial.h.

    {
        return A3D_ELEM(__Z, k, i, j);
    }

---

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

• xmipp/libraries/data/vectorial.h