casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
CalTableDesc.h
Go to the documentation of this file.
1 //# CalTableDesc.h: Define the format of calibration tables
2 //# Copyright (C) 1996,1997,1998,2002
3 //# Associated Universities, Inc. Washington DC, USA.
4 //#
5 //# This library is free software; you can redistribute it and/or modify it
6 //# under the terms of the GNU Library General Public License as published by
7 //# the Free Software Foundation; either version 2 of the License, or (at your
8 //# option) any later version.
9 //#
10 //# This library is distributed in the hope that it will be useful, but WITHOUT
11 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 //# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13 //# License for more details.
14 //#
15 //# You should have received a copy of the GNU Library General Public License
16 //# along with this library; if not, write to the Free Software Foundation,
17 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
18 //#
19 //# Correspondence concerning AIPS++ should be adressed as follows:
20 //# Internet email: aips2-request@nrao.edu.
21 //# Postal address: AIPS++ Project Office
22 //# National Radio Astronomy Observatory
23 //# 520 Edgemont Road
24 //# Charlottesville, VA 22903-2475 USA
25 //#
26 //#
27 //# $Id$
28 
29 #ifndef CALIBRATION_CALTABLEDESC_H
30 #define CALIBRATION_CALTABLEDESC_H
31 
32 #include <casa/aips.h>
33 #include <tables/Tables/Table.h>
35 
36 namespace casa { //# NAMESPACE CASA - BEGIN
37 
38 // <summary>
39 // CalTableDesc: Define the format of calibration tables
40 // </summary>
41 
42 // <use visibility=export>
43 
44 // <reviewed reviewer="" date="" tests="" demos="">
45 
46 // <prerequisite>
47 // <li> <linkto class="CalTable">CalTable</linkto> module
48 // </prerequisite>
49 //
50 // <etymology>
51 // From "Calibration table" and "descriptor".
52 // </etymology>
53 //
54 // <synopsis>
55 // CalTableDesc defines the format of calibration tables in terms
56 // of table descriptors <linkto class="casacore::TableDesc">casacore::TableDesc</linkto>, as
57 // defined in the casacore::Table system. This is a base class and defines the
58 // overall calibration table structure. Specializations for both
59 // antenna-based (ViJones and SkyJones) and baseline-based (MJones)
60 // calibration tables are provided through inheritance. At present this
61 // set of classes returns the default calibration table descriptors for a
62 // given calibration table type.
63 // </etymology>
64 //
65 // <example>
66 // <srcblock>
67 // </srcblock>
68 // </example>
69 //
70 // <motivation>
71 // This inheritance tree defines the format of all calibration
72 // table types, both antenna- and baseline-based, to provide
73 // a unified and consistent interface to their representation
74 // as aips++ tables. An overall structure common to all calibration
75 // tables is maintained as far as possible, with common column
76 // names throughout. This class tree is primarily used by
77 // the <linkto class="CalTable"> CalTable</linkto> classes.
78 // </motivation>
79 //
80 // <todo asof="98/01/01">
81 // Generate the calibration table descriptors from a VisSet or VisBuffer object
82 // </todo>
83 
85 {
86  public:
87  // Default null constructor, and destructor
88  CalTableDesc();
89  virtual ~CalTableDesc() {};
90 
91  // Construct from the Jones table type
93 
94  // Return the table descriptors for the main calibration table
95  // and the cal_history and cal_desc sub-tables
99 
100  protected:
101  // Generate the default table descriptor for fit parameters
103 
104  // Generate the default table descriptor for general polynomial parameters
106 
107  // Generate the default table descriptor for spline polynomial parameters
109 
110  // Method to insert one table descriptor into another after
111  // a specified column name.
113  const casacore::String& insertAfter);
114 
115  private:
116  // Generate the default sub-table descriptors
120 
121  // casacore::Table descriptors
125 
126  };
127 
128 
129 } //# NAMESPACE CASA - END
130 
131 #endif
132 
133 
134 
135 
136 
virtual casacore::TableDesc calDescDesc()
virtual Type type()
Return the type enum.
virtual casacore::TableDesc calMainDesc()
Return the table descriptors for the main calibration table and the cal_history and cal_desc sub-tabl...
CalTableDesc: Define the format of calibration tables.
Definition: CalTableDesc.h:84
virtual casacore::TableDesc calHistoryDesc()
casacore::TableDesc defaultPolyDesc()
Generate the default table descriptor for general polynomial parameters.
casacore::TableDesc defaultSplineDesc()
Generate the default table descriptor for spline polynomial parameters.
casacore::TableDesc insertDesc(const casacore::TableDesc &tableDesc, const casacore::TableDesc &insert, const casacore::String &insertAfter)
Method to insert one table descriptor into another after a specified column name. ...
casacore::TableDesc defaultCalHistory()
CalTableDesc()
Default null constructor, and destructor.
casacore::TableDesc itsCalHistoryDesc
Definition: CalTableDesc.h:123
virtual ~CalTableDesc()
Definition: CalTableDesc.h:89
casacore::TableDesc defaultFitDesc()
Generate the default table descriptor for fit parameters.
casacore::TableDesc defaultCalDesc()
casacore::TableDesc defaultCalMain(const casacore::String &type)
Generate the default sub-table descriptors.
casacore::TableDesc itsCalDescDesc
Definition: CalTableDesc.h:124
String: the storage and methods of handling collections of characters.
Definition: String.h:223
Define the structure of a Casacore table.
Definition: TableDesc.h:187
casacore::TableDesc itsCalMainDesc
casacore::Table descriptors
Definition: CalTableDesc.h:122