Changeset 861 for trunk/src

Timestamp:

03/01/06 14:00:32 (19 years ago)

Author:

mar637

Message:

added documentation

File:

• trunk/src/MathUtils.h (modified) (2 diffs)

trunk/src/MathUtils.h

@@ -42 +42 @@
 // Hanning smoothing
 template <class T>
+/**
+ * Hanning smooth a masked vector
+ * @param out the smoothed vector
+ * @param outmask  the smoothed mask
+ * @param in the input vector
+ * @param mask the input mask
+ * @param relaxed a weighting scheme
+ * @param ignoreOther drop every second channel (NYI)
+ */
 void hanning(casa::Vector<T>& out, casa::Vector<casa::Bool>& outmask,
              const casa::Vector<T>& in, const casa::Vector<casa::Bool>& mask,
@@ -55 +64 @@
                        const casa::Vector<casa::Bool>& mask);
 
+/**
+ * Convert a std::vector of std::string
+ * to a casa::Vector casa::String
+ * @param in
+ * @return
+ */
 std::vector<std::string> tovectorstring(const casa::Vector<casa::String>& in);
 
+/**
+ * Convert a casa::Vector of casa::String
+ * to a stl std::vector of stl std::string
+ * @param in
+ * @return
+ */
 casa::Vector<casa::String> toVectorString(const std::vector<std::string>& in);