Changeset 909 in Sophya for trunk/SophyaLib/SkyT/radspec.cc


Ignore:
Timestamp:
Apr 13, 2000, 4:10:46 PM (25 years ago)
Author:
ansari
Message:

Sophie: adding documentation for Doxygen in the .cc files:wq

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SophyaLib/SkyT/radspec.cc

    r668 r909  
    11//--------------------------------------------------------------------------
    22// File and Version Information:
    3 //      $Id: radspec.cc,v 1.3 1999-11-29 14:16:06 ansari Exp $
     3//      $Id: radspec.cc,v 1.4 2000-04-13 14:10:44 ansari Exp $
    44//
    55// Description:
     
    2323#include "integ.h"
    2424
     25/*!
     26 * \class SOPHYA::RadSpectra <BR>
     27 * This class is an abstract base class for radiation emission spectra. The flux() function returns the value of the flux (the spectral      <BR>
     28 * energy distribution) as a function of the frequency.  As in the SpectralResponse class, the () operator has been redefined <BR>
     29 * at this level, so that the user can access the flux value, either by  calling the function or directly by using this operator. <BR>
     30 * For all the sub-classes, \nu is given in units of Hz and
     31 * the flux is returned in units of W/m^2/sr/Hz.
     32*/
     33
     34
    2535//----------------
    2636// Constructor --
    2737//----------------
     38/*! Default constructor */
     39/*!
     40  The constructor takes as an argument the minimum
     41  and the maximum frequency of the spectrum, if any. <BR>
     42  In the case the user does not want to specify these
     43  values, there are set respectively to 0. and 9.E49
     44  by default.
     45*/
    2846RadSpectra::RadSpectra(double numin, double numax)
    2947{
     
    6482
    6583
    66 
    67 // peakFreq returns the value of the frequency for the
    68 // peak of the spectrum.
     84/*
     85   The peakFreq() function returns the value of the
     86   frequency for the maximum value of the flux
     87*/
    6988double
    7089RadSpectra::peakFreq()  const
     
    85104}
    86105
    87 // To change min-max frequency
    88106void
    89107RadSpectra::setMinMaxFreq(double numin, double numax)
     
    100118   return(_raypourfinteg->flux(nu));   
    101119}
    102 
     120/*!
     121  The integratedFlux() function performs the integration
     122  of the flux function in a frequency range <BR> defined by
     123  f1 and f2.
     124*/
    103125double
    104126RadSpectra::integratedFlux(double f1, double f2)  const
    105127{
    106 //   cout << endl;
    107 //   cout <<  this->minFreq() << " = " << this->maxFreq() << endl;
    108 //   cout <<  f1 << " = " << f2 << endl;
    109128  if(f1 < this->minFreq()) f1 = this->minFreq();
    110129  if(f2 > this->maxFreq()) f2 = this->maxFreq();
     
    115134  return(val);       
    116135}
     136
     137/*!
     138  Same than integratedFlux() over the frequency range
     139  of definition of the flux function
     140 */
    117141double
    118142RadSpectra::integratedFlux()  const
     
    131155}
    132156
     157/*!
     158  The logIntegratedFlux() function performs the integration
     159  of the flux function in a frequency range <BR> defined by
     160  f1 and f2. The integration is here performed
     161  on the logarithm of the flux function.
     162*/
    133163double
    134164RadSpectra::logIntegratedFlux(double f1, double f2)  const
     
    148178}
    149179
     180/*!
     181  same than logIntegratedFlux over the frequency range
     182  of definition of the flux function
     183 */
    150184double
    151185RadSpectra::logIntegratedFlux()  const
     
    163197}
    164198
    165 
     199/*!
     200  The filteredIntegratedFlux() function performs the integration
     201  of the flux function in a frequency range <BR> defined by
     202  f1 and f2 convolved by a SpectralResponse filter.
     203*/
    166204double
    167205RadSpectra::filteredIntegratedFlux(SpectralResponse const& filter, double f1, double f2) const
     
    179217}
    180218
     219/*!
     220  Same than filteredIntegratedFlux() over the frequency range
     221  defined as: <BR>
     222   min_freq = MAX(minfreq_flux, minfreq_filter), <BR>
     223   max_freq = MIN(maxfreq_flux, maxfreq_filter), <BR>
     224  where:
     225<UL> 
     226<LI>   minfreq_flux   is the minimum frequency of the flux definition
     227<LI>   maxfreq_flux   is the maximum frequency of the flux definition
     228<LI>   minfreq_filter is the minimum frequency of the filter definition
     229<LI>   maxfreq_filter is the maximum frequency of the filter definition
     230  </UL>
     231 */
    181232double
    182233RadSpectra::filteredIntegratedFlux(SpectralResponse const& filter)
     
    201252
    202253
     254/*!
     255 *  The filteredIntegratedFlux() function performs the integration
     256 * of the flux function in a frequency range <BR> defined by
     257 * f1 and f2 convolved by a SpectralResponse filter (using the
     258 * logarithm of the function).
     259 */
    203260double
    204261RadSpectra::filteredLogIntFlux(SpectralResponse const& filter, double f1, double f2) const
Note: See TracChangeset for help on using the changeset viewer.