casacore
ms
MeasurementSets
MSDopplerUtil.h
Go to the documentation of this file.
1
//# MSDopplerUtil.h: utility class for MS Doppler tracking information
2
//# Copyright (C) 2000,2003
3
//# Associated Universities, Inc. Washington DC, USA.
4
//#
5
//# This library is free software; you can redistribute it and/or modify it
6
//# under the terms of the GNU Library General Public License as published by
7
//# the Free Software Foundation; either version 2 of the License, or (at your
8
//# option) any later version.
9
//#
10
//# This library is distributed in the hope that it will be useful, but WITHOUT
11
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13
//# License for more details.
14
//#
15
//# You should have received a copy of the GNU Library General Public License
16
//# along with this library; if not, write to the Free Software Foundation,
17
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
18
//#
19
//# Correspondence concerning AIPS++ should be addressed as follows:
20
//# Internet email: aips2-request@nrao.edu.
21
//# Postal address: AIPS++ Project Office
22
//# National Radio Astronomy Observatory
23
//# 520 Edgemont Road
24
//# Charlottesville, VA 22903-2475 USA
25
//#
26
//# $Id$
27
28
#ifndef MS_MSDOPPLERUTIL_H
29
#define MS_MSDOPPLERUTIL_H
30
31
#include <casacore/casa/aips.h>
32
#include <casacore/ms/MeasurementSets/MeasurementSet.h>
33
34
namespace
casacore
{
//# NAMESPACE CASACORE - BEGIN
35
36
// <summary>
37
// A utility class for MS Doppler tracking information
38
// </summary>
39
//
40
// <use visibility=export>
41
//
42
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
43
// </reviewed>
44
45
// <prerequisite>
46
// <li> MeasurementSet
47
// <li> MSDoppler
48
// </prerequisite>
49
//
50
// <etymology>
51
// From "MeasurementSet", "Doppler" and "utility".
52
// </etymology>
53
//
54
// <synopsis>
55
// This class provides utilities for handling Doppler tracking
56
// information in a MeasurementSet.
57
// </synopsis>
58
//
59
// <example>
60
// </example>
61
//
62
// <motivation>
63
// Collect all utilities for handling MS Doppler tracking information.
64
// </motivation>
65
//
66
// <thrown>
67
// <li>
68
// <li>
69
// </thrown>
70
//
71
// <todo asof="2000/09/01">
72
// <li> averaging over other indices.
73
// </todo>
74
75
class
MSDopplerUtil
76
{
77
public
:
78
// Construct from an existing MeasurementSet
79
MSDopplerUtil
(
const
MeasurementSet
& ms);
80
81
// Null destructor
82
~MSDopplerUtil
();
83
84
// Retrieve a list of all rest frequencies used for a given
85
// spectral window id and field id.
86
// Note that the output vector combines information for multiple spectral lines
87
// and (unlikely) multiple source table entries.
88
// If the doppler sub table doesn't exist, the information is
89
// retrieved from directly from the source sub table.
90
Bool
dopplerInfo
(
Vector<Double>
& restFrequency,
Int
spwId,
Int
fieldId);
91
92
private
:
93
// Prohibit null constructor, copy constructor and assignment for now
94
MSDopplerUtil
();
95
MSDopplerUtil
&
operator=
(
const
MSDopplerUtil
&);
96
MSDopplerUtil
(
const
MSDopplerUtil
&);
97
98
// Underlying MeasurementSet
99
MeasurementSet
ms_p
;
100
};
101
102
103
}
//# NAMESPACE CASACORE - END
104
105
#endif
106
107
casacore::MSDopplerUtil::ms_p
MeasurementSet ms_p
Underlying MeasurementSet.
Definition:
MSDopplerUtil.h:99
casacore::MSDopplerUtil::MSDopplerUtil
MSDopplerUtil(const MeasurementSet &ms)
Construct from an existing MeasurementSet.
casacore::MSDopplerUtil::~MSDopplerUtil
~MSDopplerUtil()
Null destructor.
casacore::MSDopplerUtil
Definition:
MSDopplerUtil.h:76
casacore::MSDopplerUtil::dopplerInfo
Bool dopplerInfo(Vector< Double > &restFrequency, Int spwId, Int fieldId)
Retrieve a list of all rest frequencies used for a given spectral window id and field id.
casacore::Int
int Int
Definition:
aipstype.h:50
casacore
this file contains all the compiler specific defines
Definition:
mainpage.dox:28
casacore::MSDopplerUtil::MSDopplerUtil
MSDopplerUtil()
Prohibit null constructor, copy constructor and assignment for now.
casacore::MSDopplerUtil::operator=
MSDopplerUtil & operator=(const MSDopplerUtil &)
casacore::MSDopplerUtil::MSDopplerUtil
MSDopplerUtil(const MSDopplerUtil &)
casacore::MeasurementSet
Definition:
MeasurementSet.h:243
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition:
aipstype.h:42
casacore::Vector< Double >
Generated by
1.8.20