/usr/include/casacore/images/Images/SubImage.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 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 | //# SubImage.h: A (masked) subset of an ImageInterface object
//# Copyright (C) 1998,1999,2000,2001,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_SUBIMAGE_H
#define IMAGES_SUBIMAGE_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/images/Images/ImageInterface.h>
#include <casacore/casa/Arrays/AxesSpecifier.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class IPosition;
class LattRegionHolder;
class Slicer;
template <class T> class SubLattice;
template <class T> class Array;
class LatticeNavigator;
template <class T> class LatticeIterInterface;
class String;
// <summary>
// A (masked) subset of an ImageInterface object.
// </summary>
//
// <use visibility=export>
//
// <reviewed reviewer="" date="" tests="tSubImage.cc">
// </reviewed>
//
// <prerequisite>
// <li> <linkto class=ImageInterface>ImageInterface</linkto>
// <li> <linkto class=SubLattice>SubLattice</linkto>
// </prerequisite>
//
// <synopsis>
// Class SubImage has to be used to apply a region or mask to an image.
// Several functions are inherited from SubLattice and not declared
// in this class.
// <p>
// Using an <linkto class=AxesSpecifier>AxesSpecifier</linkto> object
// it is possible to remove some or all degenerate axes (i.e. axes
// with length 1) to get an image with a lower dimensionality.
// </synopsis>
//
// <example>
// <srcblock>
// </srcblock>
// </example>
//
// <motivation>
// </motivation>
//
// <todo asof="1998/02/09">
// </todo>
template <class T> class SubImage: public ImageInterface<T>
{
public:
// The default constructor
SubImage();
// Create a SubImage from a Image.
// This results in a SubImage without a real mask.
// <br>The "const Image" version yields a non-writable SubImage,
// while for the non-const version one has to specify if the SubImage
// should be writable (if the original image is non-writable, the
// SubImage is always set to non-writable).
// <br>If preserveAxesOrder is True, the axes order will be preserved. This
// is only important in cases where pixel axes are to be dropped, if not
// the axes order will be preserved. If False and pixel axes are dropped,
// the order of the coordinates will be preserved, but not necessarily
// the axes.
// <group>
SubImage (const ImageInterface<T>& image,
AxesSpecifier=AxesSpecifier(), Bool preserveAxesOrder=False);
SubImage (ImageInterface<T>& image, Bool writableIfPossible,
AxesSpecifier=AxesSpecifier(), Bool preserveAxesOrder=False);
// </group>
// Create a SubImage from the given Image and region.
// <br>An exception is thrown if the image shape used in the region
// differs from the shape of the image.
// <group>
SubImage (const ImageInterface<T>& image, const LattRegionHolder& region,
AxesSpecifier=AxesSpecifier(), Bool preserveAxesOrder=False);
SubImage (ImageInterface<T>& image, const LattRegionHolder& region,
Bool writableIfPossible,
AxesSpecifier=AxesSpecifier(), Bool preserveAxesOrder=False);
// </group>
// Create a SubImage from the given Image and slicer.
// The slicer can be strided.
// <br>An exception is thrown if the slicer exceeds the image shape.
// <group>
SubImage (const ImageInterface<T>& image, const Slicer& slicer,
AxesSpecifier=AxesSpecifier(), Bool preserveAxesOrder=False);
SubImage (ImageInterface<T>& image, const Slicer& slicer,
Bool writableIfPossible,
AxesSpecifier=AxesSpecifier(), Bool preserveAxesOrder=False);
// </group>
// Copy constructor (reference semantics).
SubImage (const SubImage<T>& other);
virtual ~SubImage();
// Assignment (reference semantics).
SubImage<T>& operator= (const SubImage<T>& other);
// Make a copy of the object (reference semantics).
// <group>
virtual ImageInterface<T>* cloneII() const;
// </group>
// Get the image type (returns name of derived class).
virtual String imageType() const;
// Is the SubImage masked?
// It is if its parent image or its region is masked.
virtual Bool isMasked() const;
// Does the image object have a pixelmask?
// It does if its parent has a pixelmask.
virtual Bool hasPixelMask() const;
// Get access to the pixelmask in use (thus to the pixelmask of the parent).
// An exception is thrown if the parent does not have a pixelmask.
// <group>
virtual const Lattice<Bool>& pixelMask() const;
virtual Lattice<Bool>& pixelMask();
// </group>
// A SubImage is persistent if no region is applied to the parent image.
// That is true if the region has the same shape as the parent image
// and the region has no mask.
virtual Bool isPersistent() const;
// Is the SubImage paged to disk?
virtual Bool isPaged() const;
// Can the lattice data be referenced as an array section?
virtual Bool canReferenceArray() const;
// Is the SubImage writable?
virtual Bool isWritable() const;
// Get the region/mask object describing this subImage.
virtual const LatticeRegion* getRegionPtr() const;
// Returns the shape of the SubImage including all degenerate axes
// (i.e. axes with a length of one).
virtual IPosition shape() const;
// Returns the number of axes in this SubImage. This includes all
// degenerate axes.
virtual uInt ndim() const;
// Returns the total number of elements in this SubImage.
virtual size_t nelements() const;
// returns a value of "True" if this instance of Lattice and 'other' have
// the same shape, otherwise returns a value of "False".
virtual Bool conform (const Lattice<T>& other) const;
// This function returns the recommended maximum number of pixels to
// include in the cursor of an iterator.
virtual uInt advisedMaxPixels() const;
// Get access to the attribute handler (of the parent image).
// If a handler keyword does not exist yet, it is created if
// <src>createHandler</src> is set.
// Otherwise the handler is empty and no groups can be created for it.
virtual ImageAttrHandler& attrHandler (Bool createHandler=False);
// Get or put a single element in the lattice.
// <group>
virtual T getAt (const IPosition& where) const;
virtual void putAt (const T& value, const IPosition& where);
// </group>
// Function which changes the shape of the SubImage.
// Throws an exception as resizing a SubImage is not possible.
virtual void resize(const TiledShape& newShape);
// Return the name of the parent ImageInterface object.
virtual String name (Bool stripPath=False) const;
// Check class invariants.
virtual Bool ok() const;
// Do the actual getting of an array of values.
virtual Bool doGetSlice (Array<T>& buffer, const Slicer& section);
// Do the actual getting of an array of values.
virtual void doPutSlice (const Array<T>& sourceBuffer,
const IPosition& where,
const IPosition& stride);
// Get a section of the mask.
virtual Bool doGetMaskSlice (Array<Bool>& buffer, const Slicer& section);
// This function is used by the LatticeIterator class to generate an
// iterator of the correct type for this Lattice. Not recommended
// for general use.
virtual LatticeIterInterface<T>* makeIter
(const LatticeNavigator& navigator,
Bool useRef) const;
// Get the best cursor shape.
virtual IPosition doNiceCursorShape (uInt maxPixels) const;
// Handle the (un)locking and syncing, etc.
// <group>
virtual Bool lock (FileLocker::LockType, uInt nattempts);
virtual void unlock();
virtual Bool hasLock (FileLocker::LockType) const;
virtual void resync();
virtual void flush();
virtual void tempClose();
virtual void reopen();
// </group>
private:
// Set the coordinates.
// It removes world axes if the subimage has axes removed.
// <br>If preserveAxesOrder is True and axes are dropped, it will preserve
// the order of the axes as well as the order of the coordinates.
void setCoords (const CoordinateSystem& coords, Bool preserveAxesOrder);
void setCoords (const CoordinateSystem& coords);
// Set the other members to the one in itsImagePtr.
void setMembers();
// Set the members to the subset (in particular, the beamset).
void setMembers (const Slicer& slicer);
// Helper
void convertIPosition(Vector<Float>& x, const IPosition& pos) const;
//# itsImagePtr points to the parent image.
ImageInterface<T>* itsImagePtr;
SubLattice<T>* itsSubLatPtr;
//# Make members of parent class known.
public:
using ImageInterface<T>::logger;
protected:
using ImageInterface<T>::setCoordsMember;
};
//# Declare extern templates for often used types.
#ifdef AIPS_CXX11
extern template class SubImage<Float>;
extern template class SubImage<Complex>;
#endif
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/images/Images/SubImage.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|