Changeset 1104 for trunk


Ignore:
Timestamp:
08/02/06 14:58:50 (18 years ago)
Author:
mar637
Message:

added doxygen documentation

Location:
trunk/src
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/Logger.h

    r1102 r1104  
    3333  /**
    3434   * push another message into the logger
    35    * @param[in] the message
    36    * @param[in] whether to add a newline character at the end
     35   * @param[in] s the message
     36   * @param[in] newline whether to add a newline character at the end
    3737   */ 
    3838  void pushLog(const std::string& s, bool newline=true) const;
    3939  /**
    4040   * pop the message form the logger
    41    * @returns the log message string
     41   * @return the log message string
    4242   */ 
    4343  std::string popLog() const;
  • trunk/src/RowAccumulator.h

    r831 r1104  
    1717
    1818namespace asap {
    19 
     19/**
     20  * This class accumulates spectra and weights and returns the averaged data
     21  * @brief Class for averaging of spectra
     22  * @author Malte Marquarding
     23  * @date $Date:$
     24  * @version
     25  */
    2026class RowAccumulator {
    21 
    2227
    2328public:
    2429
     30  /**
     31   * Constructor taking a weight type as defined in @ref STDefs
     32   */
    2533  RowAccumulator(WeightType wt = asap::NONE);
    2634
    2735 ~RowAccumulator();
    2836
     37        /**
     38         * add a new "row" to the accumulator
     39         * @param v the spectrum
     40         * @param m the mask for the spectrum
     41         * @param tsys the Tsys corresponing to the spectrum
     42         * @param interval the intergration time
     43         * @param the time of the observation
     44         */
    2945  void add(const casa::Vector<casa::Float>& v,
    3046           const casa::Vector<casa::Bool>& m,
     
    3248           casa::Double interval,
    3349           casa::Double time);
    34 
     50        /**
     51         * Also set a user mask which get combined with the individual masks
     52         * from the spectra
     53         * @param m a boolean mask of teh same length as the spectrum
     54         */
    3555  void setUserMask(const casa::Vector<casa::Bool>& m);
    36 
     56        /**
     57         * Get the spectrum. Applies the normalisation (averaging)
     58         * @return the spectrum vector
     59         */
    3760  casa::Vector<casa::Float> getSpectrum() const;
     61        /**
     62         * Get the Tsys. Applies the normalisation (averaging)
     63         * @return the Tsys vector
     64         */
    3865  casa::Vector<casa::Float> getTsys() const;
     66        /**
     67         * Get the spectrum's mask. Applies the normalisation (averaging)
     68         * @return the mask vector
     69         */
    3970  casa::Vector<casa::Bool> getMask() const;
    40 
     71        /**
     72         * Get the total interval.
     73         * @return the integration time
     74         */
    4175  casa::Double getInterval() const;
     76        /**
     77         * Get the time of the observation. Retrieves the "mean" time.
     78         * @return the integration time
     79         */ 
    4280  casa::Double getTime() const;
    43 
     81        /**
     82         * Reset the acummulator to the state at construction.
     83         */
    4484  void reset();
    4585
     
    5595  WeightType weightType_;
    5696  casa::Bool initialized_;
    57   //these are a Vector
     97  //these are Vectors
    5898  casa::MaskedArray<casa::Float> spectrum_;
    5999  casa::MaskedArray<casa::Float> n_, weightSum_;
  • trunk/src/Scantable.h

    r1068 r1104  
    9090  /**
    9191   * get a const reference to the underlying casa::Table
    92    * @return consantcasa::Table reference
     92   * @return const \ref casa::Table reference
    9393   */
    9494  const casa::Table& table() const;
     
    146146
    147147  /**
    148    * return the number of scans in the table
     148   * The number of scans in the table
    149149   * @return number of scans in the table
    150150   */
     
    159159  casa::MPosition getAntennaPosition() const;
    160160
     161        /**
     162         * the @ref casa::MDirection for a specific row
     163         * @param[in] whichrow the row number
     164         * return casa::MDirection
     165         */
    161166  casa::MDirection getDirection( int whichrow ) const;
    162167
     168        /**
     169         * get the direction type as a string, e.g. "J2000"
     170         * @param[in] whichrow the row number
     171         * return the direction string
     172         */
    163173  std::string getDirectionString( int whichrow ) const;
    164174
     175        /**
     176         * set the direction type as a string, e.g. "J2000"
     177         * @param[in] the direction type
     178         */     
    165179  void setDirectionRefString(const std::string& refstr="");
    166 
    167   std::string getDirectionRefString() const;
     180  /**
     181   * get the direction reference string
     182   * @return a string describing the direction reference
     183   */
     184  std::string getDirectionRefString() const;    /**
     185         * get the direction type as a string, e.g. "J2000"
     186         * param[in] whichrow the row number
     187         * return the direction string
     188         */
     189 
    168190
    169191  /**
     
    192214  /**
    193215   * "hard" flag the data, this flags everything selected in setSelection()
     216   * param[in] msk a boolean mask of length nchan describing the points to
     217   * to be flagged
    194218   */
    195219  void flag( const std::vector<bool>& msk = std::vector<bool>());
     
    239263   * @param scanno the scan number to get the number of rows for.
    240264   * If scanno<0 the number is retrieved from the header.
    241    * @return
     265   * @return the number of rows (for the specified scanno)
    242266   */
    243267  int nrow(int scanno=-1) const;
Note: See TracChangeset for help on using the changeset viewer.