Filter.hpp

/******************************************************************************
* Copyright (c) 2011, Michael P. Gerlek (mpg@flaxen.com)
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following
* conditions are met:
*
*     * Redistributions of source code must retain the above copyright
*       notice, this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in
*       the documentation and/or other materials provided
*       with the distribution.
*     * Neither the name of Hobu, Inc. or Flaxen Geo Consulting nor the
*       names of its contributors may be used to endorse or promote
*       products derived from this software without specific prior
*       written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
****************************************************************************/

#ifndef INCLUDED_FILTER_HPP
#define INCLUDED_FILTER_HPP

#include <pdal/pdal_internal.hpp>

#include <pdal/Stage.hpp>

namespace pdal
{

//
// supported options:
//   <uint32>id
//   <bool>debug
//   <uint32>verbose
//

class FilterTester;

class PDAL_DLL Filter : public Stage
{
    friend class FilterTester;
public:
    Filter(const Options& options) : Stage(options)
        {}
    Filter()
        {}

    // for xml serializion of pipelines
    virtual boost::property_tree::ptree serializePipeline() const;

private:
    Filter& operator=(const Filter&); // not implemented
    Filter(const Filter&); // not implemented
    virtual PointBufferSet run(PointBufferPtr buffer)
    {
        PointBufferSet pbSet;
        filter(*buffer);
        pbSet.insert(buffer);
        return pbSet;
    }
    virtual void filter(PointBuffer& /*buffer*/)
    {}
};

}  // namespace pdal

#endif