/usr/include/casacore/measures/TableMeasures/ArrayMeasColumn.h is in casacore-dev 2.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 | //# ArrayMeasColumn.h: Access to array Measure columns in Tables.
//# Copyright (C) 1997,1998,1999,2000
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//# $Id$
#ifndef MEASURES_ARRAYMEASCOLUMN_H
#define MEASURES_ARRAYMEASCOLUMN_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/measures/TableMeasures/TableMeasColumn.h>
#include <casacore/measures/Measures/MeasRef.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
template <class T> class ArrayColumn;
template <class T> class ScalarColumn;
template <class T> class Array;
template <class M> class ScalarMeasColumn;
// <summary>
// Read only access to table array Measure columns.
// </summary>
// <use visibility=export>
// <reviewed reviewer="Bob Garwood" date="1999/12/23" tests="tTableMeasures.cc">
// </reviewed>
// <prerequisite>
// <li> <linkto module=Measures>Measures</linkto>
// <li> <linkto module=Tables>Tables</linkto>
// <li> TableMeasDesc
// </prerequisite>
// <synopsis>
// ArrayMeasColumn objects can be used to access array Measure Columns
// in tables, both for reading and writing (if the table is writable).
//
// Before a column can be accessed it must have previously been defined as
// a Measure column by use of the
// <linkto class="TableMeasDesc">TableMeasDesc</linkto> object.
//
// The ArrayMeasColumn class is templated on Measure type and MeasValue
// type but typedefs exist for making declaration less long winded. The
// Measure classes (like MEpoch) have typedefs <src>ArrayColumn</src>
// to assist in creating ArrayMeasColumn objects.
//
// Constructing array Measure column objects using these typedefs looks like
// this:
// <srcblock>
// // Read/write MEpoch array column
// MEpoch::ArrayColumn ec(table, "ColumnName);
// </srcblock>
//
// <h3>Reading and writing Measures</h3>
//
// The reading and writing of Measures columns is very similar to reading and
// writing of "ordinary" Table columns.
// <linkto class="ArrayMeasColumn#get">get()</linkto>
// and <linkto class="ArrayMeasColumn#get">operator()</linkto>
// exist for reading Measures and the
// <linkto class="ArrayMeasColumn#put">put()</linkto> member for adding
// Measures to a column. (put() is obviously not defined for
// ScalarMeasColumn objects.) Each of these members accepts a row number
// as an argument.
//
// Care needs to be taken when adding Measures to a column. The user needs
// to be aware that Measures are not checked for consistency, with respect to
// a Measure's reference, between the Measures being added to a column and
// the column's predefined Measure reference. This is only an issue if the
// Measure column was defined to have a fixed reference. For such columns
// the reference component of Measures added to a column is silently
// ignored, that is, there is no warning nor is there any sort of conversion
// to the column's reference should the reference of the added Measure be
// different from the column's reference. The functions
// <linkto class="TableMeasDescBase#isRefCodeVariable()">
// TableMeasDescBase::isRefVariable()</linkto>
// and
// <linkto class="ArrayMeasColumn#getMeasRef()">
// ArrayMeasColumn::getMeasRef()</linkto> can be
// used to discover a Measure column's Measure reference characteristics.
// </synopsis>
// <example>
// <srcblock>
// // create an MEpoch array column object
// ArrayMeasColumn<MEpoch> arrayCol;
//
// // should be null. Can test this and attach a real MEpoch column
// // The column Time1Arr should exist in the table and would have been
// // defined by using a TableMeasDesc
// if (arrayCol.isNull()) {
// arrayCol.attach(tab, "Time1Arr");
// }
//
// // This would throw an Exception if the object is still null....but
// // hopefully won't
// arrayCol.throwIfNull();
//
// // create a vector of MEpochs
// MEpoch last(Quantity(13.45, "h"), MEpoch::Ref(MEpoch::TAI));
// Vector<MEpoch> ev(10);
// for (uInt i=0; i<10; i++) {
// last.set(Quantity(13.45 + i, "h"));
// ev(i) = last;
// }
//
// // before adding something check the isDefined() member
// if (!arrayCol.isDefined(0)) {
// cout << "PASS - nothing in the measure array column row yet\n";
// } else {
// cout << "FAIL - there shouldn't be a valid value in the row!\n";
// }
//
// // add the MEpoch vector to the array Measure column at row 0
// arrayCol.put(0, ev);
//
// // now read the array from the row. Could use same object to do this
// // but here we'll create a ArrayMeasColumn<MEpoch> to do this
// ArrayMeasColumn<MEpoch> roArrCol(tab, "Time1Arr");
//
// // need a vector to put the MEpochs into
// Vector<MEpoch> ew;
//
// // setting the resize parameter to True automatically sets ew to the
// // same shape as the array contained in the row
// arrayCol.get(0, ew, True);
// </srcblock>
// </example>
// <motivation>
// The standard Casacore Table system does not support array Measure columns.
// This class overcomes this limitation.
// </motivation>
// <thrown>
// <li>ArrayConformanceError during get() if supplied array is the wrong
// shape.
// </thrown>
//# <todo asof="$DATE:$">
//# A List of bugs, limitations, extensions or planned refinements.
//# </todo>
template<class M> class ArrayMeasColumn : public TableMeasColumn
{
public:
// The default constructor creates a null object. Useful for creating
// arrays of ArrayMeasColumn objects. Attempting to use a null object
// will produce a segmentation fault so care needs to be taken to
// initialise the objects by using the attach() member before any attempt
// is made to use the object. A ArrayMeasColumn object can be tested
// if it is null by using the isNull() member.
ArrayMeasColumn();
// Create the ArrayMeasColumn from the table and column Name.
ArrayMeasColumn (const Table& tab, const String& columnName);
// Copy constructor (copy semantics).
ArrayMeasColumn (const ArrayMeasColumn<M>& that);
virtual ~ArrayMeasColumn();
// Change the reference to another column.
void reference (const ArrayMeasColumn<M>& that);
// Attach a column to the object.
void attach (const Table& tab, const String& columnName);
// Get the Measure array in the specified row. For get() the supplied
// array's shape should match the shape in the row unless resize is True.
// <group name=get>
void get (uInt rownr, Array<M>& meas, Bool resize = False) const;
Array<M> operator() (uInt rownr) const;
// </group>
// Get the Measure array contained in the specified row and convert
// it to the reference and offset found in the given measure.
Array<M> convert (uInt rownr, const M& meas) const
{ return convert (rownr, meas.getRef()); }
// Get the Measure array contained in the specified row and convert
// it to the given reference.
// <group>
Array<M> convert (uInt rownr, const MeasRef<M>& measRef) const;
Array<M> convert (uInt rownr, uInt refCode) const;
// </group>
// Get the column's reference.
const MeasRef<M>& getMeasRef() const
{ return itsMeasRef; }
// Reset the refCode, offset, or units.
// It overwrites the value used when defining the TableMeasDesc.
// Resetting the refCode and offset can only be done if they were
// defined as fixed in the description.
// <note role=tip>
// In principle the functions can only be used if the table is empty,
// otherwise already written values have thereafter the incorrect
// reference, offset, or unit.
// However, it is possible that part of the table is already
// written and that the entire measure column is filled in later.
// In that case the reference, offset, or units can be set by using
// a False <src>tableMustBeEmpty</src> argument.
// </note>
// <group>
void setDescRefCode (uInt refCode, Bool tableMustBeEmpty=True);
void setDescOffset (const Measure& offset, Bool tableMustBeEmpty=True);
void setDescUnits (const Vector<Unit>& units, Bool tableMustBeEmpty=True);
// </group>
// Add a Measure array to the specified row.
// <group name=put>
void put (uInt rownr, const Array<M>&);
// </group>
protected:
//# Its measure reference when the MeasRef is constant per row.
MeasRef<M> itsMeasRef;
private:
//# Column which contains the Measure's actual data.
ArrayColumn<Double>* itsDataCol;
//# Its MeasRef code column when references are variable.
ScalarColumn<Int>* itsRefIntCol;
ArrayColumn<Int>* itsArrRefIntCol;
//# Its MeasRef column when references are variable and stored as Strings.
ScalarColumn<String>* itsRefStrCol;
ArrayColumn<String>* itsArrRefStrCol;
//# Column containing its variable offsets. Only applicable if the
//# measure references have offsets and they are variable.
ScalarMeasColumn<M>* itsOffsetCol;
ArrayMeasColumn<M>* itsArrOffsetCol;
// Assignment makes no sense in a read only class.
// Declaring this operator private makes it unusable.
ArrayMeasColumn& operator= (const ArrayMeasColumn<M>& that);
// Deletes allocated memory etc. Called by ~tor and any member which needs
// to reallocate data.
void cleanUp();
// Get the data and convert using conversion engine.
Array<M> doConvert (uInt rownr, typename M::Convert& conv) const;
};
} //# NAMESPACE CASACORE - END
//# Make old name ROArrayMeasColumn still available.
#define ROArrayMeasColumn ArrayMeasColumn
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/measures/TableMeasures/ArrayMeasColumn.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|