/usr/include/casacore/images/Images/ExtendImage.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 | //# ExtendImage.h: An extension of an ImageInterface object
//# Copyright (C) 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: ExtendImage.h 21538 2015-01-07 09:08:57Z gervandiepen $
#ifndef IMAGES_EXTENDIMAGE_H
#define IMAGES_EXTENDIMAGE_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/images/Images/ImageInterface.h>
#include <casacore/casa/Utilities/PtrHolder.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
template <class T> class ExtendLattice;
// <summary>
// An extension of an ImageInterface object.
// </summary>
//
// <use visibility=export>
//
// <reviewed reviewer="" date="" tests="tExtendImage.cc">
// </reviewed>
//
// <prerequisite>
// <li> <linkto class=ImageInterface>ImageInterface</linkto>
// <li> <linkto class=ExtendLattice>ExtendLattice</linkto>
// </prerequisite>
//
// <synopsis>
// Class ExtendImage can be used to (virtually) extend an image
// along axes with length 1 and/or to add new axes. In this way such
// an image can be made conformant with another image.
// E.g. it can be used to extend the continuum channel to
// subtract it from each channel in an image cube.
// </synopsis>
//
// <example>
// <srcblock>
// </srcblock>
// </example>
//
// <motivation>
// Used by LEL to handle images with different dimensionalities.
// </motivation>
//
//# <todo asof="1998/02/09">
//# </todo>
template <class T> class ExtendImage: public ImageInterface<T>
{
public:
// The default constructor
ExtendImage();
// Create a ExtendImage from a Image.
// The coordinate system of the given image should be a subset of the
// new coordinate system. The same is true for the shape.
ExtendImage (const ImageInterface<T>& image,
const IPosition& newShape,
const CoordinateSystem& newCsys);
// Copy constructor (reference semantics).
ExtendImage (const ExtendImage<T>& other);
virtual ~ExtendImage();
// Assignment (reference semantics).
ExtendImage<T>& operator= (const ExtendImage<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 ExtendImage masked?
// It is if its parent image 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>
// Get the region used (always returns 0).
virtual const LatticeRegion* getRegionPtr() const;
// A ExtendImage is not persistent.
virtual Bool isPersistent() const;
// Is the ExtendImage paged to disk?
virtual Bool isPaged() const;
// An ExtendImage is not writable
virtual Bool isWritable() const;
// Returns the shape of the ExtendImage
virtual IPosition shape() const;
// This function returns the recommended maximum number of pixels to
// include in the cursor of an iterator.
virtual uInt advisedMaxPixels() const;
// Function which changes the shape of the ExtendImage.
// Throws an exception as resizing an ExtendImage 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;
// 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);
// Do the actual getting of an array of values.
virtual Bool doGetSlice (Array<T>& buffer, const Slicer& section);
// Putting data is not possible.
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:
//# itsImagePtr points to the parent image.
PtrHolder<ImageInterface<T> > itsImagePtr;
PtrHolder<ExtendLattice<T> > itsExtLatPtr;
//# Make members of parent class known.
public:
using ImageInterface<T>::logger;
protected:
using ImageInterface<T>::setCoordsMember;
};
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/images/Images/ExtendImage.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|