/usr/include/casacore/tables/DataMan/ScaledComplexData.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 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 | //# ScaledComplexData.h: Templated virtual column engine to scale a complex table array
//# Copyright (C) 1999,2000,2001
//# 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 TABLES_SCALEDCOMPLEXDATA_H
#define TABLES_SCALEDCOMPLEXDATA_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/tables/DataMan/BaseMappedArrayEngine.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
template<class T> class ScalarColumn;
// <summary>
// Templated virtual column engine to scale a complex table array
// </summary>
// <use visibility=export>
// <reviewed reviewer="Gareth Hunt" date="94Nov17" tests="">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> VirtualColumnEngine
// <li> VirtualArrayColumn
// </prerequisite>
// <synopsis>
// ScaledComplexData is a virtual column engine which scales an array
// of a complex type to 2 values of another type (to save disk storage).
// For example, <src>ScaledComplexData<Complex,Short></src> resembles the
// classic AIPS compress method which scales the data from float to short.
// The (complex) scale factor and offset value can be given in two ways:
// <ul>
// <li> As a fixed value which is used for all arrays in the column.
// <li> As the name of a column. In this way each array in a
// column can have its own scale and offset value.
// The scale and offset value in a row must be put before
// the array is put and should not be changed anymore.
// </ul>
// It is also possible to have a variable scale factor with a fixed offset
// value.
// As in FITS the scale and offset values are used as:
// <br><src> True_value = Stored_value * scale + offset; </src>
//
// An engine object should be used for one column only, because the stored
// column name is part of the engine. If it would be used for more than
// one column, they would all share the same stored column.
// When the engine is bound to a column, it is checked if the name
// of that column matches the given virtual column name.
//
// The engine can be used for a column containing any kind of array
// (thus direct or indirect, fixed or variable shaped)) as long as the
// virtual array can be stored in the stored array. Thus a fixed shaped
// virtual can use a variable shaped stored, but not vice versa.
// A fixed shape indirect virtual can use a stored with direct arrays.
//
// This class can also serve as an example of how to implement
// a virtual column engine.
// </synopsis>
// <motivation>
// This class allows to store data in a smaller representation.
// It is needed to resemble the classic AIPS compress option.
// It adds the scale and offset value on a per row basis.
//
// Because the engine can serve only one column, it was possible to
// combine the engine and the column functionality in one class.
// This has been achieved using multiple inheritance.
// The advantage of this is that only one templated class is used,
// so less template instantiations are needed.
//
// Class ScaledArrayEngine could not be used, because complex integer
// types are not supported in the tabe system.
// </motivation>
// <example>
// <srcblock>
// // Create the table description and 2 columns with indirect arrays in it.
// // The Int column will be stored, while the double will be
// // used as virtual.
// TableDesc tableDesc ("", TableDesc::Scratch);
// tableDesc.addColumn (ArrayColumnDesc<Short> ("storedArray"));
// tableDesc.addColumn (ArrayColumnDesc<Complex> ("virtualArray"));
//
// // Create a new table using the table description.
// SetupNewTable newtab (tableDesc, "tab.data", Table::New);
//
// // Create the array scaling engine to scale from double to Int
// // and bind it to the double column.
// // Create the table.
// ScaledComplexData<Complex,Short> scalingEngine("virtualArray",
// "storedArray", 10);
// newtab.bindColumn ("virtualArray", scalingEngine);
// Table table (newtab);
//
// // Store a 2-D array (with dim. 3,4) into each row of the column.
// // The shape of each array in the column is implicitly set by the put
// // function. This will also set the shape of the underlying Int array
// // (as a 3-D array with shape 2,3,4).
// ArrayColumn data (table, "virtualArray");
// Array<DComplex> someArray(IPosition(2,3,4));
// someArray = 0;
// for (uInt i=0, i<10; i++) { // table will have 10 rows
// table.addRow();
// data.put (i, someArray)
// }
// </srcblock>
// </example>
// <templating arg=VirtualType>
// <li> only complex data types
// </templating>
// <templating arg=StoredType>
// <li> only built-in numerics data types
// </templating>
template<class VirtualType, class StoredType>
class ScaledComplexData : public BaseMappedArrayEngine<VirtualType, StoredType>
{
//# Make members of parent class known.
public:
using BaseMappedArrayEngine<VirtualType,StoredType>::virtualName;
protected:
using BaseMappedArrayEngine<VirtualType,StoredType>::storedName;
using BaseMappedArrayEngine<VirtualType,StoredType>::table;
using BaseMappedArrayEngine<VirtualType,StoredType>::column;
using BaseMappedArrayEngine<VirtualType,StoredType>::setNames;
public:
// Construct an engine to scale all arrays in a column with
// the given offset and scale factor.
// StoredColumnName is the name of the column where the scaled
// data will be put and must have data type StoredType.
// The virtual column using this engine must have data type VirtualType.
ScaledComplexData (const String& virtualColumnName,
const String& storedColumnName,
VirtualType scale,
VirtualType offset = 0);
// Construct an engine to scale the arrays in a column.
// The scale and offset values are taken from a column with
// the given names. In that way each array has its own scale factor
// and offset value.
// An exception is thrown if these columns do not exist.
// VirtualColumnName is the name of the virtual column and is used to
// check if the engine gets bound to the correct column.
// StoredColumnName is the name of the column where the scaled
// data will be put and must have data type StoredType.
// The virtual column using this engine must have data type VirtualType.
// <group>
ScaledComplexData (const String& virtualColumnName,
const String& storedColumnName,
const String& scaleColumnName,
VirtualType offset = 0);
ScaledComplexData (const String& virtualColumnName,
const String& storedColumnName,
const String& scaleColumnName,
const String& offsetColumnName);
// </group>
// Construct from a record specification as created by getmanagerSpec().
ScaledComplexData (const Record& spec);
// Destructor is mandatory.
~ScaledComplexData();
// Return the type name of the engine (i.e. its class name).
String dataManagerType() const;
// Record a record containing data manager specifications.
virtual Record dataManagerSpec() const;
// Return the name of the class.
// This includes the names of the template arguments.
static String className();
// The engine can access column cells.
virtual Bool canAccessArrayColumnCells (Bool& reask) const;
// Register the class name and the static makeObject "constructor".
// This will make the engine known to the table system.
// The automatically invoked registration function in DataManReg.cc
// contains ScaledComplexData<double,Int>.
// Any other instantiation of this class must be registered "manually"
// (or added to DataManReg.cc).
static void registerClass();
private:
// The default constructor is required for reconstruction of the
// engine when a table is read back.
ScaledComplexData();
// Copy constructor is only used by clone().
// (so it is made private).
ScaledComplexData (const ScaledComplexData<VirtualType,StoredType>&);
// Assignment is not needed and therefore forbidden
// (so it is made private and not implemented).
ScaledComplexData<VirtualType,StoredType>& operator=
(const ScaledComplexData<VirtualType,StoredType>&);
// Clone the engine object.
virtual DataManager* clone() const;
// Initialize the object for a new table.
// It defines the keywords containing the engine parameters.
virtual void create (uInt initialNrrow);
// Preparing consists of setting the writable switch and
// adding the initial number of rows in case of create.
// Furthermore it reads the keywords containing the engine parameters.
virtual void prepare();
// Set the shape of the FixedShape arrays in the column.
// This function only gets called if the column has FixedShape arrays.
// The shape gets saved and used to set the shape of the arrays
// in the stored in case the stored has non-FixedShape arrays.
virtual void setShapeColumn (const IPosition& shape);
// Define the shape of the array in the given row.
// When the shape of the (underlying) stored array has already been
// defined, it checks whether its latter dimensions match the given
// virtual shape. When matching, nothing will be done.
// When mismatching or when the stored shape has not been defined
// yet, the stored shape will be defined from the virtual shape and
// the virtual element shape.
// E.g. in case of a StokesVector a virtual shape of (512,512)
// results in a stored shape of (4,512,512).
virtual void setShape (uInt rownr, const IPosition& shape);
// Get the dimensionality of the array in the given row.
virtual uInt ndim (uInt rownr);
// Get the shape of the array in the given row.
// This is done by stripping the first dimension from the shape
// of the underlying stored array.
virtual IPosition shape (uInt rownr);
// Get an array in the given row.
// This will scale and offset from the underlying array.
virtual void getArray (uInt rownr, Array<VirtualType>& array);
// Put an array in the given row.
// This will scale and offset to the underlying array.
virtual void putArray (uInt rownr, const Array<VirtualType>& array);
// Get a section of the array in the given row.
// This will scale and offset from the underlying array.
virtual void getSlice (uInt rownr, const Slicer& slicer,
Array<VirtualType>& array);
// Put into a section of the array in the given row.
// This will scale and offset to the underlying array.
virtual void putSlice (uInt rownr, const Slicer& slicer,
const Array<VirtualType>& array);
// Get an entire column.
// This will scale and offset from the underlying array.
virtual void getArrayColumn (Array<VirtualType>& array);
// Put an entire column.
// This will scale and offset to the underlying array.
virtual void putArrayColumn (const Array<VirtualType>& array);
// Get some array values in the column.
// This will scale and offset from the underlying array.
virtual void getArrayColumnCells (const RefRows& rownrs,
Array<VirtualType>& data);
// Put some array values in the column.
// This will scale and offset to the underlying array.
virtual void putArrayColumnCells (const RefRows& rownrs,
const Array<VirtualType>& data);
// Get a section of all arrays in the column.
// This will scale and offset from the underlying array.
virtual void getColumnSlice (const Slicer& slicer,
Array<VirtualType>& array);
// Put a section of all arrays in the column.
// This will scale and offset to the underlying array.
virtual void putColumnSlice (const Slicer& slicer,
const Array<VirtualType>& array);
// Get a section of some arrays in the column.
// This will scale and offset from the underlying array.
virtual void getColumnSliceCells (const RefRows& rownrs,
const Slicer& slicer,
Array<VirtualType>& data);
// Put into a section of some arrays in the column.
// This will scale and offset to the underlying array.
virtual void putColumnSliceCells (const RefRows& rownrs,
const Slicer& slicer,
const Array<VirtualType>& data);
// Scale and/or offset stored to array.
// This is meant when reading an array from the stored column.
// It optimizes for scale=1 and/or offset=0.
void scaleOnGet (VirtualType scale, VirtualType offset,
Array<VirtualType>& array,
const Array<StoredType>& stored);
// Scale and/or offset array to stored.
// This is meant when writing an array into the stored column.
// It optimizes for scale=1 and/or offset=0.
void scaleOnPut (VirtualType scale, VirtualType offset,
const Array<VirtualType>& array,
Array<StoredType>& stored);
// Scale and/or offset stored to array for the entire column.
// When the scale and offset are fixed, it will do the entire array.
// Otherwise it iterates through the array and applies the scale
// and offset per row.
void scaleColumnOnGet (Array<VirtualType>& array,
const Array<StoredType>& stored);
// Scale and/or offset array to stored for the entire column.
// When the scale and offset are fixed, it will do the entire array.
// Otherwise it iterates through the array and applies the scale
// and offset per row.
void scaleColumnOnPut (const Array<VirtualType>& array,
Array<StoredType>& stored);
// Scale and/or offset stored to array for some cells in the column.
// When the scale and offset are fixed, it will do the entire array.
// Otherwise it iterates through the array and applies the scale
// and offset per row.
void scaleCellsOnGet (Array<VirtualType>& array,
const Array<StoredType>& stored,
const RefRows& rownrs);
// Scale and/or offset array to stored for some cells in the column.
// When the scale and offset are fixed, it will do the entire array.
// Otherwise it iterates through the array and applies the scale
// and offset per row.
void scaleCellsOnPut (const Array<VirtualType>& array,
Array<StoredType>& stored,
const RefRows& rownrs);
// Determine the shape of an array in the stored column.
IPosition storedShape (const IPosition& virtualShape) const
{ return IPosition(1,2).concatenate (virtualShape); }
// Convert the Slicer for a virtual to a Slicer for the stored.
Slicer storedSlicer (const Slicer& virtualSlicer) const;
//# Now define the data members.
String scaleName_p; //# name of scale column
String offsetName_p; //# name of offset column
VirtualType scale_p; //# scale factor
VirtualType offset_p; //# offset value
Bool fixedScale_p; //# scale is a fixed column
Bool fixedOffset_p; //# offset is a fixed column
ScalarColumn<VirtualType>* scaleColumn_p; //# column with scale value
ScalarColumn<VirtualType>* offsetColumn_p; //# column with offset value
// Get the scale value for this row.
VirtualType getScale (uInt rownr);
// Get the offset value for this row.
VirtualType getOffset (uInt rownr);
public:
// Define the "constructor" to construct this engine when a
// table is read back.
// This "constructor" has to be registered by the user of the engine.
// If the engine is commonly used, its registration can be added
// to the registerAllCtor function in DataManReg.cc.
// That function gets automatically invoked by the table system.
static DataManager* makeObject (const String& dataManagerType,
const Record& spec);
};
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/tables/DataMan/ScaledComplexData.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|