/usr/include/casacore/casa/Arrays/Cube.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 | //# Cube.h: A 3-D Specialization of the Array Class
//# Copyright (C) 1993,1994,1995,1996,1999,2000,2001,2003
//# 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 CASA_CUBE_H
#define CASA_CUBE_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/Array.h>
namespace casacore { //#Begin casa namespace
//# Forward Declarations
template<class T> class Matrix;
// <summary> A 3-D Specialization of the Array class </summary>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
// </reviewed>
//
// Cube objects are three-dimensional specializations (e.g., more convenient
// and efficient indexing) of the general Array class. You might also want
// to look at the Array documentation to see inherited functionality.
//
// Generally the member functions of Array are also available in
// Cube versions which take a pair of integers where the array
// needs an IPosition. Since the Cube
// is three-dimensional, the IPositions are overkill, although you may
// use those versions if you want to.
// <srcblock>
// Cube<Int> ci(100,100,100); // Shape is 100x100
// ci.resize(50,50,50); // Shape now 50x50
// </srcblock>
//
// Slices may be taken with the Slice class. To take a slice, one "indexes"
// with one Slice(start, length, inc) for each axis, where end and inc
// are optional. Additionally, there is an xyPlane()
// member function which return a Matrix which corresponds to some plane:
// <srcblock>
// Cube<Float> cube(10,20,30);
// for(uInt i=0; i < 30; i++) {
// cube.xyPlane(i) = i; // Set every 10x20 plane to its "height"
// }
// </srcblock>
//
// Element-by-element arithmetic and logical operations are available (in
// aips/ArrayMath.h and aips/ArrayLogical.h).
//
// As with the Arrays, if the preprocessor symbol AIPS_DEBUG is
// defined at compile time invariants will be checked on entry to most
// member functions. Additionally, if AIPS_ARRAY_INDEX_CHECK is defined
// index operations will be bounds-checked. Neither of these should
// be defined for production code.
template<class T> class Cube : public Array<T>
{
public:
// A Cube of length zero in each dimension; zero origin.
Cube();
// A l1xl2xl3 sized cube.
Cube(size_t l1, size_t l2, size_t l3);
// A l1xl2xl3 sized cube.
Cube(size_t l1, size_t l2, size_t l3, ArrayInitPolicy initPolicy);
// A l1xl2xl3 sized cube.
// Fill it with the initial value.
Cube(size_t l1, size_t l2, size_t l3, const T &initialValue);
// A Cube where the shape ("len") is defined with IPositions.
Cube(const IPosition &len);
// A Cube where the shape ("len") is defined with IPositions.
Cube(const IPosition &len, ArrayInitPolicy initPolicy);
// A Cube where the shape ("len") is defined with IPositions.
// Fill it with the initial value.
Cube(const IPosition &len, const T &initialValue);
// The copy constructor uses reference semantics.
Cube(const Cube<T> &);
// Construct a cube by reference from "other". "other must have
// ndim() of 3 or less. The warning which applies to the copy constructor
// is also valid here.
Cube(const Array<T> &);
// Create an Cube of a given shape from a pointer.
Cube(const IPosition &shape, T *storage, StorageInitPolicy policy = COPY);
// Create an Cube of a given shape from a pointer.
Cube(const IPosition &shape, T *storage, StorageInitPolicy policy, AbstractAllocator<T> const &allocator);
// Create an Cube of a given shape from a pointer. Because the pointer
// is const, a copy is always made.
Cube(const IPosition &shape, const T *storage);
// Define a destructor, otherwise the (SUN) compiler makes a static one.
virtual ~Cube();
// Assign the other array (which must be dimension 3) to this cube.
// If the shapes mismatch, this array is resized.
virtual void assign (const Array<T>& other);
// Make this cube a reference to other. Other must be of dimensionality
// 3 or less.
virtual void reference(const Array<T> &other);
// Resize to the given shape.
// Resize without argument is equal to resize(0,0,0).
// <group>
using Array<T>::resize;
void resize(size_t nx, size_t ny, size_t nz, Bool copyValues=False) {
Cube<T>::resize(nx, ny, nz, copyValues, Array<T>::defaultArrayInitPolicy());
}
void resize(size_t nx, size_t ny, size_t nz, Bool copyValues, ArrayInitPolicy policy);
virtual void resize();
virtual void resize(const IPosition &newShape, Bool copyValues, ArrayInitPolicy policy);
// </group>
// Copy the values from other to this cube. If this cube has zero
// elements then it will resize to be the same shape as other; otherwise
// other must conform to this.
// Note that the assign function can be used to assign a
// non-conforming cube.
// <group>
Cube<T> &operator=(const Cube<T> &other);
virtual Array<T> &operator=(const Array<T> &other);
// </group>
// Copy val into every element of this cube; i.e. behaves as if
// val were a constant conformant cube.
Array<T> &operator=(const T &val)
{ return Array<T>::operator=(val); }
// Copy to this those values in marray whose corresponding elements
// in marray's mask are True.
Cube<T> &operator= (const MaskedArray<T> &marray)
{ Array<T> (*this) = marray; return *this; }
// Single-pixel addressing. If AIPS_ARRAY_INDEX_CHECK is defined,
// bounds checking is performed.
// <group>
T &operator()(const IPosition &i)
{ return Array<T>::operator()(i); }
const T &operator()(const IPosition &i) const
{ return Array<T>::operator()(i); }
T &operator()(size_t i1, size_t i2, size_t i3)
{
#if defined(AIPS_ARRAY_INDEX_CHECK)
this->validateIndex(i1, i2, i3); // Throws an exception on failure
#endif
return this->begin_p[i1*xinc_p + i2*yinc_p + i3*zinc_p];
}
const T &operator()(size_t i1, size_t i2, size_t i3) const
{
#if defined(AIPS_ARRAY_INDEX_CHECK)
this->validateIndex(i1, i2, i3); // Throws an exception on failure
#endif
return this->begin_p[i1*xinc_p + i2*yinc_p + i3*zinc_p];
}
//# Have function at (temporarily) to check if test on contiguous is
//# indeed slower than always using multiplication in operator()
T &at(size_t i1, size_t i2, size_t i3)
{
#if defined(AIPS_ARRAY_INDEX_CHECK)
this->validateIndex(i1, i2, i3); // Throws an exception on failure
#endif
return this->contiguous_p ? this->begin_p[i1 + i2*yinc_p + i3*zinc_p] :
this->begin_p[i1*xinc_p + i2*yinc_p + i3*zinc_p];
}
const T &at(size_t i1, size_t i2, size_t i3) const
{
#if defined(AIPS_ARRAY_INDEX_CHECK)
this->validateIndex(i1, i2, i3); // Throws an exception on failure
#endif
return this->contiguous_p ? this->begin_p[i1 + i2*yinc_p + i3*zinc_p] :
this->begin_p[i1*xinc_p + i2*yinc_p + i3*zinc_p];
}
// </group>
// Take a slice of this cube. Slices are always indexed starting
// at zero. This uses reference semantics, i.e. changing a value
// in the slice changes the original.
// <srcblock>
// Cube<Double> vd(100,100,100);
// //...
// vd(Slice(0,10),Slice(10,10,Slice(0,10))) = -1.0; // sub-cube set to -1.0
// </srcblock>
// <group>
Cube<T> operator()(const Slice &sliceX, const Slice &sliceY,
const Slice &sliceZ);
const Cube<T> operator()(const Slice &sliceX, const Slice &sliceY,
const Slice &sliceZ) const;
// </group>
// Slice using IPositions. Required to be defined, otherwise the base
// class versions are hidden.
// <group>
Array<T> operator()(const IPosition &blc, const IPosition &trc,
const IPosition &incr)
{ return Array<T>::operator()(blc,trc,incr); }
const Array<T> operator()(const IPosition &blc, const IPosition &trc,
const IPosition &incr) const
{ return Array<T>::operator()(blc,trc,incr); }
Array<T> operator()(const IPosition &blc, const IPosition &trc)
{ return Array<T>::operator()(blc,trc); }
const Array<T> operator()(const IPosition &blc, const IPosition &trc) const
{ return Array<T>::operator()(blc,trc); }
Array<T> operator()(const Slicer& slicer)
{ return Array<T>::operator()(slicer); }
const Array<T> operator()(const Slicer& slicer) const
{ return Array<T>::operator()(slicer); }
// </group>
// The array is masked by the input LogicalArray.
// This mask must conform to the array.
// <group>
// Return a MaskedArray.
const MaskedArray<T> operator() (const LogicalArray &mask) const
{ return Array<T>::operator() (mask); }
// Return a MaskedArray.
MaskedArray<T> operator() (const LogicalArray &mask)
{ return Array<T>::operator() (mask); }
// </group>
// The array is masked by the input MaskedLogicalArray.
// The mask is effectively the AND of the internal LogicalArray
// and the internal mask of the MaskedLogicalArray.
// The MaskedLogicalArray must conform to the array.
// <group>
// Return a MaskedArray.
const MaskedArray<T> operator() (const MaskedLogicalArray &mask) const
{ return Array<T>::operator() (mask); }
// Return a MaskedArray.
MaskedArray<T> operator() (const MaskedLogicalArray &mask)
{ return Array<T>::operator() (mask); }
// </group>
// Extract a plane as a matrix referencing the original data.
// Of course you could also use a Matrix
// iterator on the cube.
// <group>
Matrix<T> xyPlane(size_t zplane);
const Matrix<T> xyPlane(size_t zplane) const;
Matrix<T> xzPlane(size_t yplane);
const Matrix<T> xzPlane(size_t yplane) const;
Matrix<T> yzPlane(size_t xplane);
const Matrix<T> yzPlane(size_t xplane) const;
// </group>
// The length of each axis of the cube.
const IPosition &shape() const
{ return this->length_p; }
void shape(Int &s1, Int &s2, Int &s3) const
{ s1 = this->length_p(0); s2=this->length_p(1); s3=this->length_p(2); }
// The number of rows in the Cube, i.e. the length of the first axis.
size_t nrow() const
{ return this->length_p(0); }
// The number of columns in the Cube, i.e. the length of the 2nd axis.
size_t ncolumn() const
{ return this->length_p(1); }
// The number of planes in the Cube, i.e. the length of the 3rd axis.
size_t nplane() const
{ return this->length_p(2); }
// Checks that the cube is consistent (invariants check out).
virtual Bool ok() const;
protected:
virtual void preTakeStorage(const IPosition &shape);
virtual void postTakeStorage();
// Remove the degenerate axes from other and store result in this cube.
// An exception is thrown if removing degenerate axes does not result
// in a cube.
virtual void doNonDegenerate(const Array<T> &other,
const IPosition &ignoreAxes);
private:
// Cached constants to improve indexing.
size_t xinc_p, yinc_p, zinc_p;
// Helper fn to calculate the indexing constants.
void makeIndexingConstants();
};
} //#End casa namespace
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/casa/Arrays/Cube.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|