In file calibration/Descriptor.hh:

class Descriptor

Calibration descriptor

Inheritance:


Public Classes

class infoptr
Info pointer (used as a smart pointer)
typedef SignalInfo* Pointer
Pointer type
mutable Pointer fInfo
Pointer
explicit infoptr (Pointer p = 0)
Constructor
infoptr (const infoptr& info)
Copy constructor
~infoptr ()
Destructor
infoptr& operator= (const infoptr& info)
Assignment operator
Pointer Get () const
Get function
void Set (Pointer p)
Set function

Public Methods

explicit Descriptor (bool valid = false)
Default constructor
Descriptor (const Time& time, const char* graphtype, const char* Achn, const char* Bchn = 0, double bw = 0.0)
Constructor
explicit Descriptor (const Descriptor* cald)
Similar to copy constructor
virtual ~Descriptor ()
Destructor
virtual void Init ()
Initializes the descriptor to its default values
virtual void Clone (const Descriptor& desc, Table* caltable = 0)
Clone from another descriptor
virtual bool Setup (const char* graphtype, const char* Achn, const char* Bchn = 0, double bw = 0.0, const Time& time = Time (0, 0))
Sets the descriptor to a graphtype
virtual bool IsValid () const
Is valid?
virtual void SetValid (bool valid = true)
Set valid
virtual Time GetTime () const
Get time
virtual void SetTime (const Time& time)
Set channel relation
virtual ECalChnRelation GetRelation () const
Get channel relation
virtual void SetRelation (ECalChnRelation rel)
Set channel relation
virtual ECalDomain Domain (ECalUnit unit = kCalUnitX) const
Get domain
virtual void SetDomain (ECalUnit unit, ECalDomain dom)
Set domain
virtual const char* GetChannel (bool b) const
Get channel name
virtual void SetChannel (bool b, const char* name)
Get channel name
virtual double GetCoeff (bool b) const
Get coefficient
virtual void SetCoeff (bool b, double coeff)
Set coefficient
virtual int GetExpo (bool b) const
Get exponent
virtual void SetExpo (bool b, int expo)
Set exponent
virtual bool GetConj (bool b) const
Get conjugate
virtual void SetConj (bool b, bool conj)
Set exponent
virtual ECalDensity GetDensity (ECalUnit unit) const
Get density unit
virtual void SetDensity (ECalUnit unit, ECalDensity dens)
Set density unit
virtual double GetBW (ECalUnit unit) const
Get bandwidth
virtual void SetBW (ECalUnit unit, double bw)
Set bandwidth
virtual int GetPreferredMag (ECalUnit unit) const
Get preferred magnitude
virtual void SetPreferredMag (ECalUnit unit, int mag)
Set preferred magnitude
virtual UnitList& Units (ECalUnit unit)
Get list of units
virtual const Unit* FindUnit (ECalUnit unit, const char* name) const
Find the specified unit; the names 'none' and 'default' are always recognized
virtual void SetInfo (SignalInfo* info)
Set info (used by the calibration table)
virtual SignalInfo* GetInfo () const
Get info (used by the calibration table)

Public


Constructor

copies all unit names into list as TNamed object

Documentation

Describes the calibration information asscoaiated with a plot. A one channel quantity describes the data as follows: data = coeff_A * channel_A ^ expo_A. A two channel qunatity is formed as follows: data = coeff_A * channel_A ^ expo_A (x) coeff_B * channel_B ^ expo_B where (x) is either a + (additive) or a * (multiplicative).

explicit Descriptor(bool valid = false)
Default constructor

Constructor

Descriptor(const Time& time, const char* graphtype, const char* Achn, const char* Bchn = 0, double bw = 0.0)
Constructor

explicit Descriptor(const Descriptor* cald)
Similar to copy constructor

virtual ~Descriptor()
Destructor

virtual void Init()
Initializes the descriptor to its default values

virtual void Clone(const Descriptor& desc, Table* caltable = 0)
Clone from another descriptor

virtual bool Setup(const char* graphtype, const char* Achn, const char* Bchn = 0, double bw = 0.0, const Time& time = Time (0, 0))
Sets the descriptor to a graphtype

virtual bool IsValid() const
Is valid?

virtual void SetValid(bool valid = true)
Set valid

virtual Time GetTime() const
Get time

virtual void SetTime(const Time& time)
Set channel relation

virtual ECalChnRelation GetRelation() const
Get channel relation

virtual void SetRelation(ECalChnRelation rel)
Set channel relation

virtual ECalDomain Domain(ECalUnit unit = kCalUnitX) const
Get domain

virtual void SetDomain(ECalUnit unit, ECalDomain dom)
Set domain

virtual const char* GetChannel(bool b) const
Get channel name

virtual void SetChannel(bool b, const char* name)
Get channel name

virtual double GetCoeff(bool b) const
Get coefficient

virtual void SetCoeff(bool b, double coeff)
Set coefficient

virtual int GetExpo(bool b) const
Get exponent

virtual void SetExpo(bool b, int expo)
Set exponent

virtual bool GetConj(bool b) const
Get conjugate

virtual void SetConj(bool b, bool conj)
Set exponent

virtual ECalDensity GetDensity(ECalUnit unit) const
Get density unit

virtual void SetDensity(ECalUnit unit, ECalDensity dens)
Set density unit

virtual double GetBW(ECalUnit unit) const
Get bandwidth

virtual void SetBW(ECalUnit unit, double bw)
Set bandwidth

virtual int GetPreferredMag(ECalUnit unit) const
Get preferred magnitude

virtual void SetPreferredMag(ECalUnit unit, int mag)
Set preferred magnitude

virtual UnitList& Units(ECalUnit unit)
Get list of units

virtual const Unit* FindUnit(ECalUnit unit, const char* name) const
Find the specified unit; the names 'none' and 'default' are always recognized

copies all unit names into list as TNamed object

virtual void SetInfo(SignalInfo* info)
Set info (used by the calibration table)

virtual SignalInfo* GetInfo() const
Get info (used by the calibration table)

class infoptr
Info pointer (used as a smart pointer)

typedef SignalInfo* Pointer
Pointer type

mutable Pointer fInfo
Pointer

explicit infoptr(Pointer p = 0)
Constructor

infoptr(const infoptr& info)
Copy constructor

~infoptr()
Destructor

infoptr& operator= (const infoptr& info)
Assignment operator

Pointer Get() const
Get function

void Set(Pointer p)
Set function


This class has no child classes.
Author:
Written November 1999 by Daniel Sigg
Version:
1.0

alphabetic index hierarchy of classes


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


generated by doc++