evd::details::CellGridClass Class Reference

Manages a grid-like division of 2D space. More...

Public Member Functions
	CellGridClass ()
	Default constructor: invalid ranges. More...
	CellGridClass (unsigned int nWires, unsigned int nTDC)
	Constructor: sets the extremes and assumes one cell for each element. More...
	CellGridClass (float min_wire, float max_wire, unsigned int nWires, float min_tdc, float max_tdc, unsigned int nTDC)
	Constructor: sets the wire and TDC ranges in detail. More...
size_t	NCells () const
	Returns the total number of cells in the grid. More...
GridAxisClass const &	WireAxis () const
	Return the information about the wires. More...
GridAxisClass const &	TDCAxis () const
	Return the information about the TDCs. More...
std::ptrdiff_t	GetCell (float wire, float tick) const
	Returns the index of specified cell, or -1 if out of range. More...
std::tuple< float, float, float, float >	GetCellBox (std::ptrdiff_t iCell) const
	Returns the coordinates { w1, t1, w2, t2 } of specified cell. More...
template<typename CONT >
bool	Add (CONT &cont, float wire, float tick, typename CONT::value_type v)
bool	SetMinWireCellSize (float min_size)
	Sets the minimum size for wire cells. More...
bool	SetMinTDCCellSize (float min_size)
	Sets the minimum size for TDC cells. More...
template<typename Stream >
void	Dump (Stream &&out) const
	Prints the current axes on the specified stream. More...
bool	hasWire (float wire) const
	Returns whether the range includes the specified wire. More...
bool	hasWire (int wire) const
	Returns whether the range includes the specified wire. More...
bool	hasTick (float tick) const
	Returns whether the range includes the specified wire. More...
bool	hasTick (int tick) const
	Returns whether the range includes the specified wire. More...
Setters
Sets a simple wire range: all the wires, one cell per wire
void	SetWireRange (unsigned int nWires)
	Sets the wire range, leaving the number of wire cells unchanged. More...
void	SetWireRange (float min_wire, float max_wire)
	Sets the wire range, leaving the number of wire cells unchanged. More...
void	SetWireRange (float min_wire, float max_wire, unsigned int nWires)
	Sets the complete wire range. More...
void	SetWireRange (float min_wire, float max_wire, unsigned int nWires, float min_size)
	Sets the complete wire range, with minimum cell size. More...
void	SetTDCRange (unsigned int nTDC)
	Sets a simple TDC range: all the ticks, one cell per tick. More...
void	SetTDCRange (float min_tdc, float max_tdc, unsigned int nTDC)
	Sets the complete TDC range. More...
void	SetTDCRange (float min_tdc, float max_tdc)
	Sets the TDC range, leaving the number of ticks unchanged. More...
void	SetTDCRange (float min_tdc, float max_tdc, unsigned int nTDC, float min_size)
	Sets the complete TDC range, with minimum cell size. More...

Protected Attributes
GridAxisClass	wire_axis
GridAxisClass	tdc_axis

Detailed Description

Manages a grid-like division of 2D space.

Definition at line 405 of file RawDataDrawer.cxx.

Constructor & Destructor Documentation

evd::details::CellGridClass::CellGridClass ( )

inline

Default constructor: invalid ranges.

Definition at line 409 of file RawDataDrawer.cxx.

: wire_axis(), tdc_axis() {}

evd::details::CellGridClass::CellGridClass	(	unsigned int	nWires,
		unsigned int	nTDC
	)

Constructor: sets the extremes and assumes one cell for each element.

Definition at line 1919 of file RawDataDrawer.cxx.

      : wire_axis((size_t) nWires, 0., float(nWires))
      , tdc_axis((size_t) nTDC, 0., float(nTDC))
    {
    } // CellGridClass::CellGridClass(int, int)

evd::details::CellGridClass::CellGridClass	(	float	min_wire,
		float	max_wire,
		unsigned int	nWires,
		float	min_tdc,
		float	max_tdc,
		unsigned int	nTDC
	)

Constructor: sets the wire and TDC ranges in detail.

Definition at line 1927 of file RawDataDrawer.cxx.

      : wire_axis((size_t) nWires, min_wire, max_wire)
      , tdc_axis((size_t) nTDC, min_tdc, max_tdc)
    {
    } // CellGridClass::CellGridClass({ float, float, int } x 2)

Member Function Documentation

template<typename CONT >

bool evd::details::CellGridClass::Add ( CONT &  cont, float  wire, float  tick, typename CONT::value_type  v  )

inline

Increments the specified cell of cont with the value v

Returns

whether there was such a cell

Definition at line 453 of file RawDataDrawer.cxx.

        {
          std::ptrdiff_t cell = GetCell(wire, tick);
          if (cell < 0) return false;
          cont[(size_t) cell] += v;
          return true;
        } // Add()

template<typename Stream >

void evd::details::CellGridClass::Dump

(

Stream &&

out

)

const

Prints the current axes on the specified stream.

Definition at line 1966 of file RawDataDrawer.cxx.

References evd::details::GridAxisClass::Dump(), TDCAxis(), and WireAxis().

                                               {
      out << "Wire axis: ";
      WireAxis().Dump(out);
      out << "; time axis: ";
      TDCAxis().Dump(out);
    } // CellGridClass::Dump()

std::ptrdiff_t evd::details::CellGridClass::GetCell	(	float	wire,
		float	tick
	)		const

Returns the index of specified cell, or -1 if out of range.

Definition at line 1938 of file RawDataDrawer.cxx.

References evd::details::GridAxisClass::GetCell(), GetCellBox(), evd::details::GridAxisClass::hasCell(), evd::details::GridAxisClass::NCells(), tdc_axis, TDCAxis(), and wire_axis.

                                                                    {
      std::ptrdiff_t iWireCell = wire_axis.GetCell(wire);
      if (!wire_axis.hasCell(iWireCell)) return std::ptrdiff_t(-1);
      std::ptrdiff_t iTDCCell = tdc_axis.GetCell(tick);
      if (!tdc_axis.hasCell(iTDCCell)) return std::ptrdiff_t(-1);
      return iWireCell * TDCAxis().NCells() + iTDCCell;
    } // CellGridClass::GetCell()

std::tuple< float, float, float, float > evd::details::CellGridClass::GetCellBox

(

std::ptrdiff_t

iCell

)

const

Returns the coordinates { w1, t1, w2, t2 } of specified cell.

Definition at line 1949 of file RawDataDrawer.cxx.

References evd::details::GridAxisClass::LowerEdge(), evd::details::GridAxisClass::NCells(), TDCAxis(), evd::details::GridAxisClass::UpperEdge(), and WireAxis().

Referenced by GetCell(), and evd::RawDataDrawer::QueueDrawingBoxes().

    {
      // { w1, t1, w2, t2 }
      size_t const nTDCCells = TDCAxis().NCells();
      std::ptrdiff_t iWireCell = (std::ptrdiff_t) (iCell / nTDCCells),
        iTDCCell = (std::ptrdiff_t) (iCell % nTDCCells);
      
      
      return std::tuple<float, float, float, float>(
        WireAxis().LowerEdge(iWireCell), TDCAxis().LowerEdge(iTDCCell),
        WireAxis().UpperEdge(iWireCell), TDCAxis().UpperEdge(iTDCCell)
        );
    } // CellGridClass::GetCellBox()

bool evd::details::CellGridClass::hasTick ( float  tick ) const

inline

Returns whether the range includes the specified wire.

Definition at line 445 of file RawDataDrawer.cxx.

{ return tdc_axis.hasCoord(tick); }

bool evd::details::CellGridClass::hasTick ( int  tick ) const

inline

Returns whether the range includes the specified wire.

Definition at line 446 of file RawDataDrawer.cxx.

References hasTick().

Referenced by hasTick().

{ return hasTick((float) tick); }

bool evd::details::CellGridClass::hasWire ( float  wire ) const

inline

Returns whether the range includes the specified wire.

Definition at line 439 of file RawDataDrawer.cxx.

{ return wire_axis.hasCoord(wire); }

bool evd::details::CellGridClass::hasWire ( int  wire ) const

inline

Returns whether the range includes the specified wire.

Definition at line 440 of file RawDataDrawer.cxx.

References hasWire().

Referenced by hasWire().

{ return hasWire((float) wire); }

size_t evd::details::CellGridClass::NCells ( ) const

inline

Returns the total number of cells in the grid.

Definition at line 421 of file RawDataDrawer.cxx.

{ return wire_axis.NCells() * tdc_axis.NCells(); }

bool evd::details::CellGridClass::SetMinTDCCellSize ( float  min_size )

inline

Sets the minimum size for TDC cells.

Definition at line 511 of file RawDataDrawer.cxx.

Referenced by evd::RawDataDrawer::SetDrawingLimits().

        { return tdc_axis.SetMinCellSize(min_size); }

bool evd::details::CellGridClass::SetMinWireCellSize ( float  min_size )

inline

Sets the minimum size for wire cells.

Definition at line 507 of file RawDataDrawer.cxx.

Referenced by evd::RawDataDrawer::SetDrawingLimits().

        { return wire_axis.SetMinCellSize(min_size); }

void evd::details::CellGridClass::SetTDCRange ( unsigned int  nTDC )

inline

Sets a simple TDC range: all the ticks, one cell per tick.

Definition at line 485 of file RawDataDrawer.cxx.

Referenced by evd::RawDataDrawer::ExtractRange(), and evd::RawDataDrawer::SetDrawingLimits().

        { SetTDCRange(0., (float) nTDC, nTDC); }

void evd::details::CellGridClass::SetTDCRange ( float  min_tdc, float  max_tdc, unsigned int  nTDC  )

inline

Sets the complete TDC range.

Definition at line 489 of file RawDataDrawer.cxx.

        { tdc_axis.Init(nTDC, min_tdc, max_tdc); }

void evd::details::CellGridClass::SetTDCRange ( float  min_tdc, float  max_tdc  )

inline

Sets the TDC range, leaving the number of ticks unchanged.

Definition at line 493 of file RawDataDrawer.cxx.

        { tdc_axis.SetLimits(min_tdc, max_tdc); }

void evd::details::CellGridClass::SetTDCRange ( float  min_tdc, float  max_tdc, unsigned int  nTDC, float  min_size  )

inline

Sets the complete TDC range, with minimum cell size.

Definition at line 498 of file RawDataDrawer.cxx.

        {
          tdc_axis.Init(nTDC, min_tdc, max_tdc);
          tdc_axis.SetMinCellSize(min_size);
        }

void evd::details::CellGridClass::SetWireRange ( unsigned int  nWires )

inline

Sets the wire range, leaving the number of wire cells unchanged.

Definition at line 465 of file RawDataDrawer.cxx.

Referenced by evd::RawDataDrawer::ExtractRange(), and evd::RawDataDrawer::SetDrawingLimits().

        { SetWireRange(0., (float) nWires, nWires); }

void evd::details::CellGridClass::SetWireRange ( float  min_wire, float  max_wire  )

inline

Sets the wire range, leaving the number of wire cells unchanged.

Definition at line 469 of file RawDataDrawer.cxx.

        { wire_axis.SetLimits(min_wire, max_wire); }

void evd::details::CellGridClass::SetWireRange ( float  min_wire, float  max_wire, unsigned int  nWires  )

inline

Sets the complete wire range.

Definition at line 473 of file RawDataDrawer.cxx.

        { wire_axis.Init(nWires, min_wire, max_wire); }

void evd::details::CellGridClass::SetWireRange ( float  min_wire, float  max_wire, unsigned int  nWires, float  min_size  )

inline

Sets the complete wire range, with minimum cell size.

Definition at line 478 of file RawDataDrawer.cxx.

        {
          wire_axis.Init(nWires, min_wire, max_wire);
          wire_axis.SetMinCellSize(min_size);
        }

GridAxisClass const& evd::details::CellGridClass::TDCAxis ( ) const

inline

Return the information about the TDCs.

Definition at line 427 of file RawDataDrawer.cxx.

Referenced by Dump(), GetCell(), and GetCellBox().

{ return tdc_axis; }

GridAxisClass const& evd::details::CellGridClass::WireAxis ( ) const

inline

Return the information about the wires.

Definition at line 424 of file RawDataDrawer.cxx.

Referenced by Dump(), and GetCellBox().

{ return wire_axis; }

Member Data Documentation

GridAxisClass evd::details::CellGridClass::tdc_axis

protected

Definition at line 520 of file RawDataDrawer.cxx.

Referenced by GetCell().

GridAxisClass evd::details::CellGridClass::wire_axis

protected

Definition at line 519 of file RawDataDrawer.cxx.

Referenced by GetCell().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/lareventdisplay/v07_02_02/source/lareventdisplay/EventDisplay/RawDataDrawer.cxx