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
|
//# LELCondition.h: Class to make a mask from a condition
//# Copyright (C) 1999,2000
//# 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_LELCONDITION_H
#define LATTICES_LELCONDITION_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/lattices/LEL/LELInterface.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary>
// Class to make a mask from a condition.
// </summary>
// <use visibility=local>
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class="Lattice"> Lattice</linkto>
// <li> <linkto class="LatticeExpr"> LatticeExpr</linkto>
// <li> <linkto class="LatticeExprNode"> LatticeExprNode</linkto>
// <li> <linkto class="LELInterface"> LELInterface</linkto>
// </prerequisite>
// <etymology>
// This derived LEL letter class handles a condition as a mask.
// </etymology>
// <synopsis>
// This LEL letter class is derived from LELInterface. It
// is used to construct LEL objects that know how to deal with
// a condition (given using operator[]).
// The operands cannot be a scalar.
// The LELCondition object is embedded in the tree, and the conversion
// actually happens at tree evaluation time.
// <p>
// A description of the implementation details of the LEL classes can
// be found in
// <a href="../notes/216.html">Note 216</a>
// </synopsis>
// <example>
// Examples are not very useful as the user would never use
// these classes directly. Look in LatticeExprNode.cc to see
// how it invokes these classes. An example of how the user
// would indirectly use this class (through the envelope) is:
// <srcblock>
// IPosition shape(2,5,10);
// ArrayLattice<Float> x(shape); x.set(1.0);
// ArrayLattice<Double> y(shape);
// y.copyData(x[x>5]); // y = x;
// </srcblock>
// The LELCondition class is embedded in the tree at construction time
// so as to turn the condition in a mask on x.
// </example>
//# <todo asof="1998/01/21">
//# </todo>
template <class T> class LELCondition : public LELInterface<T>
{
//# Make members of parent class known.
protected:
using LELInterface<T>::setAttr;
public:
// Construct the condition on the given expression.
LELCondition (const CountedPtr<LELInterface<T> >& expr,
const CountedPtr<LELInterface<Bool> >& cond);
// Destructor does nothing
~LELCondition();
// Recursively evaluate the expression.
virtual void eval (LELArray<T>& result,
const Slicer& section) const;
// Recursively evaluate the scalar
virtual LELScalar<T> getScalar() const;
// Do further preparations (e.g. optimization) on the expression.
virtual Bool prepareScalarExpr();
// Get class name
virtual String className() const;
// Handle locking/syncing of a lattice in a lattice expression.
// <group>
virtual Bool lock (FileLocker::LockType, uInt nattempts);
virtual void unlock();
virtual Bool hasLock (FileLocker::LockType) const;
virtual void resync();
// </group>
private:
CountedPtr<LELInterface<T> > pExpr_p;
CountedPtr<LELInterface<Bool> > pCond_p;
};
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/lattices/LEL/LELCondition.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|
