#include <IFrame.h>

Inheritance diagram for WireCell::IFrame:

Public Types
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

Public Member Functions
virtual	~IFrame ()

virtual const tag_list_t &	frame_tags () const =0

virtual const tag_list_t &	trace_tags () const =0

virtual const trace_list_t &	tagged_traces (const tag_t &tag) const =0

virtual const trace_summary_t &	trace_summary (const tag_t &tag) const =0

virtual ITrace::shared_vector	traces () const =0
	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 int	ident () const =0
	Return an identifying number of this frame. More...

virtual double	time () const =0

virtual double	tick () const =0
	Return the digitization sample period. More...

Public Member Functions inherited from WireCell::IData< IFrame >
virtual	~IData ()

Detailed Description

Interface to a sequence of traces.

Definition at line 17 of file IFrame.h.

Member Typedef Documentation

typedef std::vector<tag_t> WireCell::IFrame::tag_list_t

Definition at line 33 of file IFrame.h.

typedef std::string WireCell::IFrame::tag_t

Definition at line 28 of file IFrame.h.

typedef std::vector<size_t> WireCell::IFrame::trace_list_t

Definition at line 36 of file IFrame.h.

typedef std::vector<double> WireCell::IFrame::trace_summary_t

Definition at line 39 of file IFrame.h.

Constructor & Destructor Documentation

IFrame::~IFrame ( )

virtual

Definition at line 133 of file IfaceDesctructors.cxx.

133 {}

Member Function Documentation

virtual const tag_list_t& WireCell::IFrame::frame_tags ( ) const

pure virtual

Implemented in wcls::LazyFrame, and WireCell::SimpleFrame.

virtual int WireCell::IFrame::ident ( ) const

pure virtual

Return an identifying number of this frame.

Implemented in wcls::LazyFrame, and WireCell::SimpleFrame.

virtual Waveform::ChannelMaskMap WireCell::IFrame::masks ( ) const

inlinevirtual

Return all masks associated with this frame.

Reimplemented in WireCell::SimpleFrame.

Definition at line 64 of file IFrame.h.

                                                      {
             return Waveform::ChannelMaskMap(); // default is empty
         }

virtual const trace_list_t& WireCell::IFrame::tagged_traces ( const tag_t & tag ) const

pure virtual

Implemented in wcls::LazyFrame, and WireCell::SimpleFrame.

virtual double WireCell::IFrame::tick ( ) const

pure virtual

Return the digitization sample period.

Implemented in wcls::LazyFrame, and WireCell::SimpleFrame.

virtual double WireCell::IFrame::time ( ) const

pure 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.

Implemented in wcls::LazyFrame, and WireCell::SimpleFrame.

virtual const trace_summary_t& WireCell::IFrame::trace_summary ( const tag_t & tag ) const

pure virtual

Implemented in wcls::LazyFrame, and WireCell::SimpleFrame.

virtual const tag_list_t& WireCell::IFrame::trace_tags ( ) const

pure virtual

Implemented in wcls::LazyFrame, and WireCell::SimpleFrame.

virtual ITrace::shared_vector WireCell::IFrame::traces ( ) const

pure virtual

Return a vector of all traces ignoring any potential tag.

Implemented in wcls::LazyFrame, and WireCell::SimpleFrame.

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