/usr/include/casacore/ms/MeasurementSets/StokesConverter.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 | //# StokesConverter.h: convert any set of polarizations into any other one
//# Copyright (C) 1997,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 MS_STOKESCONVERTER_H
#define MS_STOKESCONVERTER_H
#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/Vector.h>
#include <casacore/casa/Arrays/Matrix.h>
#include <casacore/casa/BasicSL/Complex.h>
#include <casacore/measures/Measures/Stokes.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary>
// StokesConverter converts any set of polarizations into any other one
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="yyyy/mm/dd" tests="tStokesConverter" demos="">
// </reviewed>
// <prerequisite>
// <li> <a href="StokesConverter.html"> Stokes </a>
// </prerequisite>
//
// <etymology>
// StokesConverter is a class that converts Stokes Parameters
// </etymology>
//
// <synopsis>
// This class is used to convert polarizations from one system to
// another.
// First the conversion wanted is specified and then large blocks of data
// can be converted.
// <example>
// <srcblock>
// // create converter
// StokesConverter sc;
// Vector<Int> out(7),in(4);
// // set the input polarizations
// in(0)=Stokes::RR;
// in(1)=Stokes::LL;
// in(2)=Stokes::RL;
// in(3)=Stokes::LR;
// // set the required output
// out(0)=Stokes::I;
// out(1)=Stokes::Q;
// out(2)=Stokes::U;
// out(3)=Stokes::V;
// out(4)=Stokes::Ptotal;
// out(5)=Stokes::Pangle;
// out(6)=Stokes::PFlinear;
// // initialize the conversion engine
// sc.setConversion(out,in);
// // set up some test data
// Vector<Complex> datain(4),dataout(7);
// datain(0)=1.0;
// datain(1)=0.9;
// datain(2)=0.3;
// datain(3)=0.2;
// // convert the data
// sc.convert(dataout,datain);
// </srcblock>
// </example>
// </synopsis>
//
// <motivation>
// Polarization conversion is needed in various places. It makes sense to
// provide all conversion in one place.
// </motivation>
//
// <thrown>
// <li>
// <li>
// </thrown>
//
// <todo asof="1997/10/09">
// <li> cope with incomplete input polarizations sensibly
// <li> decide what to do about factor 2 between I and RR/LL,XX/YY etc.
// </todo>
class StokesConverter
{
public:
// default constructor, does not set up a conversion
StokesConverter();
// Set up a conversion from in to out.
// The in and out vectors contain a list of polarization present/wanted
// in that order. The in vector should match the data to convert.
// (CORR_TYPE column in SPECTRAL_WINDOW table contains this info)
// The rescale option will correct for crosscorrelation data that
// has been scaled to the level Stokes I (common practice
// in radioastronomy: even though officially I=XX+YY, in practice
// we need to do I=(XX+YY)/2, set rescale to True to do the latter).
StokesConverter(const Vector<Int>& out, const Vector<Int>& in,
Bool rescale=False);
// desctructor
~StokesConverter();
// Copy constructor
StokesConverter(const StokesConverter& other);
// Assignment,
StokesConverter& operator=(const StokesConverter& other);
// Change or Set the conversion. Arguments are the same as for
// constructor above.
void setConversion(const Vector<Int>& out, const Vector<Int>& in,
Bool rescale = False);
// convert data, first dimension of input must match
// that of the input conversion vector used to set up the conversion.
// Output is resized as needed.
void convert(Array<Complex>& out, const Array<Complex>& in) const;
// convert flags, first dimension of input must match
// that of the input conversion vector used to set up the conversion.
// Output is resized as needed. All output depending on a flagged input
// will be flagged.
void convert(Array<Bool>& out, const Array<Bool>& in) const;
// convert weights, first dimension of input must match
// that of the input conversion vector used to set up the conversion.
// Output is resized as needed.
// Set sigma to True when converting sigma's using this routine.
void convert(Array<Float>& out, const Array<Float>& in,
Bool sigma=False) const;
// invert flags, first dimension of input must match
// that of the output conversion vector used to set up the conversion.
// Output is resized as needed. All output depending on a flagged input
// will be flagged. This does the inverse operation of convert, allowing
// flagging of converted data to be transferred back to the original data.
void invert(Array<Bool>& out, const Array<Bool>& in) const;
protected:
// initialize the polarization conversion matrix
void initConvMatrix();
private:
Vector<Int> in_p,out_p;
Bool rescale_p;
//# mutable because operator Matrix(Slice,Slice) doesn't have const version
mutable Matrix<Complex> conv_p;
mutable Matrix<Complex> iquvConv_p;
Bool doIQUV_p;
Matrix<Bool> flagConv_p;
Matrix<Float> wtConv_p;
Matrix<Complex> polConv_p;
};
} //# NAMESPACE CASACORE - END
#endif
|