SOLARPROP  1.0
 All Classes Functions Variables
Public Member Functions
Spectrum Class Reference

Class for handling distributions containing the spectra of CR. More...

#include <spectrum.h>

List of all members.

Public Member Functions

 Spectrum (const std::vector< Tproperties > &, const std::vector< double > &)
 Constructor.
 Spectrum (const TmodelInformation &, std::string, std::string, Tproperties)
 Constructor to read data from FITS or Text file.
 ~Spectrum ()
 Destructor.
void output (std::string, std::string, std::string, std::string, int, double)
 Output to file.
std::vector< double > getEkin () const
 Getter for Ekin.
std::vector< TpropertiesgetSpec () const
 Getter for Particle properties.
void quality (int)
 Function to improve the data quality.
void reduceData (const std::vector< double > &)
 Reduce distribution to data points provided by origEkin.
void forceField (int, const Spectrum &, double)
 Force field routine to calculate force field approximation for a given distribution.
void modulate (int, const TmodelInformation &, const Spectrum &)
 Modulate an input distribution with the result from the simulation, given as a vector of distributions.

Detailed Description

Class for handling distributions containing the spectra of CR.


Constructor & Destructor Documentation

Spectrum::Spectrum ( const std::vector< Tproperties > &  sp,
const std::vector< double > &  ekinInput 
)

Constructor.

Parameters:
spList (std::vector) of particle properties
ekinInputstd::vector of the spacing of the kinetic energy for the distribution
Spectrum::Spectrum ( const TmodelInformation modelInfo,
std::string  input,
std::string  format,
Tproperties  sp 
)

Constructor to read data from FITS or Text file.

Parameters:
modelInfoModel information from import.cc
inputFile name of the FITS or Text file
formatInput Format (FITS, Text or Model)
spProperties of CR species

Member Function Documentation

void Spectrum::forceField ( int  species,
const Spectrum is,
double  phi 
)

Force field routine to calculate force field approximation for a given distribution.

Parameters:
speciesNumber of CR species which should be modulated
isInterstellar spectrum which should be modulated
phiModulation potential parameter phi in GV
void Spectrum::modulate ( int  species,
const TmodelInformation modelInfo,
const Spectrum is 
)

Modulate an input distribution with the result from the simulation, given as a vector of distributions.

Parameters:
speciesNumber of CR species which should be modulated
modelInfoModel information from import.cc
isLIS spectrum
void Spectrum::output ( std::string  inputFormat,
std::string  outputFormat,
std::string  in,
std::string  out,
int  m,
double  index 
)

Output to file.

Parameters:
inputFormatInput Format
outputFormatOutput Format
inInput file name
outOutput file name
mmodNumber for text output
indexspectral index for output rescaling
void Spectrum::quality ( int  extra)

Function to improve the data quality.

Parameters:
extraNumber of extra data points
void Spectrum::reduceData ( const std::vector< double > &  origEkin)

Reduce distribution to data points provided by origEkin.

Parameters:
origEkinNew ekin spacing

The documentation for this class was generated from the following files: