class Calibration : private calrec_t

Calibration container

Inheritance:

Public Methods

	Calibration () Default constructor
	Calibration (const Calibration& cal) Copy constructor
	Calibration (const calrec_t& cal) Constructor from calrec_t
	~Calibration () Destructor
Calibration&	operator= (const Calibration& cal) Assignment operator
	operator const calrec_t* () const Conversion operator to calrec_t*
bool	operator== (const Calibration& cal) const Equal
bool	operator!= (const Calibration& cal) const Unequal
bool	operator< (const Calibration& cal) const Smaller
bool	operator<= (const Calibration& cal) const Smaller or equal
bool	operator> (const Calibration& cal) const Greater
bool	operator>= (const Calibration& cal) const Greater or equal
bool	Match (const Calibration& query) const Match method
void	SetChannel (const char* chnname) Set channel name method
const char*	GetChannel () const Get channel name method
void	SetRef (const char* ref) Set reference point method
const char*	GetRef () const Get reference point method
void	SetUnit (const char* unit) Set unit string method
const char*	GetUnit () const Get unit string method
void	SetTime (const Time& time) Set calibration time method
Time	GetTime () const Get calibration time method
void	SetDuration (const Interval& dur) Set calibration duration method
Interval	GetDuration () const Get calibration duration method
int	GetType () const Get calibration type method
void	SetConversion (double conv) Set conversion factor method
void	ResetConversion () Reset conversion factor method
double	GetConversion () const Get conversion factor method
void	SetOffset (double ofs) Set offset method
void	ResetOffset () Reset offset method
double	GetOffset () const Get offset method
void	SetTimeDelay (double dt) Set time delay method
void	ResetTimeDelay () Reset time delay method
double	GetTimeDelay () const Get time delay method
void	SetTransferFunction (const float* trans, int len) Set transfer function method
int	GetTransferFunction (const float*& trans) const Get transfer function method
void	SetPoleZeros (double gain, int pnum, int znum, const float* pzs) Set pole-zero method
int	GetPoleZeros (double& gain, int& pnum, int& znum, const float*& pzs) const Get pole-zero method
void	SetDefault (bool def = true) Set default method
bool	GetDefault () const Get default method
void	SetPreferredMag (int mag = 0) Set preferred magnitude method
int	GetPreferredMag () const Get preferred magnitude method
void	SetPreferredD (int d = 0) Set preferred derivative method
int	GetPreferredD () const Get preferred derivative method
void	SetComment (const char* comment = 0) Set comment method
const char*	GetComment () const Get comment method
bool	Xml (int flag, std::string& s, int index = -1, std::string* errormsg = 0) const XML method

Calibration()

Default constructor

Calibration(const Calibration& cal)

Copy constructor

Calibration(const calrec_t& cal)

Constructor from calrec_t

~Calibration()

Destructor

Calibration& operator= (const Calibration& cal)

Assignment operator

operator const calrec_t* () const

Conversion operator to calrec_t*

bool operator== (const Calibration& cal) const

Equal

bool operator!= (const Calibration& cal) const

Unequal

bool operator< (const Calibration& cal) const

Smaller

bool operator<= (const Calibration& cal) const

Smaller or equal

bool operator> (const Calibration& cal) const

Greater

bool operator>= (const Calibration& cal) const

Greater or equal

bool Match(const Calibration& query) const

This function is used by the query function to determine if a query record matches a calibration record.

Returns:

true if match, false otherwise

Parameters:

query - query record

void SetChannel(const char* chnname)

Set channel name method

Parameters:

chnname - channel name

const char* GetChannel() const

Get channel name method

Returns:

channel name

void SetRef(const char* ref)

Set reference point method

Parameters:

ref - channel name

const char* GetRef() const

Get reference point method

Returns:

channel name

void SetUnit(const char* unit)

Set unit string method

Parameters:

unit - unit string

const char* GetUnit() const

Get unit string method

Returns:

unit string

void SetTime(const Time& time)

Set calibration time method

Parameters:

time - time

Time GetTime() const

Get calibration time method

Returns:

time

void SetDuration(const Interval& dur)

Set calibration duration method

Parameters:

dur - duration

Interval GetDuration() const

Get calibration duration method

Returns:

duration

int GetType() const

Get calibration type method

Returns:

type

void SetConversion(double conv)

Sets the conversion factor of a calibration record.

Parameters:

conv - conversion factor

void ResetConversion()

Resets the conversion factor of a calibration record.

double GetConversion() const

Gets the conversion factor of a calibration record.

Returns:

conversion factor

void SetOffset(double ofs)

Sets the offset of a calibration record.

Parameters:

ofs - offset

void ResetOffset()

Resets the offset of a calibration record.

double GetOffset() const

Gets the offset of a calibration record.

Returns:

offset

void SetTimeDelay(double dt)

Sets the time delay of a calibration record.

Parameters:

dt - time delay

void ResetTimeDelay()

Resets the time delay of a calibration record.

double GetTimeDelay() const

Gets the time delay of a calibration record.

Returns:

time delay

void SetTransferFunction(const float* trans, int len)

Sets the transfer function of a calibration record. If a NULL pointer is specified the transfer function is disabled.

Parameters:

trans - Transfer function array
len - Number of points

int GetTransferFunction(const float*& trans) const

Gets the transfer function of a calibration record.

Returns:

Number of points

Parameters:

trans - Transfer function array pointer (return)

void SetPoleZeros(double gain, int pnum, int znum, const float* pzs)

Sets the pole and zeros of a calibration record. If a Null pointer is specified the poles and zeros are disabled.

Parameters:

gain - Gain
pnum - Number of poles
znum - Number of zeros
pzs - Complex array of poles and zeros

int GetPoleZeros(double& gain, int& pnum, int& znum, const float*& pzs) const

Gets the poles and zeros of a calibration record.

Returns:

true if successful

Parameters:

gain - Gain (return)
pnum - Number of poles (return)
znum - Number of zeros (return)
pzs - Complex array of poles and zeros (return)

void SetDefault(bool def = true)

Sets the default flag of a calibration record.

Parameters:

def - default

bool GetDefault() const

Gets the default flag of a calibration record.

Returns:

default state

void SetPreferredMag(int mag = 0)

Sets the preferred magnitude of a calibration record.

Parameters:

mag - preferred magnitude (power of 10)

int GetPreferredMag() const

Gets the preferred magnitude of a calibration record.

Returns:

preferred magnitude

void SetPreferredD(int d = 0)

Sets the preferred derivative of a calibration record.

Parameters:

d - preferred derivative

int GetPreferredD() const

Gets the preferred derivative of a calibration record.

Returns:

preferred derivative

void SetComment(const char* comment = 0)

Sets the comment field of a calibration record.

Parameters:

comment - Comment

const char* GetComment() const

Gets the comment field of a calibration record.

Returns:

Comment

bool Xml(int flag, std::string& s, int index = -1, std::string* errormsg = 0) const

Get an XML representation of the record.

Returns:

true if successful

alphabetic index hierarchy of classes

Please send questions and comments to zweizig_j@ligo.caltech.edu

generated by doc++