Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::SimData

Simulated data.
Contained in: FrameCPP::Version_3_4_5
Derived from: FrameCPP::Version_3_4_5::Base
Derived by: none

#include "../../../../../lib/framecpp/src/Version3_4_5/simdata.hh"


public function member index:

SimData(); Default Constructor.
SimData(const SimData& simData); Copy Constructor.
SimData(const std::string& name, const std::string& comment, REAL_4 sampleRate, REAL_8 fshift, REAL_4 phase); Constructor.
virtual INT_2U getClassId() const;
inline const std::string& getComment() const; Comment
inline REAL_8 getFShift() const; Get the frequency shift if the signal has been heterodyned before the ADC.
const std::string& getName() const;
inline REAL_4 getPhase() const; Get phase of heterodyning signal at start of dataset.
static SH getSH(); Structure Header
static SH getSH3(); Get frame data format version 3 Structure Header
static SH getSH4(); Get frame data format version 4 Structure Header
inline REAL_8 getSampleRate() const; Sample Rate.
inline bool operator !=(const SimData& simData) const; Not-equal comparison.
const SimData& operator +=(const SimData& simData); += Operator.
const SimData& operator =(const SimData& simData); Assignment Operator.
bool operator ==(const SimData& simData) const; Equal comparison.
inline SimData::DataContainer& refData(); Data Container.
inline const SimData::DataContainer& refData() const; const Data Container.
inline SimData::InputContainer& refInput(); Input Container.
inline const SimData::InputContainer& refInput() const; const Input Container.
inline SimData::TableContainer& refTable(); Table Container.
inline const SimData::TableContainer& refTable() const; const Table Container.
 

private function member index:

static SimData* read(FrameReaderBase& in); Reads a SimData object from an Input object.
static SimData* read3(FrameReaderBase& in); Version 3 frame SumData read function.
static SimData* read4(FrameReaderBase& in); Version 4 frame SumData read function.
virtual void write(Output& out) const;
 

Description:

This class represents simulated ADC data. It is modeled after the FrSimData structure in the Frame Specification, LIGO-T970130-B-E.

SimData possess the following attributes: Phase of heterodyning signal at start of data set
AttributeDescription
name Name of simulated data
comment Comment
sampleRateData acquisistion rate, samples / sec
fShift Frequency shift if signal has been heterodyned before
phase

The SimData object is a container for two types of data:
DataDescription
data A container of Vect objects which contain the sampled data.
inputA container of Vect objects holding seed MC input data for the simulation.
tableA container of Table objects with user data.

The data is available through the container objects inside SimData. These are accessed via the refData and refAux methods.


Function Member Descriptions:


FrameCPP::Version_3_4_5::SimData::SimData - Default Constructor.


SimData();
This creates a SimData object with the following properties:

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::SimData::SimData - Copy Constructor.


SimData(const SimData& simData);
This performs a deep copy of all owned data.

Parameters:
ParameterDescription
const SimData& simDatathe object to copy from.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::SimData::SimData - Constructor.


SimData(const std::string& name, const std::string& comment, REAL_4 sampleRate, REAL_8 fshift, REAL_4 phase);

Parameters:
ParameterDescription
const std::string& nameThe name for the simulated data.
const std::string& commentA comment.
REAL_4 sampleRateThe sample rate (samples/sec).
const REAL_8& fShiftFrequency shift.
const REAL_4& phasePhase.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::SimData::getClassId


virtual INT_2U getClassId() const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::SimData::getComment - Comment


inline const std::string& getComment() const;
Get the comment.

Return value:
const std::string&- Comment.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimData::getFShift - Get the frequency shift if the signal has been heterodyned before the ADC.


inline REAL_8 getFShift() const;
fShift = (f_heterodyne - fNyquist@sampleRate).

Return value:
REAL_8- Frequency shift.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimData::getName


const std::string& getName() const;



FrameCPP::Version_3_4_5::SimData::getPhase - Get phase of heterodyning signal at start of dataset.


inline REAL_4 getPhase() const;

Return value:
REAL_4- phase.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimData::getSH - Structure Header


static SH getSH();
Constructs the Structure Header for this class.

Return value:
SH- SimData structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::SimData::getSH3 - Get frame data format version 3 Structure Header


static SH getSH3();

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::SimData::getSH4 - Get frame data format version 4 Structure Header


static SH getSH4();

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::SimData::getSampleRate - Sample Rate.


inline REAL_8 getSampleRate() const;
Get the simulated data sample rate. The rate is in samples / sec.

Return value:
REAL_8- Sample rate.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimData::operator != - Not-equal comparison.


inline bool operator !=(const SimData& simData) const;

Parameters:
ParameterDescription
const SimData& simDataThe object to compare with.

Return value:
bool- True if the objects are not equal.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimData::operator += - += Operator.


const SimData& operator +=(const SimData& simData);

Parameters:
ParameterDescription
const SimData& simDataThe object to be added.

Return value:
const SimData&- This object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::SimData::operator = - Assignment Operator.


const SimData& operator =(const SimData& simData);
This performs a deep copy of all owned data.

Parameters:
ParameterDescription
const SimData& simDataThe object to assign from.

Return value:
const SimData&- This object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::SimData::operator == - Equal comparison.


bool operator ==(const SimData& simData) const;
Determines whether two SimData objects are equal. For this comparison, all of the data is compared.

Parameters:
ParameterDescription
const SimData& simDataThe object to compare with.

Return value:
bool- true if the objects are equal.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::SimData::read - Reads a SimData object from an Input object.


static SimData* read(FrameReaderBase& in);
This method creates a dynamically allocated object.

*NOTE* This method allocates memory and returns a pointer to it. The user is responsible for freeing this memory.


Parameters:
ParameterDescription
FrameReaderBase& inInput data stream object.

Return value:
SimData*- Newly created SimData object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureRead failure occured.



FrameCPP::Version_3_4_5::SimData::read3 - Version 3 frame SumData read function.


static SimData* read3(FrameReaderBase& in);

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureRead failure occured.



FrameCPP::Version_3_4_5::SimData::read4 - Version 4 frame SumData read function.


static SimData* read4(FrameReaderBase& in);

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureRead failure occured.



FrameCPP::Version_3_4_5::SimData::refData - Data Container.


inline SimData::DataContainer& refData();
Get the container which contains the data.

Return value:
SearchContainer< Vect, &Vect::getName >&- Data container.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimData::refData - const Data Container.


inline const SimData::DataContainer& refData() const;
Get the container which contains the data.

Return value:
const SearchContainer< Vect, &Vect::getName >&- Data container.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimData::refInput - Input Container.


inline SimData::InputContainer& refInput();
Get the container for seed MC input data for the simulation.

Return value:
Container< Vect >&- Data Container.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimData::refInput - const Input Container.


inline const SimData::InputContainer& refInput() const;
Get the container for seed MC input data for the simulation.

Return value:
const Container< Vect >&- Data container.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimData::refTable - Table Container.


inline SimData::TableContainer& refTable();
Get table container.

Return value:
Container< Table >&- Table container.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimData::refTable - const Table Container.


inline const SimData::TableContainer& refTable() const;
Get table container.

Return value:
const Container< Vect >&- Table container.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimData::write


virtual void write(Output& out) const;
Writes a SimData object to an Output object.

Parameters:
ParameterDescription
Output& out outOutput data stream object.

Exceptions:
ExceptionDescription
write_failureData write failed.



Variable Member Descriptions:


FrameCPP::Version_3_4_5::SimData::mComment - Comment.

std::string mComment;

FrameCPP::Version_3_4_5::SimData::mData - Simulated data.

DataContainer mData;

FrameCPP::Version_3_4_5::SimData::mFShift - Frequency shift.

REAL_8 mFShift;

FrameCPP::Version_3_4_5::SimData::mInput - Input parameters for simulation.

InputContainer mInput;

FrameCPP::Version_3_4_5::SimData::mName - Name of simulated data.

std::string mName;

FrameCPP::Version_3_4_5::SimData::mPhase - Phase of heterodyning signal at start of dataset

REAL_4 mPhase;

FrameCPP::Version_3_4_5::SimData::mSampleRate - Simulated data sample rate, samples / s.

REAL_4 mSampleRate;

FrameCPP::Version_3_4_5::SimData::mTable - Table data structure.

TableContainer mTable;