EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
EMAN::RangeThresholdProcessor Class Reference

f(x) = 1 if (low <= x <= high); else f(x) = 0 More...

#include <processor.h>

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

Public Member Functions

 RangeThresholdProcessor ()
 
string get_name () const
 Get the processor's name. More...
 
void set_params (const Dict &new_params)
 Set the processor parameters using a key/value dictionary. More...
 
TypeDict get_param_types () const
 Get processor parameter information in a dictionary. More...
 
string get_desc () const
 Get the descrition of this specific processor. More...
 
- Public Member Functions inherited from EMAN::RealPixelProcessor
 RealPixelProcessor ()
 
void process_inplace (EMData *image)
 To process an image in-place. More...
 
- Public Member Functions inherited from EMAN::Processor
virtual ~Processor ()
 
virtual EMDataprocess (const EMData *const image)
 To proccess an image out-of-place. More...
 
virtual void process_list_inplace (vector< EMData * > &images)
 To process multiple images using the same algorithm. More...
 
virtual Dict get_params () const
 Get the processor parameters in a key/value dictionary. More...
 

Static Public Member Functions

static ProcessorNEW ()
 
- Static Public Member Functions inherited from EMAN::RealPixelProcessor
static string get_group_desc ()
 
- Static Public Member Functions inherited from EMAN::Processor
static string get_group_desc ()
 Get the description of this group of processors. More...
 
static void EMFourierFilterInPlace (EMData *fimage, Dict params)
 Compute a Fourier-filter processed image in place. More...
 
static EMDataEMFourierFilter (EMData *fimage, Dict params)
 Compute a Fourier-processor processed image without altering the original image. More...
 

Static Public Attributes

static const string NAME = "threshold.binaryrange"
 

Protected Member Functions

void process_pixel (float *x) const
 
- Protected Member Functions inherited from EMAN::RealPixelProcessor
virtual void calc_locals (EMData *)
 
virtual void normalize (EMData *) const
 

Private Attributes

float low
 
float high
 

Additional Inherited Members

- Public Types inherited from EMAN::Processor
enum  fourier_filter_types {
  TOP_HAT_LOW_PASS , TOP_HAT_HIGH_PASS , TOP_HAT_BAND_PASS , TOP_HOMOMORPHIC ,
  GAUSS_LOW_PASS , GAUSS_HIGH_PASS , GAUSS_BAND_PASS , GAUSS_INVERSE ,
  GAUSS_HOMOMORPHIC , BUTTERWORTH_LOW_PASS , BUTTERWORTH_HIGH_PASS , BUTTERWORTH_HOMOMORPHIC ,
  KAISER_I0 , KAISER_SINH , KAISER_I0_INVERSE , KAISER_SINH_INVERSE ,
  SHIFT , TANH_LOW_PASS , TANH_HIGH_PASS , TANH_HOMOMORPHIC ,
  TANH_BAND_PASS , RADIAL_TABLE , CTF_
}
 Fourier filter Processor type enum. More...
 
- Protected Attributes inherited from EMAN::RealPixelProcessor
float value
 
float maxval
 
float mean
 
float sigma
 
- Protected Attributes inherited from EMAN::Processor
Dict params
 

Detailed Description

f(x) = 1 if (low <= x <= high); else f(x) = 0

Parameters
lowThe lower limit of the range that will be set to 1
highThe upper limit of the range that will be set to 1

Definition at line 3485 of file processor.h.

Constructor & Destructor Documentation

◆ RangeThresholdProcessor()

EMAN::RangeThresholdProcessor::RangeThresholdProcessor ( )
inline

Definition at line 3488 of file processor.h.

3488 :low(0), high(0)
3489 {
3490 }

Referenced by NEW().

Member Function Documentation

◆ get_desc()

string EMAN::RangeThresholdProcessor::get_desc ( ) const
inlinevirtual

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 3516 of file processor.h.

3517 {
3518 return "Range thresholding. A range of values is set to 1, all else is set to 0. f(x) = 1 if (low <= x <= high); else f(x) = 0";
3519 }

◆ get_name()

string EMAN::RangeThresholdProcessor::get_name ( ) const
inlinevirtual

Get the processor's name.

Each processor is identified by a unique name.

Returns
The processor's name.

Implements EMAN::Processor.

Definition at line 3492 of file processor.h.

3493 {
3494 return NAME;
3495 }
static const string NAME
Definition: processor.h:3521

References NAME.

◆ get_param_types()

TypeDict EMAN::RangeThresholdProcessor::get_param_types ( ) const
inlinevirtual

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::Processor.

Definition at line 3508 of file processor.h.

3509 {
3510 TypeDict d;
3511 d.put("low", EMObject::FLOAT, "The lower limit of the range that will be set to 1");
3512 d.put("high", EMObject::FLOAT, "The upper limit of the range that will be set to 1");
3513 return d;
3514 }
TypeDict is a dictionary to store <string, EMObject::ObjectType> pair.
Definition: emobject.h:305
void put(const string &key, EMObject::ObjectType o, const string &desc="")
Definition: emobject.h:330

References EMAN::EMObject::FLOAT, and EMAN::TypeDict::put().

◆ NEW()

static Processor * EMAN::RangeThresholdProcessor::NEW ( )
inlinestatic

Definition at line 3496 of file processor.h.

3497 {
3498 return new RangeThresholdProcessor();
3499 }

References RangeThresholdProcessor().

◆ process_pixel()

void EMAN::RangeThresholdProcessor::process_pixel ( float *  x) const
inlineprotectedvirtual

Implements EMAN::RealPixelProcessor.

Definition at line 3524 of file processor.h.

3525 {
3526 if (*x >= low && *x <= high) {
3527 *x = 1;
3528 }
3529 else {
3530 *x = 0;
3531 }
3532 }
#define x(i)
Definition: projector.cpp:1517

References high, low, and x.

◆ set_params()

void EMAN::RangeThresholdProcessor::set_params ( const Dict new_params)
inlinevirtual

Set the processor parameters using a key/value dictionary.

Parameters
new_paramsA dictionary containing the new parameters.

Reimplemented from EMAN::RealPixelProcessor.

Definition at line 3501 of file processor.h.

3502 {
3503 params = new_params;
3504 low = params.get("low");
3505 high = params.get("high");
3506 }
EMObject get(const string &key) const
Get the EMObject corresponding to the particular key Probably better to just use operator[].
Definition: emobject.h:527

References EMAN::Dict::get(), high, low, and EMAN::Processor::params.

Member Data Documentation

◆ high

float EMAN::RangeThresholdProcessor::high
private

Definition at line 3535 of file processor.h.

Referenced by process_pixel(), and set_params().

◆ low

float EMAN::RangeThresholdProcessor::low
private

Definition at line 3534 of file processor.h.

Referenced by process_pixel(), and set_params().

◆ NAME

const string RangeThresholdProcessor::NAME = "threshold.binaryrange"
static

Definition at line 3521 of file processor.h.

Referenced by get_name().


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