WireCell::SimpleFrame Class Reference

#include <SimpleFrame.h>

Inheritance diagram for WireCell::SimpleFrame:

Collaboration diagram for WireCell::SimpleFrame:

Public Member Functions
	SimpleFrame (int ident, double time, const ITrace::vector &traces, double tick=0.5 *units::microsecond, const Waveform::ChannelMaskMap &cmm=Waveform::ChannelMaskMap())
	SimpleFrame (int ident, double time, ITrace::shared_vector traces, double tick=0.5 *units::microsecond, const Waveform::ChannelMaskMap &cmm=Waveform::ChannelMaskMap())
	~SimpleFrame ()
virtual int	ident () const
	Return an identifying number of this frame. More...
virtual double	time () const
virtual double	tick () const
	Return the digitization sample period. More...
virtual ITrace::shared_vector	traces () const
	Return a vector of all traces ignoring any potential tag. More...
virtual Waveform::ChannelMaskMap	masks () const
	Return all masks associated with this frame. More...
virtual const tag_list_t &	frame_tags () const
virtual const tag_list_t &	trace_tags () const
virtual const trace_list_t &	tagged_traces (const tag_t &tag) const
virtual const trace_summary_t &	trace_summary (const tag_t &tag) const
void	tag_frame (const tag_t &tag)
void	tag_traces (const tag_t &tag, const IFrame::trace_list_t &indices, const IFrame::trace_summary_t &summary=IFrame::trace_summary_t(0))
Public Member Functions inherited from WireCell::IFrame
virtual	~IFrame ()
Public Member Functions inherited from WireCell::IData< IFrame >
virtual	~IData ()

Additional Inherited Members
Public Types inherited from WireCell::IFrame
typedef std::string	tag_t
typedef std::vector< tag_t >	tag_list_t
typedef std::vector< size_t >	trace_list_t
typedef std::vector< double >	trace_summary_t
Public Types inherited from WireCell::IData< IFrame >
typedef IFrame	value_type
typedef std::shared_ptr< const IFrame >	pointer
typedef std::vector< pointer >	vector
typedef std::shared_ptr< const vector >	shared_vector

Detailed Description

A simple frame.

This is is nothing more than a bag of data.

Definition at line 15 of file SimpleFrame.h.

Constructor & Destructor Documentation

SimpleFrame() [1/2]

SimpleFrame::SimpleFrame	(	int	ident,
		double	time,
		const ITrace::vector &	traces,
		double	tick = 0.5*units::microsecond,
		const Waveform::ChannelMaskMap &	cmm = Waveform::ChannelMaskMap()
	)

Definition at line 6 of file SimpleFrame.cxx.

SimpleFrame() [2/2]

SimpleFrame::SimpleFrame	(	int	ident,
		double	time,
		ITrace::shared_vector	traces,
		double	tick = 0.5*units::microsecond,
		const Waveform::ChannelMaskMap &	cmm = Waveform::ChannelMaskMap()
	)

Definition at line 13 of file SimpleFrame.cxx.

~SimpleFrame()

SimpleFrame::~SimpleFrame

(

)

Definition at line 20 of file SimpleFrame.cxx.

Member Function Documentation

frame_tags()

const IFrame::tag_list_t & SimpleFrame::frame_tags ( ) const

virtual

Implements WireCell::IFrame.

Definition at line 52 of file SimpleFrame.cxx.

Here is the caller graph for this function:

ident()

int SimpleFrame::ident ( ) const

virtual

Return an identifying number of this frame.

Implements WireCell::IFrame.

Definition at line 24 of file SimpleFrame.cxx.

masks()

Waveform::ChannelMaskMap SimpleFrame::masks ( ) const

virtual

Return all masks associated with this frame.

Reimplemented from WireCell::IFrame.

Definition at line 31 of file SimpleFrame.cxx.

tag_frame()

void SimpleFrame::tag_frame

(

const tag_t &

tag

)

Definition at line 71 of file SimpleFrame.cxx.

tag_traces()

void SimpleFrame::tag_traces	(	const tag_t &	tag,
		const IFrame::trace_list_t &	indices,
		const IFrame::trace_summary_t &	summary = IFrame::trace_summary_t(0)
	)

Definition at line 76 of file SimpleFrame.cxx.

Here is the caller graph for this function:

tagged_traces()

const IFrame::trace_list_t & SimpleFrame::tagged_traces ( const tag_t &  tag ) const

virtual

Implements WireCell::IFrame.

Definition at line 61 of file SimpleFrame.cxx.

tick()

double SimpleFrame::tick ( ) const

virtual

Return the digitization sample period.

Implements WireCell::IFrame.

Definition at line 26 of file SimpleFrame.cxx.

time()

double SimpleFrame::time ( ) const

virtual

Return the reference time of the frame w.r.t. some global time. Note, each trace has a "tbin" counting number of ticks w.r.t. to this time where the trace starts. In general, tbin is not zero.

Implements WireCell::IFrame.

Definition at line 25 of file SimpleFrame.cxx.

trace_summary()

const IFrame::trace_summary_t & SimpleFrame::trace_summary ( const tag_t &  tag ) const

virtual

Implements WireCell::IFrame.

Definition at line 66 of file SimpleFrame.cxx.

trace_tags()

const IFrame::tag_list_t & SimpleFrame::trace_tags ( ) const

virtual

Implements WireCell::IFrame.

Definition at line 56 of file SimpleFrame.cxx.

traces()

ITrace::shared_vector SimpleFrame::traces ( ) const

virtual

Return a vector of all traces ignoring any potential tag.

Implements WireCell::IFrame.

Definition at line 28 of file SimpleFrame.cxx.

---

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

• iface/inc/WireCellIface/SimpleFrame.h
• iface/src/SimpleFrame.cxx