WireCell::Img::ClusterSink Class Reference

#include <ClusterSink.h>

Inheritance diagram for WireCell::Img::ClusterSink:

Public Member Functions
	ClusterSink ()
virtual	~ClusterSink ()
virtual void	configure (const WireCell::Configuration &cfg)
	Accept a configuration. More...
virtual WireCell::Configuration	default_configuration () const
	Optional, override to return a hard-coded default configuration. More...
virtual bool	operator() (const ICluster::pointer &cluster)
	The calling signature: More...
Public Member Functions inherited from WireCell::IClusterSink
virtual	~IClusterSink ()
virtual std::string	signature ()
Public Member Functions inherited from WireCell::ISinkNode< ICluster >
virtual	~ISinkNode ()
virtual bool	operator() (const boost::any &anyin)
virtual std::vector< std::string >	input_types ()
Public Member Functions inherited from WireCell::ISinkNodeBase
virtual	~ISinkNodeBase ()
virtual NodeCategory	category ()
	Return the behavior category type. More...
Public Member Functions inherited from WireCell::INode
virtual	~INode ()
virtual int	concurrency ()
virtual std::vector< std::string >	output_types ()
virtual void	reset ()
Public Member Functions inherited from WireCell::IComponent< INode >
virtual	~IComponent ()
Public Member Functions inherited from WireCell::Interface
virtual	~Interface ()
Public Member Functions inherited from WireCell::IConfigurable
virtual	~IConfigurable ()
Public Member Functions inherited from WireCell::IComponent< IConfigurable >
virtual	~IComponent ()

Private Attributes
std::string	m_filename
std::string	m_node_types

Additional Inherited Members
Public Types inherited from WireCell::IClusterSink
typedef std::shared_ptr< IClusterSink >	pointer
Public Types inherited from WireCell::ISinkNode< ICluster >
typedef ICluster	input_type
typedef std::shared_ptr< const ICluster >	input_pointer
Public Types inherited from WireCell::ISinkNodeBase
typedef std::shared_ptr< ISinkNodeBase >	pointer
Public Types inherited from WireCell::INode
enum	NodeCategory {   unknown, sourceNode, sinkNode, functionNode,   queuedoutNode, joinNode, splitNode, faninNode,   fanoutNode, multioutNode, hydraNode }
Public Types inherited from WireCell::IComponent< INode >
typedef std::shared_ptr< INode >	pointer
	Access subclass facet by pointer. More...
typedef std::vector< pointer >	vector
	Vector of shared pointers. More...
Public Types inherited from WireCell::Interface
typedef std::shared_ptr< Interface >	pointer
Public Types inherited from WireCell::IComponent< IConfigurable >
typedef std::shared_ptr< IConfigurable >	pointer
	Access subclass facet by pointer. More...
typedef std::vector< pointer >	vector
	Vector of shared pointers. More...

Detailed Description

Definition at line 12 of file ClusterSink.h.

Constructor & Destructor Documentation

Img::ClusterSink::ClusterSink

(

)

Definition at line 19 of file ClusterSink.cxx.

    : m_filename("")
    , m_node_types("bsm")
{
}

Img::ClusterSink::~ClusterSink ( )

virtual

Definition at line 25 of file ClusterSink.cxx.

{
}

Member Function Documentation

void Img::ClusterSink::configure ( const WireCell::Configuration &  config )

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 29 of file ClusterSink.cxx.

{
    m_filename = get(cfg, "filename", m_filename);
    m_node_types = get(cfg, "node_types", m_node_types);
}

WireCell::Configuration Img::ClusterSink::default_configuration ( ) const

virtual

Optional, override to return a hard-coded default configuration.

Reimplemented from WireCell::IConfigurable.

Definition at line 35 of file ClusterSink.cxx.

{
    WireCell::Configuration cfg;
    cfg["filename"] = m_filename;

    // A string with any of characters "wcbsm".  Including wires and
    // channels tends to make a crazy big plot so by default they are
    // excluded.
    cfg["node_types"] = m_node_types;
    return cfg;
}

bool Img::ClusterSink::operator() ( const ICluster::pointer &  in )

virtual

The calling signature:

Implements WireCell::ISinkNode< ICluster >.

Definition at line 98 of file ClusterSink.cxx.

{
    if (!cluster) {
        return true;
    }
    
    std::string fname = m_filename;
    if (fname.empty()) {
        return true;
    }

    if (m_filename.find("%") != std::string::npos) {
        fname = String::format(m_filename, cluster->ident());
    }
    std::ofstream out(fname.c_str());
    spdlog::info("Writing graphviz to {}", fname);

    std::unordered_set<char> keep(m_node_types.begin(), m_node_types.end());

    // use indexed graph basically just for the copy()
    const cluster_graph_t& gr = cluster->graph();
    cluster_indexed_graph_t grind;

    for (const auto& v : boost::make_iterator_range(boost::vertices(gr))) {
        const auto& vobj = gr[v];
        if (!keep.count(vobj.code())) {
            continue;
        }
        grind.vertex(vobj);
        for (auto edge : boost::make_iterator_range(boost::out_edges(v, gr))) {
            auto v2 = boost::target(edge, gr);
            const auto& vobj2 = gr[v2];
            if (keep.count(vobj2.code())) {
                grind.edge(vobj, vobj2);
            }
        }
    }
    const cluster_graph_t& gr2 = grind.graph();
    boost::write_graphviz(out, gr2, label_writer_t{gr2});

    return true;
}

Member Data Documentation

std::string WireCell::Img::ClusterSink::m_filename

private

Definition at line 22 of file ClusterSink.h.

std::string WireCell::Img::ClusterSink::m_node_types

private

Definition at line 23 of file ClusterSink.h.

---

The documentation for this class was generated from the following files:

• wire-cell-build/img/inc/WireCellImg/ClusterSink.h
• wire-cell-build/img/src/ClusterSink.cxx