BadPixelFilter Class Reference

#include <filters.h>

Inheritance diagram for BadPixelFilter:

Collaboration diagram for BadPixelFilter:

Public Types
enum	BadPixelFilterType { NEGATIVE, MASK, OUTLIER }

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)

Public Attributes
BadPixelFilterType	type
double	factor
Image< char > *	mask

Detailed Description

Some concrete filters

Definition at line 1464 of file filters.h.

Member Enumeration Documentation

BadPixelFilterType

enum BadPixelFilter::BadPixelFilterType

Apply filter on bad pixels

Enumerator
NEGATIVE
MASK
OUTLIER

Definition at line 1468 of file filters.h.

{ NEGATIVE, MASK, OUTLIER } BadPixelFilterType;

Member Function Documentation

apply()

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

virtual

Apply the filter to an image or volume

Implements XmippFilter.

Definition at line 3600 of file filters.cpp.

{
    switch (type)
    {
    case NEGATIVE:
        forcePositive(img);
        break;
    case MASK:
        boundMedianFilter(img, mask->data);
        break;
    case OUTLIER:
        pixelDesvFilter(img, factor);
        break;

    }
}

defineParams()

void BadPixelFilter::defineParams ( XmippProgram *  program )

static

Define the parameters for use inside an Xmipp program

Definition at line 3563 of file filters.cpp.

{
    program->addParamsLine("== Bad pixels ==");
    program->addParamsLine(
        "  [ --bad_pixels <type>]            : Applied filters on bad pixels of the image.");
    program->addParamsLine("         where <type>  ");
    program->addParamsLine(
        "            negative              : Applied at those negative values. Positive values are untouched.");
    program->addParamsLine(
        "            mask <mask_file>      : Applied at those pixels given by mask.");
    program->addParamsLine(
        "            outliers <factor>     : Applied at those pixels out of the range [mean - factor*std, mean + factor*std].");
    program->addParamsLine("         alias -b; ");
}

readParams()

void BadPixelFilter::readParams ( XmippProgram *  program )

virtual

Read from program command line

Reimplemented from XmippFilter.

Definition at line 3579 of file filters.cpp.

{
    type = NEGATIVE;
    // Check operation to do
    String typeStr = program->getParam("--bad_pixels");
    if (typeStr == "negative")
        ; //nothing to do type already equal to NEGATIVE
    else if (typeStr == "mask")
    {
        mask = new Image<char>;
        mask->read(program->getParam("--bad_pixels", "mask"));
        type = MASK;
    }
    else if (typeStr == "outliers")
    {
        factor = program->getDoubleParam("--bad_pixels", "outliers");
        type = OUTLIER;
    }
}

Member Data Documentation

factor

double BadPixelFilter::factor

Definition at line 1471 of file filters.h.

mask

Image<char>* BadPixelFilter::mask

Definition at line 1472 of file filters.h.

type

BadPixelFilterType BadPixelFilter::type

Definition at line 1470 of file filters.h.

---

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

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