casacore
SDSpWinHandler.h
Go to the documentation of this file.
1 //# SDSpWindowFiller.h: fills the SPECTRAL_WINDOW table for the SDFITS filler
2 //# Copyright (C) 2000,2001,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 addressed 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 MS_SDSPWINHANDLER_H
30 #define MS_SDSPWINHANDLER_H
31 
32 #include <casacore/casa/aips.h>
33 #include <casacore/casa/Arrays/Vector.h>
34 #include <casacore/casa/Containers/RecordField.h>
35 #include <casacore/tables/Tables/TableColumn.h>
36 
37 namespace casacore { //# NAMESPACE CASACORE - BEGIN
38 
39 //# Forward Declarations
40 class ColumnsIndex;
41 class MeasurementSet;
42 class MSSpectralWindow;
43 class MSSpWindowColumns;
44 class Record;
45 class Table;
46 
47 // <summary>
48 // </summary>
49 
50 // <use visibility=local> or <use visibility=export>
51 
52 // <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
53 // </reviewed>
54 
55 // <prerequisite>
56 // <li> SomeClass
57 // <li> SomeOtherClass
58 // <li> some concept
59 // </prerequisite>
60 //
61 // <etymology>
62 // </etymology>
63 //
64 // <synopsis>
65 // </synopsis>
66 //
67 // <example>
68 // </example>
69 //
70 // <motivation>
71 // </motivation>
72 //
73 // <templating arg=T>
74 // <li>
75 // <li>
76 // </templating>
77 //
78 // <thrown>
79 // <li>
80 // <li>
81 // </thrown>
82 //
83 // <todo asof="yyyy/mm/dd">
84 // <li> add this feature
85 // <li> fix this bug
86 // <li> start discussion of this possible extension
87 // </todo>
88 
90 {
91 public:
92  // default ctor is not attached to a MS and hence is useless until attached
94 
95  // attach this to a MS, marking fields in row which are explicitly handled here
96  SDSpWindowHandler(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
97 
98  // copy ctor
100 
102 
103  // assignment operator, uses copy semantics
105 
106  // attach to a MS, the handledCols and row arguments are ignored here
107  void attach(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
108 
109  // reset internals given indicated row, use the same MS; just resets the id pointer
110  void resetRow(const Record &);
111 
112  // fill - a circular buffer of last 100 spectral windows is checked
113  void fill(const Record &row, const Vector<Double> &frequency, Double refFrequency,
114  Double originalFreqDelt, Int freqRefType);
115 
116  // get the current spWindow ID
117  Int spWindowId() {return rownr_p;}
118 private:
125  // the cache table is the one that is indexed
127  // temporary table to hold the fields we are indexing on, can't index on array column
131 
132  // the columns in the cache table
136 
137  // the next row number to use in the cached
139 
140  // the maximum number of rows in the cache - currently this is 1000
142 
143  // the current row number in the SPECTRAL_WINDOW table, i.e. the id
145 
146  // fields possibly mined from the SDFITS row
147  // floating point fields that we can't be certain of their type
149 
150  // fields from a previous life as a MS
154 
155  // cleanup everything
156  void clearAll();
157 
158  // clean up items related to the row
159  void clearRow();
160 
161  // initialize everything
162  void initAll(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
163 
164  // initialize the stuff dependent on the row
165  void initRow(Vector<Bool> &handledCols, const Record &row);
166 };
167 
168 
169 } //# NAMESPACE CASACORE - END
170 
171 #endif
172 
173 
RecordFieldPtr< Bool > flagRowKey_p
MSSpWindowColumns * msSpWinCols_p
Table * theCache_p
temporary table to hold the fields we are indexing on, can't index on array column
RecordFieldPtr< Int > netSidebandKey_p
void initAll(MeasurementSet &ms, Vector< Bool > &handledCols, const Record &row)
initialize everything
RecordFieldPtr< Int > nchanKey_p
RecordFieldPtr< Int > ifConvChainKey_p
void clearAll()
cleanup everything
SDSpWindowHandler()
default ctor is not attached to a MS and hence is useless until attached
RORecordFieldPtr< Int > ifConvChainField_p
SDSpWindowHandler(const SDSpWindowHandler &other)
copy ctor
void initRow(Vector< Bool > &handledCols, const Record &row)
initialize the stuff dependent on the row
RORecordFieldPtr< Int > spWinIdField_p
fields from a previous life as a MS
void resetRow(const Record &)
reset internals given indicated row, use the same MS; just resets the id pointer
uInt nextCacheRow_p
the next row number to use in the cached
void attach(MeasurementSet &ms, Vector< Bool > &handledCols, const Record &row)
attach to a MS, the handledCols and row arguments are ignored here
MSSpectralWindow * msSpWin_p
void clearRow()
clean up items related to the row
RecordFieldPtr< Int > freqRefTypeKey_p
RecordFieldPtr< Int > freqGroupKey_p
TableColumn idCol_p
the columns in the cache table
RORecordFieldPtr< Int > netSidebandField_p
ColumnsIndex * index_p
the cache table is the one that is indexed
RORecordFieldPtr< Bool > flagRowField_p
Int spWindowId()
get the current spWindow ID
void fill(const Record &row, const Vector< Double > &frequency, Double refFrequency, Double originalFreqDelt, Int freqRefType)
fill - a circular buffer of last 100 spectral windows is checked
RORecordFieldPtr< Int > freqGroupField_p
uInt cacheSize_p
the maximum number of rows in the cache - currently this is 1000
SDSpWindowHandler & operator=(const SDSpWindowHandler &other)
assignment operator, uses copy semantics
SDSpWindowHandler(MeasurementSet &ms, Vector< Bool > &handledCols, const Record &row)
attach this to a MS, marking fields in row which are explicitly handled here
Int rownr_p
the current row number in the SPECTRAL_WINDOW table, i.e.
Int bandwidField_p
fields possibly mined from the SDFITS row floating point fields that we can't be certain of their typ...
this file contains all the compiler specific defines
Definition: mainpage.dox:28
unsigned int uInt
Definition: aipstype.h:51
int Int
Definition: aipstype.h:50
bool Bool
Define the standard types used by Casacore.
Definition: aipstype.h:42
double Double
Definition: aipstype.h:55