PLearn 0.1
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Static Protected Member Functions | Protected Attributes | Private Types | Private Member Functions
PLearn::SaltPepperNoiseVariable Class Reference

The first sentence should be a BRIEF DESCRIPTION of what the class does. More...

#include <SaltPepperNoiseVariable.h>

Inheritance diagram for PLearn::SaltPepperNoiseVariable:
Inheritance graph
[legend]
Collaboration diagram for PLearn::SaltPepperNoiseVariable:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 SaltPepperNoiseVariable ()
 Default constructor, usually does nothing.
virtual void recomputeSize (int &l, int &w) const
 Recomputes the length l and width w that this variable should have, according to its parent variables.
virtual void fprop ()
 Nothing to do by default.
virtual void bprop ()
 Nothing to do by default.
virtual string classname () const
virtual OptionListgetOptionList () const
virtual OptionMapgetOptionMap () const
virtual RemoteMethodMapgetRemoteMethodMap () const
virtual SaltPepperNoiseVariabledeepCopy (CopiesMap &copies) const
virtual void build ()
 Post-constructor.
virtual void makeDeepCopyFromShallowCopy (CopiesMap &copies)
 Transforms a shallow copy into a deep copy.

Static Public Member Functions

static string _classname_ ()
 SaltPepperNoiseVariable.
static OptionList_getOptionList_ ()
static RemoteMethodMap_getRemoteMethodMap_ ()
static Object_new_instance_for_typemap_ ()
static bool _isa_ (const Object *o)
static void _static_initialize_ ()
static const PPathdeclaringFile ()

Public Attributes

PP< PRandomrandom_gen
 ### declare public option fields (such as build options) here Start your comments with Doxygen-compatible comments such as //!
real corruption_prob
real pepper_prob
real salt_value
real pepper_value

Static Public Attributes

static StaticInitializer _static_initializer_

Static Protected Member Functions

static void declareOptions (OptionList &ol)
 Declares the class options.

Protected Attributes

TVec< boolcorrupted

Private Types

typedef UnaryVariable inherited

Private Member Functions

void build_ ()
 This does the actual building.

Detailed Description

The first sentence should be a BRIEF DESCRIPTION of what the class does.

* SaltPepperNoiseVariable * Place the rest of the class programmer documentation here. Doxygen supports Javadoc-style comments. See http://www.doxygen.org/manual.html

Todo:
Write class to-do's here if there are any.
Deprecated:
Write deprecated stuff here if there is any. Indicate what else should be used instead.

Definition at line 61 of file SaltPepperNoiseVariable.h.


Member Typedef Documentation

Reimplemented from PLearn::UnaryVariable.

Definition at line 63 of file SaltPepperNoiseVariable.h.


Constructor & Destructor Documentation

PLearn::SaltPepperNoiseVariable::SaltPepperNoiseVariable ( )

Default constructor, usually does nothing.

Definition at line 53 of file SaltPepperNoiseVariable.cc.

    :corruption_prob(0),
     pepper_prob(0.5),
     salt_value(0),
     pepper_value(1)
{
    // ### You may (or not) want to call build_() to finish building the object
    // ### (doing so assumes the parent classes' build_() have been called too
    // ### in the parent classes' constructors, something that you must ensure)
}

Member Function Documentation

string PLearn::SaltPepperNoiseVariable::_classname_ ( ) [static]

SaltPepperNoiseVariable.

Reimplemented from PLearn::UnaryVariable.

Definition at line 51 of file SaltPepperNoiseVariable.cc.

OptionList & PLearn::SaltPepperNoiseVariable::_getOptionList_ ( ) [static]

Reimplemented from PLearn::UnaryVariable.

Definition at line 51 of file SaltPepperNoiseVariable.cc.

RemoteMethodMap & PLearn::SaltPepperNoiseVariable::_getRemoteMethodMap_ ( ) [static]

Reimplemented from PLearn::UnaryVariable.

Definition at line 51 of file SaltPepperNoiseVariable.cc.

bool PLearn::SaltPepperNoiseVariable::_isa_ ( const Object o) [static]

Reimplemented from PLearn::UnaryVariable.

Definition at line 51 of file SaltPepperNoiseVariable.cc.

Object * PLearn::SaltPepperNoiseVariable::_new_instance_for_typemap_ ( ) [static]

Reimplemented from PLearn::UnaryVariable.

Definition at line 51 of file SaltPepperNoiseVariable.cc.

StaticInitializer SaltPepperNoiseVariable::_static_initializer_ & PLearn::SaltPepperNoiseVariable::_static_initialize_ ( ) [static]

Reimplemented from PLearn::UnaryVariable.

Definition at line 51 of file SaltPepperNoiseVariable.cc.

void PLearn::SaltPepperNoiseVariable::bprop ( ) [virtual]

Nothing to do by default.

Reimplemented from PLearn::UnaryVariable.

Definition at line 118 of file SaltPepperNoiseVariable.cc.

References corrupted, PLearn::Variable::gradient, PLearn::Variable::gradientdata, i, PLearn::UnaryVariable::input, PLearn::TVec< T >::length(), and n.

{
    int n = gradient.length();
    for(int i=0; i<n; i++)
    {
        if(!corrupted[i])
            input->gradientdata[i] += gradientdata[i];
    }
}

Here is the call graph for this function:

void PLearn::SaltPepperNoiseVariable::build ( ) [virtual]

Post-constructor.

The normal implementation should call simply inherited::build(), then this class's build_(). This method should be callable again at later times, after modifying some option fields to change the "architecture" of the object.

Reimplemented from PLearn::UnaryVariable.

Definition at line 135 of file SaltPepperNoiseVariable.cc.

References PLearn::UnaryVariable::build(), and build_().

Here is the call graph for this function:

void PLearn::SaltPepperNoiseVariable::build_ ( ) [private]

This does the actual building.

Reimplemented from PLearn::UnaryVariable.

Definition at line 185 of file SaltPepperNoiseVariable.cc.

Referenced by build().

{
    // ### This method should do the real building of the object,
    // ### according to set 'options', in *any* situation.
    // ### Typical situations include:
    // ###  - Initial building of an object from a few user-specified options
    // ###  - Building of a "reloaded" object: i.e. from the complete set of
    // ###    all serialised options.
    // ###  - Updating or "re-building" of an object after a few "tuning"
    // ###    options have been modified.
    // ### You should assume that the parent class' build_() has already been
    // ### called.
}

Here is the caller graph for this function:

string PLearn::SaltPepperNoiseVariable::classname ( ) const [virtual]

Reimplemented from PLearn::UnaryVariable.

Definition at line 51 of file SaltPepperNoiseVariable.cc.

void PLearn::SaltPepperNoiseVariable::declareOptions ( OptionList ol) [static, protected]

Declares the class options.

Reimplemented from PLearn::UnaryVariable.

Definition at line 155 of file SaltPepperNoiseVariable.cc.

References PLearn::OptionBase::buildoption, corruption_prob, PLearn::declareOption(), PLearn::UnaryVariable::declareOptions(), pepper_prob, pepper_value, random_gen, and salt_value.

{
    // ### Declare all of this object's options here.
    // ### For the "flags" of each option, you should typically specify
    // ### one of OptionBase::buildoption, OptionBase::learntoption or
    // ### OptionBase::tuningoption. If you don't provide one of these three,
    // ### this option will be ignored when loading values from a script.
    // ### You can also combine flags, for example with OptionBase::nosave:
    // ### (OptionBase::buildoption | OptionBase::nosave)

    declareOption(ol, "corruption_prob", &SaltPepperNoiseVariable::corruption_prob,
                  OptionBase::buildoption,
                  "The probability of corrupting each input element");
    declareOption(ol, "pepper_prob", &SaltPepperNoiseVariable::pepper_prob,
                  OptionBase::buildoption,
                  "If an element is to be corrupted, it will be set to pepper_value with probability pepper_prob and to salt_value with probability 1-pepper_prob.");
    declareOption(ol, "salt_value", &SaltPepperNoiseVariable::salt_value,
                  OptionBase::buildoption,
                  "The value to which to set all inputs that have been elected to be corrupted to salt.");
    declareOption(ol, "pepper_value", &SaltPepperNoiseVariable::pepper_value,
                  OptionBase::buildoption,
                  "The value to which to set all inputs that have been elected to be corrupted to pepper.");
    declareOption(ol, "random_gen", &SaltPepperNoiseVariable::random_gen,
                  OptionBase::buildoption,
                  "Random number generator. If null, the PRandom::common(false) generator will be used.");

    // Now call the parent class' declareOptions
    inherited::declareOptions(ol);
}

Here is the call graph for this function:

static const PPath& PLearn::SaltPepperNoiseVariable::declaringFile ( ) [inline, static]

Reimplemented from PLearn::UnaryVariable.

Definition at line 104 of file SaltPepperNoiseVariable.h.

:
    //#####  Protected Options  ###############################################
SaltPepperNoiseVariable * PLearn::SaltPepperNoiseVariable::deepCopy ( CopiesMap copies) const [virtual]

Reimplemented from PLearn::UnaryVariable.

Definition at line 51 of file SaltPepperNoiseVariable.cc.

void PLearn::SaltPepperNoiseVariable::fprop ( ) [virtual]

Nothing to do by default.

Reimplemented from PLearn::UnaryVariable.

Definition at line 87 of file SaltPepperNoiseVariable.cc.

References PLearn::UnaryVariable::checkContiguity(), PLearn::PRandom::common(), corrupted, corruption_prob, i, PLearn::UnaryVariable::input, PLearn::PP< T >::isNull(), PLearn::TVec< T >::length(), n, pepper_prob, pepper_value, random_gen, PLearn::TVec< T >::resize(), salt_value, PLearn::Variable::value, and PLearn::Variable::valuedata.

{
    checkContiguity();

    if(random_gen.isNull())
        random_gen = PRandom::common(false);


    int n = value.length();
    corrupted.resize(n);

    for(int i=0; i<n; i++)
    {
        if(random_gen->uniform_sample()<corruption_prob)
        {
            if(random_gen->uniform_sample()<pepper_prob)
                valuedata[i] = pepper_value;
            else
                valuedata[i] = salt_value;

            corrupted[i] = true;
        }
        else
        {
            valuedata[i] = input->valuedata[i];
            corrupted[i] = false;
        }
    }
}

Here is the call graph for this function:

OptionList & PLearn::SaltPepperNoiseVariable::getOptionList ( ) const [virtual]

Reimplemented from PLearn::UnaryVariable.

Definition at line 51 of file SaltPepperNoiseVariable.cc.

OptionMap & PLearn::SaltPepperNoiseVariable::getOptionMap ( ) const [virtual]

Reimplemented from PLearn::UnaryVariable.

Definition at line 51 of file SaltPepperNoiseVariable.cc.

RemoteMethodMap & PLearn::SaltPepperNoiseVariable::getRemoteMethodMap ( ) const [virtual]

Reimplemented from PLearn::UnaryVariable.

Definition at line 51 of file SaltPepperNoiseVariable.cc.

void PLearn::SaltPepperNoiseVariable::makeDeepCopyFromShallowCopy ( CopiesMap copies) [virtual]

Transforms a shallow copy into a deep copy.

Reimplemented from PLearn::UnaryVariable.

Definition at line 141 of file SaltPepperNoiseVariable.cc.

References PLearn::deepCopyField(), PLearn::UnaryVariable::makeDeepCopyFromShallowCopy(), and random_gen.

{
    inherited::makeDeepCopyFromShallowCopy(copies);

    // ### Call deepCopyField on all "pointer-like" fields
    // ### that you wish to be deepCopied rather than
    // ### shallow-copied.
    // ### ex:
    deepCopyField(random_gen, copies);

    // ### If you want to deepCopy a Var field:
    // varDeepCopyField(somevariable, copies);
}

Here is the call graph for this function:

void PLearn::SaltPepperNoiseVariable::recomputeSize ( int l,
int w 
) const [virtual]

Recomputes the length l and width w that this variable should have, according to its parent variables.

This is used for ex. by sizeprop() The default version stupidly returns the current dimensions, so make sure to overload it in subclasses if this is not appropriate.

Reimplemented from PLearn::Variable.

Definition at line 75 of file SaltPepperNoiseVariable.cc.

References PLearn::UnaryVariable::input, PLearn::Var::length(), and PLearn::Var::width().

{
    if (input) 
    {
        l = input.length();
        w = input.width(); // the computed width
    } 
    else
        l = w = 0;
}

Here is the call graph for this function:


Member Data Documentation

Reimplemented from PLearn::UnaryVariable.

Definition at line 104 of file SaltPepperNoiseVariable.h.

Definition at line 120 of file SaltPepperNoiseVariable.h.

Referenced by bprop(), and fprop().

Definition at line 71 of file SaltPepperNoiseVariable.h.

Referenced by declareOptions(), and fprop().

Definition at line 72 of file SaltPepperNoiseVariable.h.

Referenced by declareOptions(), and fprop().

Definition at line 74 of file SaltPepperNoiseVariable.h.

Referenced by declareOptions(), and fprop().

### declare public option fields (such as build options) here Start your comments with Doxygen-compatible comments such as //!

Definition at line 70 of file SaltPepperNoiseVariable.h.

Referenced by declareOptions(), fprop(), and makeDeepCopyFromShallowCopy().

Definition at line 73 of file SaltPepperNoiseVariable.h.

Referenced by declareOptions(), and fprop().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines