/usr/include/casacore/images/Regions/WCLELMask.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 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 | //# WCLELMask.h: Class to define a mask as a LEL expression
//# Copyright (C) 2000,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 IMAGES_WCLELMASK_H
#define IMAGES_WCLELMASK_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/images/Regions/WCRegion.h>
#include <casacore/lattices/LRegions/RegionType.h>
#include <casacore/coordinates/Coordinates/CoordinateSystem.h>
#include <casacore/casa/Arrays/Vector.h>
#include <casacore/casa/Quanta/Quantum.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class LCRegion;
class TableRecord;
class IPosition;
template<class T> class ImageExpr;
template<class T> class LatticeExpr;
class LatticeExprNode;
// <summary>
// Class to define a mask as a LEL expression
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="" tests="">
// </reviewed>
// <prerequisite>
// <li> <linkto class=WCRegion>WCRegion</linkto>
// <li> <linkto class=ImageExpr>ImageExpr</linkto>
// </prerequisite>
// <synopsis>
// The WCLELMask class is a specialization of class
// <linkto class=WCRegion>WCRegion</linkto>.
// <br>
// It can be used to define an on-the-fly mask for an image
// using a boolean <linkto class=LatticeExpr>LatticeExpr</linkto>.
// The contents of the mask are calculated on the fly from the expression.
// Thus the mask may change if the data in the image(s) used in the
// expression change.
// <note role=caution>
// This mask is only persistent if constructed from an expression string.
// When constructed from an <linkto class=ImageExpr>ImageExpr</linkto>
// the mask is not persistent.
// </note>
// </synopsis>
// <example>
// </example>
// <motivation>
// Users must be able to specify a mask based on an expression.
// </motivation>
//# <todo asof="1998/05/20">
//# <li>
//# </todo>
class WCLELMask : public WCRegion
{
public:
WCLELMask();
// Construct from the given expression command.
// The command will be parsed and converted to an ImageExpr.
// <group>
explicit WCLELMask (const String& command);
explicit WCLELMask (const char* command);
// </group>
// Construct from the given image expression.
explicit WCLELMask (const ImageExpr<Bool>& expr);
// Construct from the given lattice expression.
explicit WCLELMask (const LatticeExpr<Bool>& expr);
// Construct from the given lattice expression.
// This constructor makes it possible to have an expression with an
// unknown shape (e.g. using LEL function INDEXIN).
// If the shape is known, the LatticeExprNode will be converted to
// a LatticeExpr<Bool>.
explicit WCLELMask (const LatticeExprNode& expr);
// Copy constructor (copy semantics).
WCLELMask (const WCLELMask& other);
// Destructor
virtual ~WCLELMask();
// Assignment (copy semantics)
WCLELMask& operator= (const WCLELMask& other);
// Comparison
virtual Bool operator== (const WCRegion& other) const;
// Clone a WCLELMask object.
virtual WCRegion* cloneRegion() const;
// Get the dimensionality (i.e. the number of axes).
virtual uInt ndim() const;
// WCLELMask cannot extend a region.
virtual Bool canExtend() const;
// Convert to an LCRegion using the given new coordinate system and shape.
// If the region has coordinates, the WCRegion implementation will
// be called. Otherwise the LatticeExpr is returned after checking
// that the shape matches.
virtual LCRegion* toLCRegion (const CoordinateSystem& cSys,
const IPosition& latticeShape) const;
// Convert to an LCRegion using the supplied <src>CoordinateSystem</src>
// and shape.
// It checks that coordinates match and that axes are not swapped.
virtual LCRegion* doToLCRegion (const CoordinateSystem& cSys,
const IPosition& latticeShape,
const IPosition& pixelAxesMap,
const IPosition& outOrder) const;
// Convert the WCLELMask object to a record.
// The record can be used to make the object persistent.
// The <src>tableName</src> argument can be used by derived
// classes (e.g. LCPagedMask) to put very large objects.
virtual TableRecord toRecord (const String& tableName) const;
// Convert to a WCLELMask from a record.
static WCLELMask* fromRecord (const TableRecord& rec,
const String& tableName);
// Returns WCLELMask
static String className();
// Return region type. Returns the class name
virtual String type() const;
const ImageExpr<Bool>* getImageExpr() const {return itsImageExpr;}
private:
// Process the command.
void processCommand();
// Initialize as a LatticeExprNode if expression's shape is unknown.
// Otherwise as a LatticeExpr<Bool> if coordinates are unknown.
// Otherwise as an ImageExpr<Bool>.
void init (const LatticeExprNode& expr);
String itsCommand;
ImageExpr<Bool>* itsImageExpr;
LatticeExpr<Bool>* itsLattExpr;
LatticeExprNode* itsLattNode;
};
} //# NAMESPACE CASACORE - END
#endif
|