/usr/include/casacore/lattices/LatticeMath/MaskedLatticeStatsDataProvider.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 | //# Copyright (C) 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: Array.h 21545 2015-01-22 19:36:35Z gervandiepen $
#ifndef LATTICES_MASKEDLATTICESTATSDATAPROVIDER_H
#define LATTICES_MASKEDLATTICESTATSDATAPROVIDER_H
#include <casacore/lattices/LatticeMath/LatticeStatsDataProviderBase.h>
#include <casacore/lattices/Lattices/MaskedLattice.h>
#include <casacore/lattices/Lattices/MaskedLatticeIterator.h>
#include <casacore/casa/aips.h>
namespace casacore {
// Data provider which allows stats framework to iterate through a masked lattice.
template <class T> class MaskedLatticeStatsDataProvider
: public LatticeStatsDataProviderBase<T> {
public:
// default constructor. Must set lattice after construction but before
// using the object
MaskedLatticeStatsDataProvider();
// <src>iteratorLimitBytes</src> is related to the size of the lattice.
// If the lattice is greater than this size, then a lattice iterator will
// be used to step through the lattice. If less, then all the data in the
// values in the lattice are retrieved in a single chunk. The advantage of
// the iterator is that less memory is used. The disadvantage is there is
// a significant performace cost, so if the lattice is small, it is better to
// get all its values in a single chunk and forgo the iterator. This is particularly
// true when looping for a large number of iterations and creating a
// MaskedLatticeStatsDataProvider each loop (in that case, you probably will want
// to create a single object before the loop and use setLattice() to update
// its lattice).
MaskedLatticeStatsDataProvider(
MaskedLattice<T>& lattice, uInt iteratorLimitBytes=4096*4096
);
~MaskedLatticeStatsDataProvider();
void operator++();
uInt estimatedSteps() const;
// Are there any data sets left to provide?
Bool atEnd() const;
// Take any actions necessary to finalize the provider. This will be called when
// atEnd() returns True.
void finalize();
// get the count of elements in the current data set. When implementing this method, be
// certain to take stride into account; ie for a data set with nominally 100 elements that
// is to have a stride of two, this method should return 50.
uInt64 getCount();
// get the current data set
const T* getData();
// Get the associated mask of the current dataset. Only called if hasMask() returns True;
const Bool* getMask();
// Does the current data set have an associated mask?
Bool hasMask() const;
// reset the provider to point to the first data set it manages.
void reset();
// set the lattice. Automatically resets the lattice iterator.
// <src>iteratorLimitBytes</src> is related to the size of the lattice.
// If the lattice is greater than this size, then a lattice iterator will
// be used to step through the lattice. If less, then all the data in the
// values in the lattice are retrieved in a single chunk. The advantage of
// the iterator is that less memory is used. The disadvantage is there is
// a significant performace cost, so if the lattice is small, it is better to
// get all its values in a single chunk and forgo the iterator. This is particularly
// true when looping for a large number of iterations and creating a
// MaskedLatticeStatsDataProvider each loop (in that case, you probably will want
// to create a single object before the loop and use setLattice() to update
// its lattice).
void setLattice(const MaskedLattice<T>& lattice, uInt iteratorLimitBytes=4096*4096);
// <group>
// see base class documentation.
void updateMaxPos(const std::pair<Int64, Int64>& maxpos);
void updateMinPos(const std::pair<Int64, Int64>& minpos);
// </group>
private:
CountedPtr<RO_MaskedLatticeIterator<T> > _iter;
Array<T> _currentSlice;
Array<Bool> _currentMaskSlice;
const T* _currentPtr;
const Bool* _currentMaskPtr;
Bool _delData, _delMask, _atEnd;
void _freeStorage();
};
}
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/lattices/LatticeMath/MaskedLatticeStatsDataProvider.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|