IBlobSet.h

Go to the documentation of this file.

/** A blob set holds a collection of blobs.
 *
 * See also ICluster which allows more rich associations.
 */

#ifndef WIRECELL_IBLOBSET
#define WIRECELL_IBLOBSET

#include "WireCellIface/IData.h"
#include "WireCellIface/IBlob.h"
#include "WireCellIface/ISlice.h"

namespace WireCell {

    class IBlobSet : public IData<IBlobSet> {
    public:
        virtual ~IBlobSet() ;

        /// Return some identifier number that is unique to this set.
        virtual int ident() const = 0;

        /// A slice relevant to this set.  This may be given even if
        /// there are no blobs (which have their own pointer to a
        /// slice).  
        virtual ISlice::pointer slice() const = 0;

        /// Return the blobs in this set.  There is no ordering
        /// requirement.
        virtual IBlob::vector blobs() const = 0;

        /// Return a vector of the underlying IBlob::shape() in order (sugar).
        virtual RayGrid::blobs_t shapes() const;
    };
}

#endif