EMAN::InverseKaiserSinhProcessor Class Reference

Divide by a Kaiser-Bessel Sinh func in Fourier space. More...

#include <processor_sparx.h>

Inheritance diagram for EMAN::InverseKaiserSinhProcessor:

Inheritance graph
[legend]
Collaboration diagram for EMAN::InverseKaiserSinhProcessor:

Collaboration graph
[legend]
List of all members.

Public Member Functions

string get_name () const
 Get the processor's name.
string get_desc () const
 Get the descrition of this specific processor.
void process_inplace (EMData *image)
 To process an image in-place.
TypeDict get_param_types () const
 Get processor parameter information in a dictionary.

Static Public Member Functions

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "filter.kaisersinhinverse"

Detailed Description

Divide by a Kaiser-Bessel Sinh func in Fourier space.

Definition at line 511 of file processor_sparx.h.


Member Function Documentation

string EMAN::InverseKaiserSinhProcessor::get_desc (  )  const [inline, virtual]

Get the descrition of this specific processor.

This function must be overwritten by a subclass.

Returns:
The description of this processor.

Implements EMAN::Processor.

Definition at line 518 of file processor_sparx.h.

00519                 {
00520                         return "Divide by a Kaiser-Bessel Sinh func in Fourier space.";
00521                 }

string EMAN::InverseKaiserSinhProcessor::get_name (  )  const [inline, virtual]

Get the processor's name.

Each processor is identified by a unique name.

Returns:
The processor's name.

Implements EMAN::Processor.

Definition at line 514 of file processor_sparx.h.

References NAME.

00515                 { return NAME; }

TypeDict EMAN::InverseKaiserSinhProcessor::get_param_types (  )  const [inline, virtual]

Get processor parameter information in a dictionary.

Each parameter has one record in the dictionary. Each record contains its name, data-type, and description.

Returns:
A dictionary containing the parameter info.

Reimplemented from EMAN::NewFourierProcessor.

Definition at line 526 of file processor_sparx.h.

References EMAN::NewFourierProcessor::get_param_types().

00527                 {
00528                         TypeDict d = NewFourierProcessor::get_param_types();
00529                         return d;
00530                 }

static Processor* EMAN::InverseKaiserSinhProcessor::NEW (  )  [inline, static]

Definition at line 516 of file processor_sparx.h.

00517                 { return new InverseKaiserSinhProcessor(); }

void EMAN::InverseKaiserSinhProcessor::process_inplace ( EMData image  )  [inline, virtual]

To process an image in-place.

For those processors which can only be processed out-of-place, override this function to just print out some error message to remind user call the out-of-place version.

Parameters:
image The image to be processed.

Implements EMAN::Processor.

Definition at line 522 of file processor_sparx.h.

References EMAN::Processor::EMFourierFilterInPlace(), EMAN::Processor::KAISER_SINH_INVERSE, and EMAN::Processor::params.

00522                                                     {
00523                         params["filter_type"] = KAISER_SINH_INVERSE;
00524                         EMFourierFilterInPlace(image, params);
00525                 }


Member Data Documentation

const string InverseKaiserSinhProcessor::NAME = "filter.kaisersinhinverse" [static]

Definition at line 532 of file processor_sparx.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Tue Jun 11 12:45:18 2013 for EMAN2 by  doxygen 1.4.7