iPE::Smoother(3)

NAME
iPE::Smoother - Abstract base class for all smoother classes.

DESCRIPTION
This class does nothing but define the stub functions expected for all Smoothers.

FUNCTIONS

new (data)
    Instantiates a new smoother. The smoother will receive the data included in the gHMM XML file.

init ()
    Initialize the parameters of the smoother given by data. This is optionally implemented in subclasses and empty in the base class.

data ()
    Returns the data attribute that this smoother was instantiated with in the gHMM XML file.

smoothAref (aref[, biasedSamples])
    Smooths a series of numbers in an array reference. The array must be flat. You may pass in a series of array references or flatten your array reference to get all of the data in a single call.

    If the entire distribution is biased by some amount not present in the hash reference, pass the total samples (including those in the hash) in the biasedSamples argument.

smoothHref (href[, biasedSamples])
    Smooths all keys in a hash reference. If the entire distribution is biased by some amount not present in the hash reference, pass the total samples (including those in the hash) in the biasedSamples argument.

getArefTotal (aref), getHrefTotal (href)
    This function simply totals up the size of the array or hash reference. This should be used at the beginning of smothing so that it can be renormalized at the end (see below).

renormalizeAref (aref, oldN), renormalizeHref(href, oldN)
    This is a function that should used by all smoothers at the end of the routine to restore the original density of the distribution. This will restore the original density of the submodel, so that in normalizing multiple models, the relative densities will be correct.

SEE ALSO
iPE iPE::Model::Emission iPE::Model::DurationDistribution

AUTHOR
Bob Zimmermann (rpz@cse.wustl.edu).

POD ERRORS
Hey! The above document had some coding errors, which are explained below:

Around line 93:
    =cut found outside a pod block. Skipping to next block.