In file calibration/Unit.hh:

class Unit

Unit descriptor

Inheritance:


Public Classes

enum EUnitMagnitude
Unit Magnitude
kUnitMagFemto
Femto
kUnitMagPico
Pico
kUnitMagNano
Nano
kUnitMagMicron
Micron
kUnitMagMilli
milli
kUnitMagOne
1
kUnitMagKilo
Kilo
kUnitMagMega
Mega
kUnitMagGiga
Giga
kUnitMagTerra
Terra
kUnitMagPeta
Peta

Public Methods

explicit Unit (const char* name, Descriptor* cald = 0)
Constructor
virtual ~Unit ()
Destructor
virtual const char* GetName () const
Get name of unit
virtual const char* GetTrueName () const
Get its true name (useful for "none" and "default")
virtual bool IsPower () const
Unit is power rather than amplitude
virtual bool Apply (float* x, float* y, int N, EUnitMagnitude mag = kUnitMagOne, bool complex = false) const
Apply calibration correction for this unit
static double Factor (EUnitMagnitude mag)
Gets factor from maginutde
static std::string Mag (EUnitMagnitude mag)
Gets string from magnitude
static const Unit& UnitNone ()
Get a unit descriptor without corrections

Documentation

Describes a unit and its corresponding calibration correction formula. A calibration descriptor will maintain a list of unit descriptors appropriate for the quanity described.

enum EUnitMagnitude
Unit Magnitude

kUnitMagFemto
Femto

kUnitMagPico
Pico

kUnitMagNano
Nano

kUnitMagMicron
Micron

kUnitMagMilli
milli

kUnitMagOne
1

kUnitMagKilo
Kilo

kUnitMagMega
Mega

kUnitMagGiga
Giga

kUnitMagTerra
Terra

kUnitMagPeta
Peta

explicit Unit(const char* name, Descriptor* cald = 0)
Constructor

virtual ~Unit()
Destructor

virtual const char* GetName() const
Get name of unit

virtual const char* GetTrueName() const
Get its true name (useful for "none" and "default")

virtual bool IsPower() const
Unit is power rather than amplitude

virtual bool Apply(float* x, float* y, int N, EUnitMagnitude mag = kUnitMagOne, bool complex = false) const
Apply calibration correction for this unit

static double Factor(EUnitMagnitude mag)
Gets factor from maginutde

static std::string Mag(EUnitMagnitude mag)
Gets string from magnitude

static const Unit& UnitNone()
Get a unit descriptor without corrections


Direct child classes:
UnitScaling
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++