Main Page | Class List | File List | Class Members | File Members | Related Pages

CSCCluster Class Reference

The CSCCluster class represents data of a continuous group of channels in the chamber. More...

#include <CSCCluster.h>

List of all members.

Public Member Functions

 CSCCluster (unsigned int word1=0, unsigned int word2=0, int numSample=0)
 This constructor is used only in the CSCChamber() class.
 ~CSCCluster ()
 Destructor.
int GetStartChannel ()
int GetWidth ()
CSCStripGetStrip (int i)
 Provides acces to the data of this cluster.
int GetMaxIndex ()
 This function should no longer be used.
double GetMaxAmp ()
 This function should no longer be used.
double GetTotalCharge ()
 This function should no longer be used.
int GetLayer ()
int IsTransverse ()
int GetPhi ()
int IsLargeChamber ()
double GetPosition ()
 This function should no longer be used.
short int GetSample (int strip, int sam)
 Provides access to the ADC samples.
void Read (unsigned int *buf)
 This function is called only by CSCChamber() to read in raw data.
double GetPeakingTime ()
 This function should no longer be used.
void Print ()
 Print some data to the screen.


Detailed Description

The CSCCluster class represents data of a continuous group of channels in the chamber.

If sparsification was used, the ROD created this group because channels were above threshold. The group has a start channel and a width. Without sparsification, the cluster begins at channel 0 and contains all channels in the layer.

Internally, the data is stored as an array of CSCStrip() objects, beginning with an index of 0 for the leftmost strip. To get the physical channel number, add GetStartChannel() to the index.

To access the data of one strip, first find out how many stips are stored in this cluster by calling GetWidth() and then obtain a pointer to a trip object with GetStrip(). For ADC samples, use the GetSample() function as a shortcut.

The cluster stores the channelID of the strip with the largest amplitude. This ID is used for the layer, endcap and direction information.

Status:
95% complete and well tested.


Member Function Documentation

int CSCCluster::GetLayer  )  [inline]
 

Returns:
the layer number 0-3 of this cluster.

double CSCCluster::GetMaxAmp  )  [inline]
 

This function should no longer be used.

Use the CSCHit() objects if you are dealing with hits. Clusters can contain more than 1 hit, or none at all.

Returns:
the amplitude of the strip with the largest ampliude.

int CSCCluster::GetMaxIndex  )  [inline]
 

This function should no longer be used.

Use the CSCHit() objects if you are dealing with hits. Clusters can contain more than 1 hit, or none at all.

Returns:
the strip number (between 0 and GetWidth()) of the strip with the largest ampliude.

double CSCCluster::GetPeakingTime  ) 
 

This function should no longer be used.

Use the CSCHit() objects if you are dealing with hits. Clusters can contain more than 1 hit, or none at all.

Returns:
the interpolated peaking time of the strip with the largest amplitude.

int CSCCluster::GetPhi  )  [inline]
 

Returns:
the 0-based phi number

double CSCCluster::GetPosition  )  [inline]
 

This function should no longer be used.

Use the CSCHit() objects if you are dealing with hits. Clusters can contain more than 1 hit, or none at all.

Returns:
the interpolated position of the largest hit.

short int CSCCluster::GetSample int  strip,
int  sam
 

Provides access to the ADC samples.

Parameters:
strip is the index of the strip in the cluster, ranging from 0 to GetWidth()-1.
sam is the sample number from 0 to CSCEvent()->GetNumSample().
Returns:
the ADC value or -9999 if strip or sam is out of range.

int CSCCluster::GetStartChannel  )  [inline]
 

Returns:
the 0-based channel number of the first channel in this cluster.

CSCStrip * CSCCluster::GetStrip int  i  ) 
 

Provides acces to the data of this cluster.

Parameters:
i is the strip number, ranging from 0 to GetWidth()-1.
Returns:
the CSCStrip() object containing the data for this channel, or NULL if i is out of range.

double CSCCluster::GetTotalCharge  )  [inline]
 

This function should no longer be used.

Use the CSCHit() objects if you are dealing with hits. Clusters can contain more than 1 hit, or none at all.

Returns:
the sum of all strip amplitudes in this cluster.

int CSCCluster::GetWidth  )  [inline]
 

Returns:
the number of channels in this cluster.

int CSCCluster::IsLargeChamber  )  [inline]
 

Returns:
0 if this is a small CSC chamber, or 1 if it is a large one.

int CSCCluster::IsTransverse  )  [inline]
 

Returns:
0 if this is an X layer, or 1 if it is a Y layer.

void CSCCluster::Print  ) 
 

Print some data to the screen.

Used for debugging.


The documentation for this class was generated from the following files:
Generated on Wed Oct 29 10:35:18 2008 for CSCRead by  doxygen 1.3.9.1