Changeset 1106 for trunk


Ignore:
Timestamp:
08/03/06 10:28:39 (18 years ago)
Author:
mar637
Message:

added doxygen documentation

Location:
trunk/src
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/Logger.h

    r1104 r1106  
     1//
     2// C++ Interface: Logger
     3//
     4// Description:
     5//
     6//
     7// Author: Malte Marquarding <asap@atnf.csiro.au>, (C) 2005
     8//
     9// Copyright: See COPYING file that comes with this distribution
     10//
     11//
    112#ifndef ASAPLOGGER_H
    213#define ASAPLOGGER_H
  • trunk/src/STAsciiWriter.h

    r1030 r1106  
    4545
    4646namespace asap {
    47 
     47/**
     48 * A class to export a Scnatble to ASCII file(s)
     49 */
    4850class STAsciiWriter : public Logger {
    4951public:
  • trunk/src/STMath.h

    r1078 r1106  
    3030
    3131/**
    32 Mathmatical operations on Scantable objects
    33 
    34 @author Malte Marquarding
     32        * Mathmatical operations on Scantable objects
     33        * @author Malte Marquarding
    3534*/
    3635class STMath : private Logger {
    3736public:
    38 
     37        // typedef for long method name
    3938  typedef casa::InterpolateArray1D<casa::Double,
    4039                                   casa::Float>::InterpolationMethod imethod;
    4140
     41  // typedef for std::map
    4242  typedef std::map<std::string, imethod> imap;
    4343
     44/**
     45  * whether to operate on the given Scantable or return a new one
     46  * @param insitu the toggle for this behaviour
     47  */
    4448  STMath(bool insitu=true);
    4549
     
    4751
    4852  /**
    49    * set the @attr insitu attribute
    50    * @param b
     53   * get the currnt @attr inistu state
    5154   */
    5255  bool insitu() const { return insitu_;};
     56 
     57  /**
     58   * set the currnt @attr inistu state
     59   * @param b the new state
     60   */
    5361  void setInsitu(bool b) { insitu_ = b; };
    5462
     63
     64        /**
     65          * average a vector of Scantables
     66          * @param in the vector of Scantables to average
     67          * @param an optional mask to apply on specific weights
     68          * @param weight weighting scheme
     69          * @param avmode the mode ov averaging. Per "SCAN" or "ALL".
     70          * @return a casa::CountedPtr<Scantable> which either holds a new Scantable
     71          * or returns the imput pointer.
     72          */
    5573  casa::CountedPtr<Scantable>
    5674    average( const std::vector<casa::CountedPtr<Scantable> >& in,
     
    5977             const std::string& avmode = "SCAN");
    6078
     79        /**
     80          * median average a vector of Scantables. See also STMath::average
     81          * @param in the Scantable to average
     82          * @param mode the averaging mode. Currently only "MEDIAN"
     83          * @param avmode the mode ov averaging. Per "SCAN" or "ALL".
     84          * @return a casa::CountedPtr<Scantable> which either holds a new Scantable
     85          * or returns the imput pointer.
     86          */
    6187  casa::CountedPtr<Scantable>
    6288    averageChannel( const casa::CountedPtr<Scantable> & in,
     
    122148    rotateLinPolPhase( const casa::CountedPtr<Scantable>& in, float phase);
    123149
    124   /// @todo frequency alignment
    125 
    126150  casa::CountedPtr<Scantable>
    127151    swapPolarisations(const casa::CountedPtr<Scantable>& in);
Note: See TracChangeset for help on using the changeset viewer.