WireCell::Sio::NumpyFrameSaver Class Reference

#include <NumpyFrameSaver.h>

Inheritance diagram for WireCell::Sio::NumpyFrameSaver:

Public Member Functions
	NumpyFrameSaver ()
virtual	~NumpyFrameSaver ()
virtual bool	operator() (const WireCell::IFrame::pointer &inframe, WireCell::IFrame::pointer &outframe)
	IFrameFilter. More...
virtual WireCell::Configuration	default_configuration () const
	IConfigurable. More...
virtual void	configure (const WireCell::Configuration &config)
	Accept a configuration. More...
Public Member Functions inherited from WireCell::IFrameFilter
virtual	~IFrameFilter ()
virtual std::string	signature ()
	Set the signature for all subclasses. More...
Public Member Functions inherited from WireCell::IFunctionNode< IFrame, IFrame >
virtual	~IFunctionNode ()
virtual bool	operator() (const boost::any &anyin, boost::any &anyout)
	The calling signature: More...
virtual std::vector< std::string >	input_types ()
virtual std::vector< std::string >	output_types ()
Public Member Functions inherited from WireCell::IFunctionNodeBase
virtual	~IFunctionNodeBase ()
virtual NodeCategory	category ()
	Return the behavior category type. More...
virtual int	concurrency ()
	By default assume all subclasses are stateless. More...
Public Member Functions inherited from WireCell::INode
virtual	~INode ()
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
Configuration	m_cfg
int	m_save_count
Log::logptr_t	l

Additional Inherited Members
Public Types inherited from WireCell::IFrameFilter
typedef std::shared_ptr< IFrameFilter >	pointer
Public Types inherited from WireCell::IFunctionNode< IFrame, IFrame >
typedef IFrame	input_type
typedef IFrame	output_type
typedef std::shared_ptr< const IFrame >	input_pointer
typedef std::shared_ptr< const IFrame >	output_pointer
typedef IFunctionNode< IFrame, IFrame >	signature_type
Public Types inherited from WireCell::IFunctionNodeBase
typedef std::shared_ptr< IFunctionNodeBase >	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 14 of file NumpyFrameSaver.h.

Constructor & Destructor Documentation

Sio::NumpyFrameSaver::NumpyFrameSaver

(

)

Definition at line 18 of file NumpyFrameSaver.cxx.

    : m_save_count(0)
    , l(Log::logger("io"))
{
}

Sio::NumpyFrameSaver::~NumpyFrameSaver ( )

virtual

Definition at line 24 of file NumpyFrameSaver.cxx.

{
}

Member Function Documentation

void Sio::NumpyFrameSaver::configure ( const WireCell::Configuration &  config )

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 65 of file NumpyFrameSaver.cxx.

{
    m_cfg = config;
}

WireCell::Configuration Sio::NumpyFrameSaver::default_configuration ( ) const

virtual

IConfigurable.

Reimplemented from WireCell::IConfigurable.

Definition at line 29 of file NumpyFrameSaver.cxx.

{
    Configuration cfg;

    // If digitize is true, then samples as 16 bit ints.  Otherwise
    // save as 32 bit floats.
    cfg["digitize"] = false;

    // This number is set to the waveform sample array before any
    // charge is added.
    cfg["baseline"] = 0.0;

    // This number will be multiplied to each waveform sample before
    // casting to dtype.
    cfg["scale"] = 1.0;

    // This number will be added to each scaled waveform sample before
    // casting to dtype.
    cfg["offset"] = 0.0;

    // The frame tags to consider for saving.  If null or empty then all traces are used.
    cfg["frame_tags"] = Json::arrayValue;
    // The summary tags to consider for saving
    //cfg["summary_tags"] = Json::arrayValue;    
    // The channel mask maps to consider for saving
    //cfg["chanmaskmaps"] = Json::arrayValue;

    // The output file name to write.  Only compressed (zipped) Numpy
    // files are supported.  Writing is always in "append" mode.  It's
    // up to the user to delete a previous instance of the file if
    // it's old contents are not wanted.
    cfg["filename"] = "wct-frame.npz";
        
    return cfg;
}

bool Sio::NumpyFrameSaver::operator() ( const WireCell::IFrame::pointer &  inframe, WireCell::IFrame::pointer &  outframe  )

virtual

IFrameFilter.

Implements WireCell::IFunctionNode< IFrame, IFrame >.

Definition at line 71 of file NumpyFrameSaver.cxx.

{
    if (!inframe) {
        l->debug("NumpyFrameSaver: EOS");
        outframe = nullptr;
        return true;
    }
    
    outframe = inframe;         // pass through actual frame

    const std::string mode = "a";

    const float baseline = m_cfg["baseline"].asFloat();
    const float scale = m_cfg["scale"].asFloat();
    const float offset = m_cfg["offset"].asFloat();
    const bool digitize = m_cfg["digitize"].asBool();

    const std::string fname = m_cfg["filename"].asString();

    // Eigen3 array is indexed as (irow, icol) or (ichan, itick)
    // one row is one channel, one column is a tick.
    // Numpy saves reversed dimensions: {ncols, nrows} aka {ntick, nchan} dimensions.


    if (m_cfg["frame_tags"].isNull() or m_cfg["frame_tags"].empty()) {
        m_cfg["frame_tags"][0] = "";
    }


    std::stringstream ss;
    ss << "NumpyFrameSaver: see frame #" << inframe->ident()
       << " with " << inframe->traces()->size() << " traces with frame tags:";
    for (auto t : inframe->frame_tags()) {
        ss << " \"" << t << "\"";
    }
    ss << " and trace tags:";
    for (auto t : inframe->trace_tags()) {
        ss << " \"" << t << "\"";
    }
    ss << " looking for tags:";
    for (auto jt: m_cfg["frame_tags"]) {
        ss << " \"" << jt.asString() << "\"";
    }
    l->debug(ss.str());


    for (auto jtag : m_cfg["frame_tags"]) {
        const std::string tag = jtag.asString();
        auto traces = FrameTools::tagged_traces(inframe, tag);
        l->debug("NumpyFrameSaver: save {} tagged as {}", traces.size(), tag);
        if (traces.empty()) {
            l->warn("NumpyFrameSaver: no traces for tag: \"{}\"", tag);
            continue;
        }
        auto channels = FrameTools::channels(traces);
        std::sort(channels.begin(), channels.end());
        auto chbeg = channels.begin();
        auto chend = std::unique(chbeg, channels.end());
        auto tbinmm = FrameTools::tbin_range(traces);

        // fixme: may want to give user some config over tbin range to save.
        const size_t ncols = tbinmm.second-tbinmm.first;
        const size_t nrows = std::distance(chbeg, chend);
        l->debug("NumpyFrameSaver: saving ncols={} nrows={}", ncols, nrows);

        Array::array_xxf arr = Array::array_xxf::Zero(nrows, ncols) + baseline;
        FrameTools::fill(arr, traces, channels.begin(), chend, tbinmm.first);
        arr = arr * scale + offset;

        {                   // the 2D frame array
            const std::string aname = String::format("frame_%s_%d", tag.c_str(), m_save_count);
            if (digitize) {
                Array::array_xxs sarr = arr.cast<short>();
                const short* sdata = sarr.data();
                cnpy::npz_save(fname, aname, sdata, {ncols, nrows}, mode);
            }
            else {
                cnpy::npz_save(fname, aname, arr.data(), {ncols, nrows}, mode);
            }
            l->debug("NumpyFrameSaver: saved {} with {} channels {} ticks @t={} ms qtot={}",
                     aname, nrows, ncols, inframe->time() / units::ms, arr.sum());
        }

        {                   // the channel array
            const std::string aname = String::format("channels_%s_%d", tag.c_str(), m_save_count);
            cnpy::npz_save(fname, aname, channels.data(), {nrows}, mode);
        }

        {                   // the tick array
            const std::string aname = String::format("tickinfo_%s_%d", tag.c_str(), m_save_count);
            const std::vector<double> tickinfo{inframe->time(), inframe->tick(), (double)tbinmm.first};
            cnpy::npz_save(fname, aname, tickinfo.data(), {3}, mode);
        }
    }

    ++m_save_count;
    return true;
}

Member Data Documentation

Log::logptr_t WireCell::Sio::NumpyFrameSaver::l

private

Definition at line 31 of file NumpyFrameSaver.h.

Configuration WireCell::Sio::NumpyFrameSaver::m_cfg

private

Definition at line 29 of file NumpyFrameSaver.h.

int WireCell::Sio::NumpyFrameSaver::m_save_count

private

Definition at line 30 of file NumpyFrameSaver.h.

---

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

• wire-cell-build/sio/inc/WireCellSio/NumpyFrameSaver.h
• wire-cell-build/sio/src/NumpyFrameSaver.cxx