BasisFilter Class Reference

#include <filters.h>

Inheritance diagram for BasisFilter:

Collaboration diagram for BasisFilter:

Public Member Functions
void	readParams (XmippProgram *program)
void	show ()
void	apply (MultidimArray< double > &img)
Public Member Functions inherited from XmippFilter
virtual	~XmippFilter ()

Static Public Member Functions
static void	defineParams (XmippProgram *program)

Detailed Description

Definition at line 1575 of file filters.h.

Member Function Documentation

apply()

void BasisFilter::apply ( MultidimArray< double > &  img )

virtual

Apply the filter to an image or volume

Implements XmippFilter.

Definition at line 3812 of file filters.cpp.

{
    const MultidimArray<double> &mBasis = basis();
    if (XSIZE(img) != XSIZE(mBasis) || YSIZE(img) != YSIZE(mBasis))
        REPORT_ERROR(ERR_MULTIDIM_SIZE,
                     "Images and basis are of different size");

    MultidimArray<double> result;
    result.initZeros(img);
    for (size_t nn = 0; nn < NSIZE(mBasis); ++nn)
    {
        double cnn = 0;
        double *ptrBasis = &NZYX_ELEM(mBasis,nn,0,0,0);
        FOR_ALL_DIRECT_ELEMENTS_IN_MULTIDIMARRAY(img)
        cnn += DIRECT_MULTIDIM_ELEM(img,n) * (*ptrBasis++);
        ptrBasis = &NZYX_ELEM(mBasis,nn,0,0,0);
        FOR_ALL_DIRECT_ELEMENTS_IN_MULTIDIMARRAY(img)
        DIRECT_MULTIDIM_ELEM(result,n) += cnn * (*ptrBasis++);
    }
    img = result;
}

defineParams()

void BasisFilter::defineParams ( XmippProgram *  program )

static

Define the parameters for use inside an Xmipp program

Definition at line 3788 of file filters.cpp.

{
    program->addParamsLine("== Basis filter ==");
    program->addParamsLine(
        "  [--basis <file> <N=-1>]           : Stack file with the basis, N is the number of elements to consider");
}

readParams()

void BasisFilter::readParams ( XmippProgram *  program )

virtual

Read from program command line

Reimplemented from XmippFilter.

Definition at line 3796 of file filters.cpp.

{
    fnBasis = program->getParam("--basis");
    Nbasis = program->getIntParam("--basis", 1);
    basis.read(fnBasis);
    if (Nbasis > 0)
        basis().resize(Nbasis, 1, YSIZE(basis()), XSIZE(basis()));
}

show()

void BasisFilter::show ( )

virtual

Show parameters

Reimplemented from XmippFilter.

Definition at line 3805 of file filters.cpp.

{
    std::cout << " Basis filter\n" << " Basis file " << fnBasis << std::endl
    << " Number of basis " << Nbasis << std::endl;
}

---

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

• xmipp/libraries/data/filters.h
• xmipp/libraries/data/filters.cpp