/usr/include/casacore/casa/Arrays/AxesMapping.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 | //# AxesMapping.h: Info about mapping array axes to another order
//# Copyright (C) 2000,2001
//# 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 CASA_AXESMAPPING_H
#define CASA_AXESMAPPING_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/IPosition.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class Slicer;
// <summary>
// Info about mapping array axes to another order.
// </summary>
// <use visibility=local>
// <reviewed reviewer="" date="yyyy/mm/dd" tests="tAxesSpecifier.cc" demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class="IPosition">IPosition</linkto>
// <li> <linkto class="AxesSpecifier">AxesSpecifier</linkto>
// </prerequisite>
// <synopsis>
// AxesMapping holds the information about mapping axes to another order.
// It can be constructed by <linkto class=AxesSpecifier>AxesSpecifier</linkto>
// by applying a shape to the axes specification.
// <br>AxesMapping is thereafter used to map positions, shapes, and
// slices to the new axes or backwards.
// <note role=caution>
// Shapes and positions are both represented by class IPosition.
// However, they have to be treated differently in this class,
// because removed axes for a position have value 0, while for a
// shape they have value 1. Hence there are different functions for them
// and the user has to take care that the correct function is called.
// </note>
// </synopsis>
// <example>
// <srcblock>
//
// </srcblock>
// </example>
// <motivation>
// The class encapsulates the mapping functionality.
// It is meant as a helper class for
// <linkto class=SubLattice>SubLattice</linkto>.
// </motivation>
//# <todo asof="yyyy/mm/dd">
//# </todo>
class AxesMapping
{
public:
// The default constructor creates empty maps.
AxesMapping();
// Construct it with the mapping from old to new axes order.
// A value of -1 means that the old axes is ignored in the new one.
// Another value gives the new axis number.
// <br>It determines if axes are removed and/or reordered.
explicit AxesMapping (const IPosition& oldToNew);
// Copy constructor (copy semantics).
AxesMapping(const AxesMapping& other);
~AxesMapping();
// Assignment (copy semantics).
// This and that do not have to have the same length.
AxesMapping& operator= (const AxesMapping& other);
// Are axes removed?
Bool isRemoved() const
{ return itsRemoved; }
// Is the axes order reordered?
Bool isReordered() const
{ return itsReordered; }
// Get the mapping of old->new.
// The length of the resulting IPosition is the dimensionality of
// the original lattice. A value of -1 indicates that the corresponding
// axis in the original lattice is removed.
// Another value is the axis number in the new lattice,
const IPosition& getToNew() const
{ return itsToNew; }
// Get the mapping of new->old.
// The length of the resulting IPosition is the dimensionality of
// the new lattice. Its values give the axes in the original lattice.
const IPosition& getToOld() const
{ return itsToOld; }
// Map an old position to the new one.
// In debug-mode it checks if the removed axes have position 0
// in the input position.
IPosition posToNew (const IPosition& pos) const;
// Map a new position or shape to the old one.
IPosition posToOld (const IPosition& pos) const;
// Map an old shape to the new one.
// In debug-mode it checks if the removed axes have length 1
// in the input shape.
IPosition shapeToNew (const IPosition& shape) const;
// Map a new position or shape to the old one.
IPosition shapeToOld (const IPosition& shape) const;
// Map an old shape to the new one.
// In debug-mode it checks if the removed axes have length 1
// in the input slicer.
Slicer slicerToNew (const Slicer& slicer) const;
// Map a new position or shape to the old one.
Slicer slicerToOld (const Slicer& slicer) const;
private:
IPosition itsToNew;
IPosition itsToOld;
Bool itsRemoved;
Bool itsReordered;
};
} //# NAMESPACE CASACORE - END
#endif
|