/usr/include/casacore/lattices/LatticeMath/LatticeAddNoise.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 | //# LatticeAddNoise.h: add noise to a Lattice
//# Copyright (C) 1997,1998,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: LatticeAddNoise.h 21549 2015-01-28 10:01:12Z gervandiepen $
#ifndef LATTICES_LATTICEADDNOISE_H
#define LATTICES_LATTICEADDNOISE_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/Vector.h>
#include <casacore/casa/BasicMath/Random.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
template <class T> class MaskedLattice;
template <class T> class Lattice;
// <summary>
// Add noise from specified distribution to a lattice
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class="Lattice">Lattice</linkto>
// <li> <linkto class="Random">Random</linkto>
// </prerequisite>
// <synopsis>
// This class allows you to add noise from one of many enumerated
// types to a Lattice. If the Lattice is Complex, then the noise
// is added to real and imaginary separately.
// </synopsis>
// <example>
// <srcblock>
// Vector<Double> pars(2):
// pars(0) = 0.5; // Mean
// pars(1) = 0.2; // Variance
// LatticeAddNoise lan(Random::NORMAL, pars);
// ArrayLattice<Float> lat(IPosition(2,100,100));
// lan.add(lat);
// </srcblock>
// </example>
//# <todo asof="yyyy/mm/dd">
//# </todo>
class LatticeAddNoise
{
public:
// Default constructor
LatticeAddNoise();
// Constructor. An exception will occur if we cannot generate
// the distribution (e.g. illegal parameters). seed1 and seed2
// are used to seed the MLCG object.
LatticeAddNoise (
Random::Types type,
const Vector<Double>& parameters,
Int seed1=0, Int seed2=1
);
// Copy constructor (copy semantics)
LatticeAddNoise (const LatticeAddNoise& other);
// Assignment (copy semantics)
LatticeAddNoise& operator=(const LatticeAddNoise& other);
// Destructor
~LatticeAddNoise();
// Set a new distribution. An exception will occur if we cannot generate
// the distribution (e.g. illegal parameters).
void set (Random::Types type,
const Vector<Double>& parameters);
// Add noise of given type to lattice. For Complex, the
// noise is added to real and imaginary separately.
// Any mask is ignored when adding the noise. I.e.
// noise is added to masked pixels.
// <group>
void add (MaskedLattice<Float>& lattice);
void add (MaskedLattice<Complex>& lattice);
void add (Lattice<Float>& lattice);
void add (Lattice<Complex>& lattice);
// </group>
private:
Random::Types itsType;
Vector<Double> itsParameters;
MLCG itsGen;
Random* itsNoise;
// Add noise to array. For Complex, noise is added to
// real and imaginary separately.
// <group>
void addNoiseToArray (Array<Float>& data);
void addNoiseToArray (Array<Complex>& data);
// </group>
// Make noise generator
void makeDistribution ();
};
} //# NAMESPACE CASACORE - END
#endif
|