lariov::ChannelStatusService Class Reference

Service providing information about the quality of channels. More...

#include <ChannelStatusService.h>

Inheritance diagram for lariov::ChannelStatusService:

Public Types
using	provider_type = ChannelStatusProvider

Public Member Functions
virtual	~ChannelStatusService ()=default
	Destructor. More...
ChannelStatusProvider const *	provider () const
ChannelStatusProvider const &	GetProvider () const
	Returns a reference to the service provider. More...
ChannelStatusProvider const &	GetFilter () const
ChannelStatusProvider const *	GetProviderPtr () const
	Returns a pointer to the service provider. More...
ChannelStatusProvider const *	GetFilterPtr () const

Private Member Functions
virtual ChannelStatusProvider const *	DoGetProviderPtr () const =0
	Returns a pointer to the service provider. More...
virtual ChannelStatusProvider const &	DoGetProvider () const =0
	Returns a reference to the service provider. More...

Detailed Description

Service providing information about the quality of channels.

This service provides only a simple interface. Experiments need to implement and configure their own service implementing this interface. The simplest implementation is provided in LArSoft: SimpleChannelStatusService.

Currently, the service provides interface for the following information:

• goodness of the channel: good or bad (dead or unusable)
• noisiness of the channel: good or noisy (or compromised in some way)
• presence of the channel: connected to a wire or not

The use of this service replaces the deprecated ChannelFilter class. An algorithm that used to use ChannelFilter class can be updated. From:

 filter::ChannelFilter* chanFilt = new filter::ChannelFilter();

to

 art::ServiceHandle<lariov::ChannelStatusService const> chanFilt;

(include files CalibrationDBI/Interface/ChannelStatusService.h instead of Filters/ChannelFilter.h) or

 lariov::ChannelStatusProvider const& chanFilt
   = art::ServiceHandle<lariov::ChannelStatusService const>()
     ->GetProvider();

(include files CalibrationDBI/Interface/ChannelStatusService.h and CalibrationDBI/Interface/ChannelStatusProvider.h instead of Filters/ChannelFilter.h). The latter object can in principle be passed to algorithms that are not art-aware.

Definition at line 66 of file ChannelStatusService.h.

Member Typedef Documentation

using lariov::ChannelStatusService::provider_type = ChannelStatusProvider

Definition at line 70 of file ChannelStatusService.h.

Constructor & Destructor Documentation

virtual lariov::ChannelStatusService::~ChannelStatusService ( )

virtualdefault

Destructor.

Member Function Documentation

virtual ChannelStatusProvider const& lariov::ChannelStatusService::DoGetProvider ( ) const

privatepure virtual

Returns a reference to the service provider.

Implemented in detvar::RandomChannelStatusService, lariov::SimpleChannelStatusService, and lariov::SIOVChannelStatusService.

virtual ChannelStatusProvider const* lariov::ChannelStatusService::DoGetProviderPtr ( ) const

privatepure virtual

Returns a pointer to the service provider.

Implemented in detvar::RandomChannelStatusService, lariov::SimpleChannelStatusService, and lariov::SIOVChannelStatusService.

ChannelStatusProvider const& lariov::ChannelStatusService::GetFilter ( ) const

inline

Definition at line 84 of file ChannelStatusService.h.

{ return GetProvider(); }

ChannelStatusProvider const* lariov::ChannelStatusService::GetFilterPtr ( ) const

inline

Definition at line 92 of file ChannelStatusService.h.

        { return GetProviderPtr(); }

ChannelStatusProvider const& lariov::ChannelStatusService::GetProvider ( ) const

inline

Returns a reference to the service provider.

Definition at line 81 of file ChannelStatusService.h.

        { return DoGetProvider(); }

ChannelStatusProvider const* lariov::ChannelStatusService::GetProviderPtr ( ) const

inline

Returns a pointer to the service provider.

Definition at line 89 of file ChannelStatusService.h.

        { return DoGetProviderPtr(); }

ChannelStatusProvider const* lariov::ChannelStatusService::provider ( ) const

inline

Definition at line 97 of file ChannelStatusService.h.

        { return GetProviderPtr(); }

---

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

• larevt/larevt/CalibrationDBI/Interface/ChannelStatusService.h