Changeset 909 in Sophya for trunk/SophyaLib/SkyT


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

Location:
trunk/SophyaLib/SkyT
Files:
10 edited

Legend:

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

    r669 r909  
    11//--------------------------------------------------------------------------
    22// File and Version Information:
    3 //      $Id: blackbody.cc,v 1.4 1999-11-29 16:59:09 ansari Exp $
     3//      $Id: blackbody.cc,v 1.5 2000-04-13 14:10:43 ansari Exp $
    44//
    55// Description:
     
    2020#include "blackbody.h"
    2121
     22/*!
     23 * \class SOPHYA::BlackBody <BR>
     24 This class corresponds to the emission spectrum of a
     25 blackbody radiation.
     26 */
    2227//----------------
    2328// Constructor --
    2429//----------------
     30/*! Constructor: needs a temperature. Otherwise set to ConvTools::tcmb */
    2531BlackBody::BlackBody(double temperature)
    2632  : RadSpectra(10., 10000.)
     
    3339{
    3440}
    35 
    36 
     41/*! Black Body Flux Function:
     42  \f[
     43  I_\nu = {2 h_{pl} (1.10^9*\nu)^3 \over c^2 (e^{{h_{pl}(1.10^9*\nu) \over kT}} -1)}
     44  \f]
     45*/
    3746double
    3847BlackBody::flux(double nu) const
  • trunk/SophyaLib/SkyT/derivblackbody.cc

    r893 r909  
    11//--------------------------------------------------------------------------
    22// File and Version Information:
    3 //      $Id: derivblackbody.cc,v 1.2 2000-04-12 10:24:52 ansari Exp $
     3//      $Id: derivblackbody.cc,v 1.3 2000-04-13 14:10:44 ansari Exp $
    44//
    55// Description:
     
    2020#include "derivblackbody.h"
    2121
    22 //----------------
    23 // Constructor --
    24 //----------------
     22
     23
     24/*! \class SOPHYA::DerivBlackBody <BR>
     25 * This class corresponds to the emission spectrum of a
     26 * dipole (since its emission spectrum is the derivation
     27 * of a blackbody spectrum wrt the temperature).
     28 */
     29
     30/*! Constructor: needs a temperature. Otherwise set to ConvTools::tcmb */
    2531DerivBlackBody::DerivBlackBody(double temperature)
    2632  : RadSpectra(10., 10000.)
     
    3440}
    3541
    36 
     42/*!
     43  The flux function is the derivation of the BlackBody
     44  flux function wrt the temperature (used e.g. for a Dipole)
     45  \f[
     46  I_\nu = {2 h_{pl} (1.10^9*\nu)^3  {h_{pl}1.10^9*\nu \over k T^2}
     47        {e^{{h_{pl}(1.10^9*\nu) \over kT}}\over c^2 (e^{{h_{pl}(1.10^9*\nu) \over kT}} -1)^2}}
     48  \f]
     49*/
    3750double
    3851DerivBlackBody::flux(double nu) const
  • trunk/SophyaLib/SkyT/gaussfilt.cc

    r668 r909  
    11//--------------------------------------------------------------------------
    22// File and Version Information:
    3 //      $Id: gaussfilt.cc,v 1.4 1999-11-29 14:16:04 ansari Exp $
     3//      $Id: gaussfilt.cc,v 1.5 2000-04-13 14:10:44 ansari Exp $
    44//
    55// Description:
     
    1919#include "gaussfilt.h"
    2020
    21 //----------------
    22 // Constructor --
    23 //----------------
     21/*!
     22 * \class SOPHYA::GaussianFilter
     23 * Gaussian detector response
     24 */
    2425GaussianFilter::GaussianFilter()
    2526  : SpectralResponse()
     
    2829}
    2930
     31/*! Constructor: the parameters correspond to the function defined in the
     32  <a href="#gausseq"> equation </a> below
     33*/
    3034GaussianFilter::GaussianFilter(double nu0, double s, double a, double numin, double numax)
    3135  : SpectralResponse(numin, numax)
     
    4650//              ---------------------------
    4751
     52/*! The transmission function is the wel known gaussian:
     53  <a name="gausseq"> </a>
     54  \f[
     55  \hbox{transmission}= A  e^{-{({\nu-\nu_0\over s})^2}};
     56  \f]
     57*/
    4858
    4959double
  • trunk/SophyaLib/SkyT/nupower.cc

    r669 r909  
    11//--------------------------------------------------------------------------
    22// File and Version Information:
    3 //      $Id: nupower.cc,v 1.5 1999-11-29 16:59:10 ansari Exp $
     3//      $Id: nupower.cc,v 1.6 2000-04-13 14:10:44 ansari Exp $
    44//
    55// Description:
     
    2121#include "nupower.h"
    2222
    23 //----------------
    24 // Constructor --
    25 //----------------
     23
     24/*!
     25 * \class SOPHYA::PowerLawSpectra <BR>
     26 * This class corresponds to a power law radiation spectrum.
     27*/
    2628PowerLawSpectra::PowerLawSpectra()
    2729{
    2830}
    29 
    30 PowerLawSpectra::PowerLawSpectra(double a, double b, double nu0, double dnu, double numin, double numax)
     31/*! Constructor: The arguments corresponds to the Power Law Spectrum
     32  equation:
     33<a name="psldef"> </a>
     34\f[
     35\hbox{flux}(\nu) = A ({\nu-\nu_0\over \delta\nu})^B
     36\f]
     37*/
     38PowerLawSpectra::PowerLawSpectra(double A, double B, double nu0, double dnu, double numin, double numax)
    3139  : RadSpectra(numin, numax)
    3240{
    33   _a = a;
    34   _b = b;
     41  _a = A;
     42  _b = B;
    3543  _nu0 = nu0;
    3644  _dnu = (dnu > 1.e-19) ? dnu : 1.;
     
    4149{
    4250}
    43 
     51/*! Flux function according to the <a href="#psldef"> above </a>
     52 equation */
    4453double
    4554PowerLawSpectra::flux(double nu) const
  • 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
  • trunk/SophyaLib/SkyT/radspecvector.cc

    r669 r909  
    11//--------------------------------------------------------------------------
    22// File and Version Information:
    3 //      $Id: radspecvector.cc,v 1.5 1999-11-29 16:59:11 ansari Exp $
     3//      $Id: radspecvector.cc,v 1.6 2000-04-13 14:10:45 ansari Exp $
    44//
    55// Description:
     
    2626// Constructor --
    2727//----------------
     28
     29/*!
     30 * \class SOPHYA::RadSpectraVec
     31 * One may define the radiation
     32 * spectrum with two vectors: <BR> one for the frequencies and the second for the
     33 * value of the flux function. <BR>
     34 * In that case, the class to use is RadSpectraVec !
     35 */
     36
    2837RadSpectraVec::RadSpectraVec()
    2938{
    3039}
    31 
     40/*! Constructor:
     41  \param nu is the frequency vector <BR>
     42  \param fdenu is the corresponding flux values (stored in a vector as well)
     43 */
    3244RadSpectraVec::RadSpectraVec(Vector const & nu, Vector const & fdenu, double numin, double numax)
    3345        : RadSpectra(numin, numax)
     
    5567
    5668
    57 
     69/*! The flux function extrapolates the flux values for the
     70  frequencies that are not present in the nu vector <BR>
     71  given at the instanciation of the class.
     72 */
    5873double
    5974RadSpectraVec::flux(double nu) const
  • trunk/SophyaLib/SkyT/specresp.cc

    r668 r909  
    11//--------------------------------------------------------------------------
    22// File and Version Information:
    3 //      $Id: specresp.cc,v 1.3 1999-11-29 14:16:08 ansari Exp $
     3//      $Id: specresp.cc,v 1.4 2000-04-13 14:10:45 ansari Exp $
    44//
    55// Description:
     
    2121#include "tvector.h"
    2222
     23/*!
     24 * \class SOPHYA::SpectralResponse <BR>
     25 SpectralResponse corresponds to a detector filter's
     26 response as a function of the frequency.
     27 The SpectralResponse class is an abstract class.
     28 The virtual constructor takes as arguments the
     29 minimum and maximum values of the frequency range on
     30 which the detector response is defined
     31 */
    2332//----------------
    2433// Constructor --
     
    107116
    108117
     118/*!
     119  This function performs the integration
     120  of the transmission function in its frequency range
     121  (defined when instanciating an object of on of the
     122  subclasses)
     123*/
    109124double
    110125SpectralResponse::IntegratedSpect()  const
     
    114129}
    115130
     131/*!
     132  The IntegratedSpect function performs the integration
     133  of the transmission function in a frequency range <BR> defined by
     134  numin and numax.
     135*/
    116136double
    117137SpectralResponse::IntegratedSpect(double numin, double numax) const
     
    137157}
    138158
     159/*!
     160  The logIntegratedSpect function performs the integration
     161  of the logarithm of the transmission function in a frequency range <BR> defined by
     162  numin and numax.
     163*/
    139164double
    140165SpectralResponse::logIntegratedSpect(double numin, double numax) const
     
    154179}
    155180
     181/*!
     182  Same than IntegratedSpect(numin,numax) over its
     183  frequency range defined at the initialisation
     184*/
    156185double
    157186SpectralResponse::logIntegratedSpect()  const
  • trunk/SophyaLib/SkyT/specrespvector.cc

    r806 r909  
    11//--------------------------------------------------------------------------
    22// File and Version Information:
    3 //      $Id: specrespvector.cc,v 1.6 2000-04-03 17:42:39 ansari Exp $
     3//      $Id: specrespvector.cc,v 1.7 2000-04-13 14:10:45 ansari Exp $
    44//
    55// Description:
     
    2626// Constructor --
    2727//----------------
     28/*!
     29 * \class SOPHYA::SpecRespVec
     30 One may also want to defined the filter of a detector by two vectors:
     31 one for the frequencies and one for the corresponding transmission values.
     32 In this case on should use the SpecRespVec class !
     33*/
    2834SpecRespVec::SpecRespVec()
    2935        : SpectralResponse()
     
    3137}
    3238
     39/*! Constructor:
     40  \param nu  vector of the frequencies
     41  \param fdenu  vector of the corresponding transmission values of the filter
     42*/
    3343SpecRespVec::SpecRespVec(Vector const & nu, Vector const & fdenu, double numin, double numax)
    3444        : SpectralResponse(numin, numax)
     
    6979
    7080
    71  
     81/*! The transmission function extrapolates the transmission values for the
     82  frequencies that are not present in the nu vector <BR>
     83  given at the instanciation of the class.
     84*/
    7285double
    7386SpecRespVec::transmission(double nu)  const
  • trunk/SophyaLib/SkyT/squarefilt.cc

    r669 r909  
    11//--------------------------------------------------------------------------
    22// File and Version Information:
    3 //      $Id: squarefilt.cc,v 1.4 1999-11-29 16:59:12 ansari Exp $
     3//      $Id: squarefilt.cc,v 1.5 2000-04-13 14:10:45 ansari Exp $
    44//
    55// Description:
     
    1717
    1818#include "squarefilt.h"
     19
     20/*!
     21 * \class SOPHYA::SquareFilter
     22 * Square detector response
     23 */
    1924
    2025//----------------
     
    4651
    4752
     53/*! The transmission returns 1. for frequencies in the [numin,numax] range
     54  and 0. outside */
    4855double
    4956SquareFilter::transmission(double nu) const
  • trunk/SophyaLib/SkyT/trianglefilt.cc

    r669 r909  
    11//--------------------------------------------------------------------------
    22// File and Version Information:
    3 //      $Id: trianglefilt.cc,v 1.4 1999-11-29 16:59:13 ansari Exp $
     3//      $Id: trianglefilt.cc,v 1.5 2000-04-13 14:10:46 ansari Exp $
    44//
    55// Description:
     
    2121// Constructor --
    2222//----------------
    23 
     23/*!
     24 * \class SOPHYA::TriangleFilter
     25 * triangle detector response
     26 */
    2427TriangleFilter::TriangleFilter()
    2528   : SpectralResponse()
    2629{
    2730}
     31/*! Constructor: nupeak is the frequency value at the hat of the triangle and
     32  valueatpeak is the corresponding transmission value. */
    2833TriangleFilter::TriangleFilter(double numin, double numax,double nupeak, double valueatpeak)
    2934   : SpectralResponse(numin, numax)
     
    4449//              ---------------------------
    4550
     51/*! The transmission function is a triangle defined in the constructor
     52by numin and numax (for which the transmission goes to 0.) and
     53the hat of the triangle (defined by a peak frequency and the corresponding
     54transmission value. */
    4655double
    4756TriangleFilter::transmission(double nu) const
     
    6473TriangleFilter::peakTransmission() const
    6574{
    66 return _peakTransmission;
     75  return _peakTransmission;
    6776}
    6877
Note: See TracChangeset for help on using the changeset viewer.