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
|
//# LCBox.h: Class to define a rectangular box of interest
//# Copyright (C) 1997,1998,1999
//# 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_LCBOX_H
#define LATTICES_LCBOX_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/lattices/LRegions/LCRegionFixed.h>
#include <casacore/casa/Arrays/Slicer.h>
#include <casacore/casa/Arrays/Vector.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary>
// Class to define a rectangular box of interest.
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="" tests="">
// </reviewed>
// <prerequisite>
// <li> <linkto class=LCRegion>LCRegion</linkto>
// </prerequisite>
// <synopsis>
// The LCBox class is a specialization of class
// <linkto class=LCRegion>LCRegion</linkto>.
// It makes it possible to define a rectangular region of interest.
// </synopsis>
// <example>
// <srcblock>
// </srcblock>
// </example>
// <todo asof="1997/11/11">
// </todo>
class LCBox: public LCRegionFixed
{
public:
LCBox();
// Construct a box for the full lattice shape.
explicit LCBox (const IPosition& latticeShape);
// Construct from the Slicer defining the box.
// The slicer may not contain a stride.
LCBox (const Slicer& box, const IPosition& latticeShape);
// Construct from the IPosition's defining the bottom-left and
// top-right corner of the box.
LCBox (const IPosition& blc, const IPosition& trc,
const IPosition& latticeShape);
// Construct from the Vector's defining the bottom-left and
// top-right corner of the box.
// <group>
LCBox (const Vector<Float>& blc, const Vector<Float>& trc,
const IPosition& latticeShape);
LCBox (const Vector<Double>& blc, const Vector<Double>& trc,
const IPosition& latticeShape);
// </group>
// Copy constructor (reference semantics).
LCBox (const LCBox& other);
virtual ~LCBox();
// Assignment (copy semantics).
LCBox& operator= (const LCBox& other);
// Comparison. Mask not checked. Use function
// LRegionSingle::maskEqual to do this
virtual Bool operator== (const LCRegion& other) const;
// Make a copy of the derived object.
virtual LCRegion* cloneRegion() const;
// Get the class name (to store in the record).
static String className();
// Get the region type. Returns className()
virtual String type() const;
// Convert the (derived) object to a record.
virtual TableRecord toRecord (const String& tableName) const;
// Convert correct object from a record.
static LCBox* fromRecord (const TableRecord&,
const String& tablename);
// Get the box blc
Vector<Float> blc() const;
// Get the box trc
Vector<Float> trc() const;
// Verify a box specification. Illegal (inlcuding blc > trc) or
// unspecified values are given 0 (blc) shape (trc) or
// unity (inc). Returns <src>True</src> if any of the blc/trc/inc
// are changed from their input values, else returns <src>False</src>
static Bool verify (IPosition& blc, IPosition& trc,
IPosition& inc, const IPosition& shape);
protected:
// Construct another LCBox (for e.g. another lattice) by moving
// this one. It recalculates the bounding box.
// A positive translation value indicates "to right".
virtual LCRegion* doTranslate (const Vector<Float>& translateVector,
const IPosition& newLatticeShape) const;
private:
// Make a box from the blc,trc such that it does not exceed the
// lattice boundaries.
void setSlicerBox (const IPosition& blc, const IPosition& trc);
// Fill the blc and trc vector from IPositions.
void fillBlcTrc();
//# Variables
Vector<Float> itsBlc;
Vector<Float> itsTrc;
};
inline Vector<Float> LCBox::blc() const
{
return itsBlc;
}
inline Vector<Float> LCBox::trc() const
{
return itsTrc;
}
} //# NAMESPACE CASACORE - END
#endif
|
