casacore
SDPolarizationHandler.h
Go to the documentation of this file.
1 //# SDPolarizationFiller.h: fills the POLARIZATION table for the SDFITS filler
2 //# Copyright (C) 2000
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_SDPOLARIZATIONHANDLER_H
30 #define MS_SDPOLARIZATIONHANDLER_H
31 
32 #include <casacore/casa/aips.h>
33 #include <casacore/casa/Containers/RecordField.h>
34 
35 namespace casacore { //# NAMESPACE CASACORE - BEGIN
36 
37 //# Forward Declarations
38 class ColumnsIndex;
39 class MeasurementSet;
40 class MSPolarization;
41 class MSPolarizationColumns;
42 class Record;
43 
44 template <class T> class Vector;
45 
46 // <summary>
47 // </summary>
48 
49 // <use visibility=local> or <use visibility=export>
50 
51 // <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
52 // </reviewed>
53 
54 // <prerequisite>
55 // <li> SomeClass
56 // <li> SomeOtherClass
57 // <li> some concept
58 // </prerequisite>
59 //
60 // <etymology>
61 // </etymology>
62 //
63 // <synopsis>
64 // </synopsis>
65 //
66 // <example>
67 // </example>
68 //
69 // <motivation>
70 // </motivation>
71 //
72 // <templating arg=T>
73 // <li>
74 // <li>
75 // </templating>
76 //
77 // <thrown>
78 // <li>
79 // <li>
80 // </thrown>
81 //
82 // <todo asof="yyyy/mm/dd">
83 // <li> add this feature
84 // <li> fix this bug
85 // <li> start discussion of this possible extension
86 // </todo>
87 
89 {
90 public:
91  // default ctor is not attached to a MS and hence is useless until attached
93 
94  // attach this to a MS - no columns are explicitly handled here
95  SDPolarizationHandler(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
96 
97  // copy ctor
99 
101 
102  // assignment operator, uses copy semantics
104 
105  // attach to a MS, the handledCols and row arguments are ignored here
106  void attach(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
107 
108  // reset internals given indicated row, use the same MS; just resets the id pointer
109  void resetRow(const Record &row);
110 
111  // fill - a new row is added only when necessary
112  void fill(const Record &row, const Vector<Int> &stokes);
113 
114  // get the current polarization ID
116 private:
121 
123 
124  // from a pre-existing MS
128 
129  // decompose a stokes value into constituent parts for use
130  // in making the CORR_PRODUCT matrix
131  void stokesKeys(Int stokesValue, Int &key1, Int &key2);
132 
133  // cleanup everything
134  void clearAll();
135 
136  void clearRow();
137 
138  // initialize everything
139  void initAll(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
140 
141  void initRow(Vector<Bool> &handledCols, const Record &row);
142 };
143 
144 
145 } //# NAMESPACE CASACORE - END
146 
147 #endif
148 
149 
casacore::SDPolarizationHandler::flagRowField_p
RORecordFieldPtr< Bool > flagRowField_p
Definition: SDPolarizationHandler.h:127
casacore::RecordFieldPtr< Int >
casacore::SDPolarizationHandler::msPol_p
MSPolarization * msPol_p
Definition: SDPolarizationHandler.h:119
casacore::SDPolarizationHandler::SDPolarizationHandler
SDPolarizationHandler(MeasurementSet &ms, Vector< Bool > &handledCols, const Record &row)
attach this to a MS - no columns are explicitly handled here
casacore::SDPolarizationHandler::numCorrKey_p
RecordFieldPtr< Int > numCorrKey_p
Definition: SDPolarizationHandler.h:117
casacore::SDPolarizationHandler::operator=
SDPolarizationHandler & operator=(const SDPolarizationHandler &other)
assignment operator, uses copy semantics
casacore::SDPolarizationHandler::corrTypeField_p
RORecordFieldPtr< Array< Int > > corrTypeField_p
Definition: SDPolarizationHandler.h:126
casacore::SDPolarizationHandler::SDPolarizationHandler
SDPolarizationHandler(const SDPolarizationHandler &other)
copy ctor
casacore::SDPolarizationHandler::rownr_p
Int rownr_p
Definition: SDPolarizationHandler.h:122
casacore::SDPolarizationHandler::clearAll
void clearAll()
cleanup everything
casacore::SDPolarizationHandler::SDPolarizationHandler
SDPolarizationHandler()
default ctor is not attached to a MS and hence is useless until attached
casacore::SDPolarizationHandler::initAll
void initAll(MeasurementSet &ms, Vector< Bool > &handledCols, const Record &row)
initialize everything
casacore::SDPolarizationHandler::~SDPolarizationHandler
~SDPolarizationHandler()
Definition: SDPolarizationHandler.h:100
casacore::ColumnsIndex
Definition: ColumnsIndex.h:228
casacore::SDPolarizationHandler::fill
void fill(const Record &row, const Vector< Int > &stokes)
fill - a new row is added only when necessary
casacore::SDPolarizationHandler::clearRow
void clearRow()
casacore::SDPolarizationHandler
Definition: SDPolarizationHandler.h:89
casacore::SDPolarizationHandler::msPolCols_p
MSPolarizationColumns * msPolCols_p
Definition: SDPolarizationHandler.h:120
casacore::SDPolarizationHandler::index_p
ColumnsIndex * index_p
Definition: SDPolarizationHandler.h:118
casacore::SDPolarizationHandler::attach
void attach(MeasurementSet &ms, Vector< Bool > &handledCols, const Record &row)
attach to a MS, the handledCols and row arguments are ignored here
casacore::Int
int Int
Definition: aipstype.h:50
casacore
this file contains all the compiler specific defines
Definition: mainpage.dox:28
casacore::SDPolarizationHandler::initRow
void initRow(Vector< Bool > &handledCols, const Record &row)
casacore::SDPolarizationHandler::resetRow
void resetRow(const Record &row)
reset internals given indicated row, use the same MS; just resets the id pointer
casacore::MeasurementSet
Definition: MeasurementSet.h:243
casacore::RORecordFieldPtr< Int >
casacore::SDPolarizationHandler::numCorrField_p
RORecordFieldPtr< Int > numCorrField_p
from a pre-existing MS
Definition: SDPolarizationHandler.h:125
casacore::Record
Definition: Record.h:181
casacore::Vector< Bool >
casacore::MSPolarization
Definition: MSPolarization.h:80
casacore::MSPolarizationColumns
Definition: MSPolColumns.h:76
casacore::SDPolarizationHandler::corrProductField_p
RORecordFieldPtr< Array< Int > > corrProductField_p
Definition: SDPolarizationHandler.h:126
casacore::SDPolarizationHandler::polarizationId
Int polarizationId()
get the current polarization ID
Definition: SDPolarizationHandler.h:115
casacore::SDPolarizationHandler::stokesKeys
void stokesKeys(Int stokesValue, Int &key1, Int &key2)
decompose a stokes value into constituent parts for use in making the CORR_PRODUCT matrix