BackgroundFilter Class Reference

#include <filters.h>

Inheritance diagram for BackgroundFilter:

Collaboration diagram for BackgroundFilter:

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

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

Detailed Description

Definition at line 1511 of file filters.h.

Member Function Documentation

apply()

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

virtual

Apply the filter to an image or volume

Implements XmippFilter.

Definition at line 3689 of file filters.cpp.

{
    switch (type)
    {
    case PLANE:
        substractBackgroundPlane(img);
        break;
    case ROLLINGBALL:
        substractBackgroundRollingBall(img, radius);
        break;

    }
}

defineParams()

void BackgroundFilter::defineParams ( XmippProgram *  program )

static

Define the parameters for use inside an Xmipp program

Definition at line 3660 of file filters.cpp.

{
    program->addParamsLine("== Background removal ==");
    program->addParamsLine(
        "  [ --background <type=plane> ]            : Filters to remove the background.");
    program->addParamsLine("         where <type>  ");
    program->addParamsLine(
        "            plane                          : Remove the plane that best fits the pixels.");
    program->addParamsLine(
        "            rollingball <radius>           : The background is computed as a rolling ball operation.");
    program->addParamsLine("         alias -g; ");
}

readParams()

void BackgroundFilter::readParams ( XmippProgram *  program )

virtual

Read from program command line

Reimplemented from XmippFilter.

Definition at line 3674 of file filters.cpp.

{
    type = PLANE;
    // Check operation to do
    String typeStr = program->getParam("--background");
    if (typeStr == "plane") //Nothing to do, plane by default
        ;
    else if (typeStr == "rollingball")
    {
        type = ROLLINGBALL;
        radius = program->getIntParam("--background", "rollingball");
    }
}

---

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

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