CL_Despike.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        CL_Despike.h ( Clip Library, C++)
 *
 * COMMENTS:
 *      Does continuous despiking of data
 *
 */


#ifndef __CL_Despike__
#define __CL_Despike__

#include "CL_API.h"
#include "CL_SlidingWindow.h"
#include <SYS/SYS_Types.h>

class UT_OStream;

class CL_API CL_Despike final : public CL_SlidingWindow
{
public:

            CL_Despike(int size,fpreal last);

    // must be 'size' floats long.
    void    setDespikeParms(int size,fpreal tolerance,fpreal effect);
    
    void    reset(fpreal val = 0.0) override;

    void    save(UT_OStream &os) override;
    bool    load(UT_IStream &is, int version) override;

private:
    void    doShiftOp(int nsamples, const fpreal *source, int ndest) override;

    fpreal  mySpikeSlope;

    fpreal  myTolerance;
    fpreal  myEffect;
};

#endif