List of all members | Public Member Functions | Private Member Functions | Private Attributes | Friends
revt::Channel Class Reference

Class that holds the data associated to an individual radio channel. More...

#include <revt/Channel.h>

Public Member Functions

ChannelADCTimeSeriesGetChannelADCTimeSeries ()
 Get Channel ADC trace (write access, only use this if you intend to change the data) More...
 
const ChannelADCTimeSeriesGetChannelADCTimeSeries () const
 Get const Channel ADC trace (read only) More...
 
ChannelFrequencySpectrumGetChannelFrequencySpectrum ()
 retrieve Channel Frequency Spectrum (write access, only use this if you intend to change the data) More...
 
const ChannelFrequencySpectrumGetChannelFrequencySpectrum () const
 retrieve Channel Frequency Spectrum (read access) More...
 
ChannelTimeSeriesGetChannelTimeSeries ()
 retrieve Channel Time Series (write access, only use this if you intend to change the data) More...
 
const ChannelTimeSeriesGetChannelTimeSeries () const
 retrieve Channel Time Series (read access) More...
 
ChannelFFTDataContainerGetFFTDataContainer ()
 retrieve Channel FFTDataContainer (write access) More...
 
const ChannelFFTDataContainerGetFFTDataContainer () const
 retrieve Channel FFTDataContainer (read access) More...
 
double GetFrequencyOfBin (const ChannelFrequencySpectrum::SizeType bin) const
 Get the frequency corresponding to a bin of the frequency spectrum. More...
 
int GetId () const
 Return Id of the Channel. More...
 
double GetMaximumFrequency () const
 Get the maximum frequency of the spectrum frequency spectrum. More...
 
double GetMinimumFrequency () const
 Get the mimimum frequency of the spectrum frequency spectrum. More...
 
unsigned int GetNoiseThreshold () const
 From DAQ. More...
 
unsigned int GetNyquistZone () const
 Get the Nyquist zone. More...
 
unsigned int GetParity () const
 Get parity of the Channel. More...
 
ChannelRecDataGetRecData ()
 Get channel level reconstructed data. More...
 
const ChannelRecDataGetRecData () const
 
double GetScintHighVoltage () const
 
unsigned int GetSignalThreshold () const
 From DAQ. More...
 
int GetStationId () const
 Return Id of the station to which this Channel belongs. More...
 
bool HasRecData () const
 Check whether channel reconstructed data exists. More...
 
bool IsActive () const
 
bool IsSaturated () const
 
void MakeRecData ()
 Make channel reconstructed data object. More...
 
void SetActive ()
 Active means that it is used in reconstruction. By default this is true after read-in, but can be deactivated later. More...
 
void SetNoiseThreshold (const unsigned int thresh)
 From DAQ. More...
 
void SetNotActive ()
 
void SetNotSaturated ()
 
void SetNyquistZone (const unsigned int zone)
 Set the Nyquist zone. More...
 
void SetParity (const unsigned int parity)
 Set parity of the Channel. More...
 
void SetSaturated ()
 
void SetScintHighVoltage (const double scinthv)
 From DAQ. More...
 
void SetSignalThreshold (const unsigned int thresh)
 

Private Member Functions

 Channel (const int stationId, const int id)
 

Private Attributes

ChannelADCTimeSeries fChannelADCTrace
 
ChannelFFTDataContainer fFFTDataContainer
 
int fId = 0
 
bool fIsActive = true
 
bool fIsSaturated = false
 
unsigned int fNoiseThreshold = 0
 
unsigned int fParity = 0
 
utl::ShadowPtr< ChannelRecDatafRecData
 
double fScintHighVoltage = 0
 
unsigned int fSignalThreshold = 0
 
int fStationId = 0
 

Friends

class revt::Station
 

Detailed Description

Class that holds the data associated to an individual radio channel.

Definition at line 27 of file REvent/Channel.h.

Constructor & Destructor Documentation

revt::Channel::Channel ( const int  stationId,
const int  id 
)
inlineprivate

Definition at line 104 of file REvent/Channel.h.

Member Function Documentation

ChannelADCTimeSeries& revt::Channel::GetChannelADCTimeSeries ( )
inline
const ChannelADCTimeSeries& revt::Channel::GetChannelADCTimeSeries ( ) const
inline

Get const Channel ADC trace (read only)

Definition at line 70 of file REvent/Channel.h.

References fChannelADCTrace.

ChannelFrequencySpectrum& revt::Channel::GetChannelFrequencySpectrum ( )
inline
const ChannelFrequencySpectrum& revt::Channel::GetChannelFrequencySpectrum ( ) const
inline

retrieve Channel Frequency Spectrum (read access)

Definition at line 60 of file REvent/Channel.h.

References fFFTDataContainer.

ChannelTimeSeries& revt::Channel::GetChannelTimeSeries ( )
inline
const ChannelTimeSeries& revt::Channel::GetChannelTimeSeries ( ) const
inline

retrieve Channel Time Series (read access)

Definition at line 55 of file REvent/Channel.h.

References fFFTDataContainer.

ChannelFFTDataContainer& revt::Channel::GetFFTDataContainer ( )
inline
const ChannelFFTDataContainer& revt::Channel::GetFFTDataContainer ( ) const
inline

retrieve Channel FFTDataContainer (read access)

Definition at line 65 of file REvent/Channel.h.

References fFFTDataContainer.

double revt::Channel::GetFrequencyOfBin ( const ChannelFrequencySpectrum::SizeType  bin) const
inline
int revt::Channel::GetId ( ) const
inline

Return Id of the Channel.

Definition at line 31 of file REvent/Channel.h.

References fId.

Referenced by RdStationNoiseAnalyser::ConvertChannelToStation(), RdChannelBandstopFilter::RdChannelBandstopFilter::CutNoiseFrequencies(), rdet::Station::GetChannel(), io::revtChannel_ROOT::operator>>(), io::RadioFileAERAroot::Read(), RdAntennaChannelToStationConverter::RdAntennaChannelToStationConverter::Run(), RdScintSignalReconstructor::RdScintSignalReconstructor::Run(), RdChannelBeaconSuppressor::RdChannelBeaconSuppressor::Run(), RdChannelBeaconSimulator::RdChannelBeaconSimulator::Run(), RdDummyStationToChannelConverter::RdDummyStationToChannelConverter::Run(), RdDummyChannelToStationConverter::RdDummyChannelToStationConverter::Run(), RdChannelSpectrumAverager::RdChannelSpectrumAverager::Run(), RdChannelBeaconTimingCalibrator::RdChannelBeaconTimingCalibrator::Run(), RdChannelNoiseASCIIExporter::RdChannelNoiseASCIIExporter::Run(), RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::Run(), RdChannelAmplitudeCalibrator::RdChannelAmplitudeCalibrator::Run(), CalcBeaconRefPhase::CalcBeaconRefPhase::Run(), RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::Run(), RdChannelNoiseImporter_AERA::RdChannelNoiseImporter_AERA::Run(), RdGalacticDatasetMaker::RdGalacticDatasetMaker::Run(), RdStationSignalReconstructor::RdStationSignalReconstructor::Run(), RdChannelBeaconSignalExtractor::RdChannelBeaconSignalExtractor::Run(), RdChannelNoiseGenerator::RdChannelNoiseGenerator::Run(), RdStationSignalReconstructorWithBgSubtraction::RdStationSignalReconstructorWithBgSubtraction::Run(), and RdTimeCalibration::RdTimeCalibration::Run().

double revt::Channel::GetMaximumFrequency ( ) const
inline

Get the maximum frequency of the spectrum frequency spectrum.

Definition at line 49 of file REvent/Channel.h.

References fFFTDataContainer, GetFrequencyOfBin(), and max.

double revt::Channel::GetMinimumFrequency ( ) const
inline

Get the mimimum frequency of the spectrum frequency spectrum.

Definition at line 45 of file REvent/Channel.h.

References fFFTDataContainer, and GetFrequencyOfBin().

unsigned int revt::Channel::GetNoiseThreshold ( ) const
inline

From DAQ.

Definition at line 84 of file REvent/Channel.h.

References fNoiseThreshold.

unsigned int revt::Channel::GetNyquistZone ( ) const
inline
unsigned int revt::Channel::GetParity ( ) const
inline

Get parity of the Channel.

Definition at line 99 of file REvent/Channel.h.

References fParity.

ChannelRecData& revt::Channel::GetRecData ( )
inline
const ChannelRecData& revt::Channel::GetRecData ( ) const
inline

Definition at line 91 of file REvent/Channel.h.

References fRecData.

double revt::Channel::GetScintHighVoltage ( ) const
inline

Definition at line 87 of file REvent/Channel.h.

References fScintHighVoltage.

unsigned int revt::Channel::GetSignalThreshold ( ) const
inline

From DAQ.

Definition at line 83 of file REvent/Channel.h.

References fSignalThreshold.

int revt::Channel::GetStationId ( ) const
inline
bool revt::Channel::HasRecData ( ) const
inline

Check whether channel reconstructed data exists.

Definition at line 96 of file REvent/Channel.h.

References fRecData.

Referenced by RdScintSignalReconstructor::RdScintSignalReconstructor::Run(), and RdChannelRiseTimeCalculator::RdChannelRiseTimeCalculator::Run().

bool revt::Channel::IsActive ( ) const
inline
bool revt::Channel::IsSaturated ( ) const
inline

Definition at line 74 of file REvent/Channel.h.

References fIsSaturated.

void Channel::MakeRecData ( )
void revt::Channel::SetActive ( )
inline

Active means that it is used in reconstruction. By default this is true after read-in, but can be deactivated later.

Definition at line 77 of file REvent/Channel.h.

References fIsActive.

Referenced by io::revtChannel_ROOT::operator>>(), io::RadioFileAERA::Read(), io::IoAugerEventFile::Read(), and io::RadioFileAERAroot::Read().

void revt::Channel::SetNoiseThreshold ( const unsigned int  thresh)
inline
void revt::Channel::SetNotActive ( )
inline
void revt::Channel::SetNotSaturated ( )
inline

Definition at line 73 of file REvent/Channel.h.

References fIsSaturated.

Referenced by io::revtChannel_ROOT::operator>>().

void revt::Channel::SetNyquistZone ( const unsigned int  zone)
inline
void revt::Channel::SetParity ( const unsigned int  parity)
inline

Set parity of the Channel.

Definition at line 101 of file REvent/Channel.h.

References fParity.

Referenced by io::revtChannel_ROOT::operator>>().

void revt::Channel::SetSaturated ( )
inline

Definition at line 72 of file REvent/Channel.h.

References fIsSaturated.

Referenced by io::revtChannel_ROOT::operator>>().

void revt::Channel::SetScintHighVoltage ( const double  scinthv)
inline

From DAQ.

Definition at line 86 of file REvent/Channel.h.

References fScintHighVoltage.

Referenced by io::revtChannel_ROOT::operator>>(), and io::RadioFileAERAroot::Read().

void revt::Channel::SetSignalThreshold ( const unsigned int  thresh)
inline

Friends And Related Function Documentation

friend class revt::Station
friend

Definition at line 118 of file REvent/Channel.h.

Member Data Documentation

ChannelADCTimeSeries revt::Channel::fChannelADCTrace
private

Definition at line 113 of file REvent/Channel.h.

Referenced by GetChannelADCTimeSeries().

ChannelFFTDataContainer revt::Channel::fFFTDataContainer
private
int revt::Channel::fId = 0
private

Definition at line 107 of file REvent/Channel.h.

Referenced by GetId().

bool revt::Channel::fIsActive = true
private

Definition at line 109 of file REvent/Channel.h.

Referenced by IsActive(), SetActive(), and SetNotActive().

bool revt::Channel::fIsSaturated = false
private

Definition at line 108 of file REvent/Channel.h.

Referenced by IsSaturated(), SetNotSaturated(), and SetSaturated().

unsigned int revt::Channel::fNoiseThreshold = 0
private

Definition at line 111 of file REvent/Channel.h.

Referenced by GetNoiseThreshold(), and SetNoiseThreshold().

unsigned int revt::Channel::fParity = 0
private

Definition at line 114 of file REvent/Channel.h.

Referenced by GetParity(), and SetParity().

utl::ShadowPtr<ChannelRecData> revt::Channel::fRecData
private

Definition at line 115 of file REvent/Channel.h.

Referenced by GetRecData(), HasRecData(), and MakeRecData().

double revt::Channel::fScintHighVoltage = 0
private

Definition at line 112 of file REvent/Channel.h.

Referenced by GetScintHighVoltage(), and SetScintHighVoltage().

unsigned int revt::Channel::fSignalThreshold = 0
private

Definition at line 110 of file REvent/Channel.h.

Referenced by GetSignalThreshold(), and SetSignalThreshold().

int revt::Channel::fStationId = 0
private

Definition at line 106 of file REvent/Channel.h.

Referenced by GetStationId().


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

, generated on Tue Sep 26 2023.