GBTSampler Class Reference

#include <GBTSampler.h>

List of all members.


Detailed Description

Intended use:

Internal

Review Status

Date Reviewed:
yyyy/mm/dd
Test programs:
tGBTSampler

Prerequisite

Etymology

This holds information typically found in the SAMPLER table of the GBT backend FITS files.

Motivation

It is useful to provide a common interface to access the information in the sampler table. In addition, since only the GBT ACS follows the full convention and provides a complete sampler table, it is useful to make the other backends appear as if they had this table so that downstream code need not know about the differences.

Definition at line 70 of file GBTSampler.h.

Public Member Functions

 GBTSampler (const GBTBackendTable &backendTab, Int nIFrows)
 construct from an existing GBTBackendTable and possibly using the number of IF rows (SP backend only)
 GBTSampler (const GBTSampler &other)
 Copy-constructor, uses copy semantics.
 ~GBTSampler ()
GBTSampleroperator= (const GBTSampler &other)
 Assignment operator, uses copy semantics.
uInt nrows () const
 The number of rows (samplers) present.
const String & bankA (uInt whichRow) const
 BANK_A for a given row.
const String & bankB (uInt whichRow) const
 BANK_B for a given row.
Int portA (uInt whichRow) const
 PORT_A for a given row.
Int portB (uInt whichRow) const
 PORT_B for a given row.
Bool hasCross () const
 Does this SAMPLER have any cross-polarization data.
uInt nchan (uInt whichRow) const
 Return the number of channels for this row of the sampler table.

Private Member Functions

 GBTSampler ()

Private Attributes

Vector< String > itsBankA
Vector< String > itsBankB
Vector< Int > itsPortA
Vector< Int > itsPortB
Vector< Int > itsNchan
Bool itsHasCross


Constructor & Destructor Documentation

GBTSampler::GBTSampler ( const GBTBackendTable backendTab,
Int  nIFrows 
)

construct from an existing GBTBackendTable and possibly using the number of IF rows (SP backend only)

GBTSampler::GBTSampler ( const GBTSampler other  ) 

Copy-constructor, uses copy semantics.

GBTSampler::~GBTSampler (  )  [inline]

Definition at line 80 of file GBTSampler.h.

GBTSampler::GBTSampler (  )  [private]


Member Function Documentation

GBTSampler& GBTSampler::operator= ( const GBTSampler other  ) 

Assignment operator, uses copy semantics.

uInt GBTSampler::nrows (  )  const [inline]

The number of rows (samplers) present.

Definition at line 86 of file GBTSampler.h.

References itsBankA.

const String& GBTSampler::bankA ( uInt  whichRow  )  const [inline]

BANK_A for a given row.

For ACS, returns value in BANK_A column SP receiver row is now correctly translated to BANK_A values for Sqr/Cross mode and Square modes. For the DCR, returns value of INPBANK keyword.

Definition at line 93 of file GBTSampler.h.

References itsBankA.

const String& GBTSampler::bankB ( uInt  whichRow  )  const [inline]

BANK_B for a given row.

For ACS, returns value in BANK_B column. SP receiver row is now correctly translated to BANK_B values for Sqr/Cross mode and Square modes. For DCR bankB==bankA.

Definition at line 100 of file GBTSampler.h.

References itsBankB.

Int GBTSampler::portA ( uInt  whichRow  )  const [inline]

PORT_A for a given row.

For ACS, returns value in PORT_A column. SP receiver row is now correctly translated to PORT_A values for Sqr/Cross mode and Square modes. For DCR, this is the value of CHANNELID + 1.

Definition at line 107 of file GBTSampler.h.

References itsPortA.

Int GBTSampler::portB ( uInt  whichRow  )  const [inline]

PORT_B for a given row.

For ACS, returns value in PORT_B column. SP receiver row is now correctly translated to PORT_B values for Sqr/Cross mode and Square modes. For DCR portB==portA.

Definition at line 114 of file GBTSampler.h.

References itsPortB.

Bool GBTSampler::hasCross (  )  const [inline]

Does this SAMPLER have any cross-polarization data.

For ACS, this returns True if POLARIZE=="CROSS" For SpectralProcessor this returns true in SquareCross mode. For DCR data this always returns False.

Definition at line 120 of file GBTSampler.h.

References itsHasCross.

uInt GBTSampler::nchan ( uInt  whichRow  )  const [inline]

Return the number of channels for this row of the sampler table.

Definition at line 123 of file GBTSampler.h.

References itsNchan.


Member Data Documentation

Vector<String> GBTSampler::itsBankA [private]

Definition at line 126 of file GBTSampler.h.

Referenced by bankA(), and nrows().

Vector<String> GBTSampler::itsBankB [private]

Definition at line 126 of file GBTSampler.h.

Referenced by bankB().

Vector<Int> GBTSampler::itsPortA [private]

Definition at line 127 of file GBTSampler.h.

Referenced by portA().

Vector<Int> GBTSampler::itsPortB [private]

Definition at line 127 of file GBTSampler.h.

Referenced by portB().

Vector<Int> GBTSampler::itsNchan [private]

Definition at line 127 of file GBTSampler.h.

Referenced by nchan().

Bool GBTSampler::itsHasCross [private]

Definition at line 128 of file GBTSampler.h.

Referenced by hasCross().


The documentation for this class was generated from the following file:
Generated on Thu Aug 27 21:22:10 2009 for NRAOCASA by  doxygen 1.5.1