source: trunk/src/MathUtils.h@ 1028

Last change on this file since 1028 was 861, checked in by mar637, 19 years ago

added documentation

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.7 KB
Line 
1//#---------------------------------------------------------------------------
2//# MathUtilities.h: General math operations
3//#---------------------------------------------------------------------------
4//# Copyright (C) 2004
5//# ATNF
6//#
7//# This program is free software; you can redistribute it and/or modify it
8//# under the terms of the GNU General Public License as published by the Free
9//# Software Foundation; either version 2 of the License, or (at your option)
10//# any later version.
11//#
12//# This program is distributed in the hope that it will be useful, but
13//# WITHOUT ANY WARRANTY; without even the implied warranty of
14//# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
15//# Public License for more details.
16//#
17//# You should have received a copy of the GNU General Public License along
18//# with this program; if not, write to the Free Software Foundation, Inc.,
19//# 675 Massachusetts Ave, Cambridge, MA 02139, USA.
20//#
21//# Correspondence concerning this software should be addressed as follows:
22//# Internet email: Malte.Marquarding@csiro.au
23//# Postal address: Malte Marquarding,
24//# Australia Telescope National Facility,
25//# P.O. Box 76,
26//# Epping, NSW, 2121,
27//# AUSTRALIA
28//#
29//# $Id:
30//#---------------------------------------------------------------------------
31#ifndef MATHUTILS_H
32#define MATHUTILS_H
33
34#include <string>
35#include <vector>
36#include <casa/aips.h>
37#include <casa/Arrays/Vector.h>
38#include <casa/BasicSL/String.h>
39
40namespace mathutil {
41
42// Hanning smoothing
43template <class T>
44/**
45 * Hanning smooth a masked vector
46 * @param out the smoothed vector
47 * @param outmask the smoothed mask
48 * @param in the input vector
49 * @param mask the input mask
50 * @param relaxed a weighting scheme
51 * @param ignoreOther drop every second channel (NYI)
52 */
53void hanning(casa::Vector<T>& out, casa::Vector<casa::Bool>& outmask,
54 const casa::Vector<T>& in, const casa::Vector<casa::Bool>& mask,
55 casa::Bool relaxed=casa::False,
56 casa::Bool ignoreOther=casa::False);
57
58// Generate specified statistic
59float statistics(const casa::String& which,
60 const casa::MaskedArray<casa::Float>& data);
61
62// Replace masked value by zero
63void replaceMaskByZero(casa::Vector<casa::Float>& data,
64 const casa::Vector<casa::Bool>& mask);
65
66/**
67 * Convert a std::vector of std::string
68 * to a casa::Vector casa::String
69 * @param in
70 * @return
71 */
72std::vector<std::string> tovectorstring(const casa::Vector<casa::String>& in);
73
74/**
75 * Convert a casa::Vector of casa::String
76 * to a stl std::vector of stl std::string
77 * @param in
78 * @return
79 */
80casa::Vector<casa::String> toVectorString(const std::vector<std::string>& in);
81
82};
83
84#endif
Note: See TracBrowser for help on using the repository browser.