casacore
WCDifference.h
Go to the documentation of this file.
1 //# WCDifference.h: Make the difference of 2 image regions
2 //# Copyright (C) 1998
3 //# Associated Universities, Inc. Washington DC, USA.
4 //#
5 //# This library is free software; you can redistribute it and/or modify it
6 //# under the terms of the GNU Library General Public License as published by
7 //# the Free Software Foundation; either version 2 of the License, or (at your
8 //# option) any later version.
9 //#
10 //# This library is distributed in the hope that it will be useful, but WITHOUT
11 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 //# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13 //# License for more details.
14 //#
15 //# You should have received a copy of the GNU Library General Public License
16 //# along with this library; if not, write to the Free Software Foundation,
17 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
18 //#
19 //# Correspondence concerning AIPS++ should be addressed as follows:
20 //# Internet email: aips2-request@nrao.edu.
21 //# Postal address: AIPS++ Project Office
22 //# National Radio Astronomy Observatory
23 //# 520 Edgemont Road
24 //# Charlottesville, VA 22903-2475 USA
25 //#
26 //# $Id$
27 
28 #ifndef IMAGES_WCDIFFERENCE_H
29 #define IMAGES_WCDIFFERENCE_H
30 
31 //# Includes
32 #include <casacore/casa/aips.h>
33 #include <casacore/images/Regions/WCCompound.h>
34 
35 
36 namespace casacore { //# NAMESPACE CASACORE - BEGIN
37 
38 // <summary>
39 // Make the difference of 2 image regions.
40 // </summary>
41 
42 // <use visibility=export>
43 
44 // <reviewed reviewer="" date="" tests="">
45 // </reviewed>
46 
47 // <prerequisite>
48 // <li> <linkto class=WCCompound>WCCompound</linkto>
49 // </prerequisite>
50 
51 // <synopsis>
52 // The WCDifference class is a specialization of class
53 // <linkto class=WCCompound>WCCompound</linkto>.
54 // It makes it possible to take the difference of 2 regions.
55 // Note that only world coordinate regions can be used in a compound,
56 // thus an LCSlicer object is not allowed in a difference.
57 // <p>
58 // The difference consists of all pixels masked-on in the first
59 // region and not masked-on in the second region.
60 // <p>
61 // The regions in a difference can have different axes and dimensionalities.
62 // The axes and dimensionality of a difference are determined by the
63 // collection of all different axes in its regions. Each individual region
64 // will be auto-extended along the axes not being part of the region.
65 // E.g. one can define a WCBox with axis RA and another WCBox with
66 // axis DEC. The difference will be 2-dim with axes RA and DEC. The first
67 // box will be auto-extended to cover the DEC axis, which results
68 // in a 2-dim box with its DEC axis the length of the image's DEC axis.
69 // Similarly the second box will be auto-extended to cover the RA axis.
70 // </synopsis>
71 
72 // <example>
73 // <srcblock>
74 // </srcblock>
75 // </example>
76 
77 //# <todo asof="1997/11/11">
78 //# <li>
79 //# </todo>
80 
81 
82 class WCDifference: public WCCompound
83 {
84 public:
85  // Construct the difference of one or more image regions.
86  // The image regions have to contain WCRegion objects, otherwise an
87  // exception is thrown.
88  // <group>
89  WCDifference (const ImageRegion& region1, const ImageRegion& region2);
91  // </group>
92 
93  // Construct from multiple regions given as a Block.
94  // When <src>takeOver</src> is True, the destructor will delete the
95  // given regions. Otherwise a copy of the regions is made.
97 
98  // Copy constructor (copy semantics).
99  WCDifference (const WCDifference& other);
100 
101  virtual ~WCDifference();
102 
103  // Assignment (copy semantics).
105 
106  // Comparison
107  virtual Bool operator== (const WCRegion& other) const;
108 
109  // Make a copy of the derived object.
110  virtual WCRegion* cloneRegion() const;
111 
112  // Get the class name (to store in the record).
113  static String className();
114 
115  // Get the region type. Returns className()
116  virtual String type() const;
117 
118  // Convert the (derived) object to a record.
119  virtual TableRecord toRecord (const String& tableName) const;
120 
121  // Convert correct object from a record.
123  const String& tableName);
124 
125 protected:
126  // Convert to an LCRegion using the given coordinate system and shape.
127  // pixelAxesMap(i) gives the pixel axis in cSys of axes <src>i</src>
128  // in the axesDesc.
129  virtual LCRegion* doToLCRegion (const CoordinateSystem& cSys,
130  const IPosition& shape,
131  const IPosition& pixelAxesMap,
132  const IPosition& outOrder) const;
133 };
134 
135 
136 
137 } //# NAMESPACE CASACORE - END
138 
139 #endif
A drop-in replacement for Block<T*>.
Definition: Block.h:814
String: the storage and methods of handling collections of characters.
Definition: String.h:225
const PtrBlock< const WCRegion * > & regions() const
Get the contributing regions.
Definition: WCCompound.h:156
WCDifference(const PtrBlock< const ImageRegion * > &regions)
virtual String type() const
Get the region type.
WCDifference(const WCDifference &other)
Copy constructor (copy semantics).
virtual LCRegion * doToLCRegion(const CoordinateSystem &cSys, const IPosition &shape, const IPosition &pixelAxesMap, const IPosition &outOrder) const
Convert to an LCRegion using the given coordinate system and shape.
virtual TableRecord toRecord(const String &tableName) const
Convert the (derived) object to a record.
WCDifference(Bool takeOver, const PtrBlock< const WCRegion * > &regions)
Construct from multiple regions given as a Block.
WCDifference & operator=(const WCDifference &other)
Assignment (copy semantics).
WCDifference(const ImageRegion &region1, const ImageRegion &region2)
Construct the difference of one or more image regions.
static String className()
Get the class name (to store in the record).
static WCDifference * fromRecord(const TableRecord &, const String &tableName)
Convert correct object from a record.
virtual WCRegion * cloneRegion() const
Make a copy of the derived object.
virtual Bool operator==(const WCRegion &other) const
Comparison.
this file contains all the compiler specific defines
Definition: mainpage.dox:28
TableExprNode shape(const TableExprNode &array)
Function operating on any scalar or array resulting in a Double array containing the shape.
Definition: ExprNode.h:1987
bool Bool
Define the standard types used by Casacore.
Definition: aipstype.h:42