ProteoWizard
Public Member Functions | Public Attributes
pwiz::frequency::TruncatedLorentzianParameters Struct Reference

struct for holding parameters for a Truncated Lorentzian function More...

#include <TruncatedLorentzianParameters.hpp>

List of all members.

Public Member Functions

 TruncatedLorentzianParameters ()
 TruncatedLorentzianParameters (const TruncatedLorentzianParameters &that)
 TruncatedLorentzianParameters (const std::string &filename)
void write (const std::string &filename) const
 write out to file
void writeSamples (std::ostream &os) const
 write samples to stream
void writeSamples (std::ostream &os, double frequencyStart, double frequencyStep, int sampleCount) const
 write samples to stream
ublas::vector< double > parameters (double shift=0, std::complex< double > scale=1) const
 returns parameters in format usable by TruncatedLorentzian class
void parameters (const ublas::vector< double > &value, double shift=0, std::complex< double > scale=1)
 reads in parameters from TruncatedLorentzian format

Public Attributes

double T
double tau
std::complex< double > alpha
double f0

Detailed Description

struct for holding parameters for a Truncated Lorentzian function

Definition at line 37 of file TruncatedLorentzianParameters.hpp.


Constructor & Destructor Documentation

pwiz::frequency::TruncatedLorentzianParameters::TruncatedLorentzianParameters ( )
pwiz::frequency::TruncatedLorentzianParameters::TruncatedLorentzianParameters ( const TruncatedLorentzianParameters that)
pwiz::frequency::TruncatedLorentzianParameters::TruncatedLorentzianParameters ( const std::string &  filename)

Member Function Documentation

void pwiz::frequency::TruncatedLorentzianParameters::write ( const std::string &  filename) const

write out to file

Referenced by testIO().

void pwiz::frequency::TruncatedLorentzianParameters::writeSamples ( std::ostream &  os) const

write samples to stream

Referenced by testSamples().

void pwiz::frequency::TruncatedLorentzianParameters::writeSamples ( std::ostream &  os,
double  frequencyStart,
double  frequencyStep,
int  sampleCount 
) const

write samples to stream

ublas::vector<double> pwiz::frequency::TruncatedLorentzianParameters::parameters ( double  shift = 0,
std::complex< double >  scale = 1 
) const

returns parameters in format usable by TruncatedLorentzian class

Referenced by testParameterConversion().

void pwiz::frequency::TruncatedLorentzianParameters::parameters ( const ublas::vector< double > &  value,
double  shift = 0,
std::complex< double >  scale = 1 
)

reads in parameters from TruncatedLorentzian format


Member Data Documentation

double pwiz::frequency::TruncatedLorentzianParameters::T

Definition at line 39 of file TruncatedLorentzianParameters.hpp.

Referenced by testIO(), and testSamples().

double pwiz::frequency::TruncatedLorentzianParameters::tau

Definition at line 40 of file TruncatedLorentzianParameters.hpp.

Referenced by testIO(), testParameterConversion(), and testSamples().

std::complex<double> pwiz::frequency::TruncatedLorentzianParameters::alpha

Definition at line 41 of file TruncatedLorentzianParameters.hpp.

Referenced by testIO(), testParameterConversion(), and testSamples().

double pwiz::frequency::TruncatedLorentzianParameters::f0

The documentation for this struct was generated from the following file: