/usr/include/casacore/lattices/Lattices/LatticeCache.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 | //# LatticeCache: Cache for accessing a Lattice in Tiles
//# Copyright (C) 1995,1996,1997,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 LATTICES_LATTICECACHE_H
#define LATTICES_LATTICECACHE_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/Array.h>
#include <casacore/casa/Arrays/Vector.h>
//# Forward Declarations
#include <casacore/casa/iosfwd.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
template <class T> class Block;
template <class T> class Lattice;
// <summary> a class for caching image access via tiles</summary>
//
// <use visibility=export>
//
// <reviewed reviewer="" date="" tests="" demos="">
// </reviewed>
//
// <prerequisite>
// <li> <linkto class=Lattice>Lattice</linkto>
// </prerequisite>
//
// <etymology>
// This class divides an image into Tiles that are stored in
// a Cache.
// </etymology>
//
// <synopsis>
// An image is divided into tiles of a specified shape. Access to the
// image pixels is via these tiles. A cache of active tiles is kept
// in memory up to a specified limit in memory allocation. Tiles
// are flushed to disk using a Least-Recently-Used Criterion.
//
// The tile size specified is the maximum dimension. Near the edge,
// smaller tiles are returned if necessary.
//
// The offset needed to get back to true pixels is also available.
//
// The cache hit rate for a sufficient number of random accesses
// goes as the ratio of cache size to image size.
//
// Tiles may be overlapped. If there is any overlap then the
// caller is responsible for dealing with the overlap. Normally
// one will only want overlapping windows for additive operations
// in which case the additive flag to the constructor should be
// used.
// </synopsis>
//
// <example>
// <srcblock>
// </srcblock>
//
// </example>
//
// <motivation>
// To aid in gridding
// </motivation>
//
// <todo asof="1997/02/27">
// </todo>
template <class T> class LatticeCache
{
public:
// Constructor: cachesize in units of T. tileOverlap is the fractional
// overlap between neighbouring tile.
LatticeCache(Lattice<T> &image, Int cacheSize, IPosition tileShape,
Vector<Float>& tileOverlap, Bool additive);
LatticeCache(const LatticeCache<T> & other);
LatticeCache<T> &operator=(const LatticeCache<T> & other);
virtual ~LatticeCache();
// Return the tile for a given location
// <group>
Array<T>& tile(IPosition& cacheLoc, const IPosition& tileLoc, Bool discard=True);
Array<T>& tile(const IPosition& tileLoc, Bool discard=True);
// </group>
// const version is needed
const Array<T>& tile(const IPosition& tileLoc);
// Return the IPosition for the start of this tile
IPosition& cacheLocation(IPosition& cacheLoc, const IPosition& tileLoc);
// Show the statistics of cache access
virtual void showCacheStatistics(ostream& os);
// Clear the statistics of cache access
virtual void clearCacheStatistics();
// Flush contents
virtual void flush();
protected:
LatticeCache() {};
Int numberTiles;
IPosition tileShape;
Vector<Int> tileShapeVec, tileOffsetVec;
Vector<Float> tileOverlap;
Bool additive;
Int cacheSize;
Int cacheAccesses;
Int cacheHits;
Int cacheMisses;
Int cacheReads;
Int cacheWrites;
Int getFreeTile(Bool readonly);
Block<IPosition> tileLocs;
Block<Int> tileSequence;
Block<Array<T> > tileContents;
void writeTile(Int tile);
void readTile(Int tile, Bool readonly);
Lattice<T>* image_p;
};
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/lattices/Lattices/LatticeCache.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|