/usr/include/casacore/lattices/LatticeMath/LatticeTwoPtCorr.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 | //# LatticeTwoPtCorr.h: compute two-point correlation functions from a lattice
//# Copyright (C) 1997,1998,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 LATTICES_LATTICETWOPTCORR_H
#define LATTICES_LATTICETWOPTCORR_H
//# Includes
#include <casacore/casa/aips.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
template <class T> class MaskedLattice;
template <class T> class Lattice;
class IPosition;
class LogIO;
class String;
// <summary>
// Compute two point auto-correlation functions from a lattice
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class="MaskedLattice">MaskedLattice</linkto>
// </prerequisite>
// <synopsis>
// This class allows you to compute two point correlation functions
// from lattices over planes of the specified two axes.
// At present, only autocorrelation is implemented and only
// the structure function is available.
//
// The structure function is
// <src>S(x,y) = < [lat(i,j) - lat(i+x,j+y)]**2 ></src>
// where x and y are absolute integer shifts (or lags).
// </synopsis>
// <example>
// <srcblock>
// </srcblock>
// </example>
// <todo asof="yyyy/mm/dd">
// <li> Add additional algorithms other than the structure function
// <li> Allow cross correlation algorithms as well as autocorrelation
// </todo>
template <class T> class LatticeTwoPtCorr
{
public:
enum Method {
// Undefined
UNDEFINED,
// Structure Function
STRUCTUREFUNCTION,
// nMethods
NMETHODS
};
// Default constructor
LatticeTwoPtCorr()
{}
// Destructor
~LatticeTwoPtCorr()
{}
// Compute specified autocorrelation function for the planes of the given TWO axes.
// If the output lattice has a mask, it will first be set to False (bad)
// and then any output pixel with some contributing values will be set to
// True (good).
// <group>
void autoCorrelation (MaskedLattice<T>& out, const MaskedLattice<T>& in,
const IPosition& axes, Method method,
Bool showProgress=True) const;
// </group>
// Helper function to provide output lattice shape give the input shape
// and the axes to find the structure function over.
static IPosition setUpShape (const IPosition& inShape, const IPosition& axes);
// Helper functions to convert method types to and from strings
// <group>
static Method fromString (const String& method);
static String toString (Method method);
// </group>
private:
// Function Pointer typedef
typedef T (LatticeTwoPtCorr<T>::*FuncPtr)(T d1, T d2) const;
// Do the iteration work
void autoCorrelation (MaskedLattice<T>& out, const MaskedLattice<T>& in,
const IPosition& axes,
FuncPtr,
Bool showProgress) const;
// Check Output lattice shape
void check (LogIO& os, const MaskedLattice<T>& latOut,
const MaskedLattice<T>& latIn,
const IPosition& axes) const;
// Compute structure function
T structureFunction (T d1, T d2) const {return (d1-d2)*(d1-d2);}
};
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/lattices/LatticeMath/LatticeTwoPtCorr.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|