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

f(x) = 0 if x < value; f(x) = 1 if x >= value. More...

#include <processor.h>

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

Public Member Functions

string get_name () const
 Get the processor's name. 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...
 
virtual void set_params (const Dict &new_params)
 Set the processor parameters using a key/value dictionary. 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.binary"
 

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
 

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) = 0 if x < value; f(x) = 1 if x >= value.

Parameters
valueThe thresholding value. If a pixel value is equal to or above the threshold it is set to 1. If it is below it is set to 0

Definition at line 3190 of file processor.h.

Member Function Documentation

◆ get_desc()

string EMAN::BinarizeProcessor::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 3208 of file processor.h.

3209 {
3210 return "f(x) = 0 if x < value; f(x) = 1 if x >= value.";
3211 }

◆ get_name()

string EMAN::BinarizeProcessor::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 3193 of file processor.h.

3194 {
3195 return NAME;
3196 }
static const string NAME
Definition: processor.h:3213

References NAME.

◆ get_param_types()

TypeDict EMAN::BinarizeProcessor::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 3201 of file processor.h.

3202 {
3203 TypeDict d;
3204 d.put("value", EMObject::FLOAT, "The thresholding value. If a pixel value is equal to or above the threshold it is set to 1. If it is below it is set to 0" );
3205 return d;
3206 }
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::BinarizeProcessor::NEW ( )
inlinestatic

Definition at line 3197 of file processor.h.

3198 {
3199 return new BinarizeProcessor();
3200 }
f(x) = 0 if x < value; f(x) = 1 if x >= value.
Definition: processor.h:3191

◆ process_pixel()

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

Implements EMAN::RealPixelProcessor.

Definition at line 3216 of file processor.h.

3217 {
3218 if (*x < value)
3219 {
3220 *x = 0;
3221 }
3222 else
3223 {
3224 *x = 1;
3225 }
3226 }
#define x(i)
Definition: projector.cpp:1517

References EMAN::RealPixelProcessor::value, and x.

Member Data Documentation

◆ NAME

const string BinarizeProcessor::NAME = "threshold.binary"
static

Definition at line 3213 of file processor.h.

Referenced by get_name().


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