In file calibration/Unit.hh:

class UnitScaling : public Unit

Scaling unit descriptor

Inheritance:


Public Methods

UnitScaling (const char* name, double slope, double ofs = 0, bool scaleY = true, Descriptor* cald = 0)
Constructor
virtual ~UnitScaling ()
Destructor
virtual bool Apply (float* x, float* y, int N, EUnitMagnitude mag = kUnitMagOne, bool complex = false) const
Scale
double GetSlope () const
Get slope
double GetOffset () const
Get offset
bool IsYScaling () const
Scale Y?
static const UnitScaling& UnitIdentityX ()
Get a unit descriptor for the identity unit (x axis)
static const UnitScaling& UnitIdentityY ()
Get a unit descriptor for the identity unit (y axis)
static const UnitScaling& UnitRadPerSec ()
Get a unit descriptor for f -> rad/s
static const UnitScaling& UnitHertz ()
Get a unit descriptor for f -> Hz
static const UnitScaling& UnitSec ()
Get a unit descriptor for t -> sec
static const UnitScaling& UnitMin ()
Get a unit descriptor for t -> min
static const UnitScaling& UnitHour ()
Get a unit descriptor for t -> hour
static const UnitScaling& UnitDay ()
Get a unit descriptor for t -> day

Protected Fields

double fSlope
Slope
double fOffset
Offset
bool fY
Scale Y data
static const UnitScaling kIdentityX
the identity unit (x axis)
static const UnitScaling kIdentityY
the identity unit (y axis)
static const UnitScaling kRadPerSec
a unit which represents f -> rad/s
static const UnitScaling kHertz
a unit which represents f -> Hz
static const UnitScaling kSec
a unit which represents t -> sec
static const UnitScaling kMin
a unit which represents t -> min
static const UnitScaling kHour
a unit which represents t -> hour
static const UnitScaling kDay
a unit which represents t -> day

Inherited from Unit:

Public Classes

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

Public Methods

virtual const char* GetName() const
virtual const char* GetTrueName() const
virtual bool IsPower() const
static double Factor(EUnitMagnitude mag)
static std::string Mag(EUnitMagnitude mag)
static const Unit& UnitNone()

Documentation

Describes a unit which implements simple scaling and offset corrections.

double fSlope
Slope

double fOffset
Offset

bool fY
Scale Y data

UnitScaling(const char* name, double slope, double ofs = 0, bool scaleY = true, Descriptor* cald = 0)
Constructor

virtual ~UnitScaling()
Destructor

virtual bool Apply(float* x, float* y, int N, EUnitMagnitude mag = kUnitMagOne, bool complex = false) const
Scale

double GetSlope() const
Get slope

double GetOffset() const
Get offset

bool IsYScaling() const
Scale Y?

static const UnitScaling& UnitIdentityX()
Get a unit descriptor for the identity unit (x axis)

static const UnitScaling& UnitIdentityY()
Get a unit descriptor for the identity unit (y axis)

static const UnitScaling& UnitRadPerSec()
Get a unit descriptor for f -> rad/s

static const UnitScaling& UnitHertz()
Get a unit descriptor for f -> Hz

static const UnitScaling& UnitSec()
Get a unit descriptor for t -> sec

static const UnitScaling& UnitMin()
Get a unit descriptor for t -> min

static const UnitScaling& UnitHour()
Get a unit descriptor for t -> hour

static const UnitScaling& UnitDay()
Get a unit descriptor for t -> day

static const UnitScaling kIdentityX
the identity unit (x axis)

static const UnitScaling kIdentityY
the identity unit (y axis)

static const UnitScaling kRadPerSec
a unit which represents f -> rad/s

static const UnitScaling kHertz
a unit which represents f -> Hz

static const UnitScaling kSec
a unit which represents t -> sec

static const UnitScaling kMin
a unit which represents t -> min

static const UnitScaling kHour
a unit which represents t -> hour

static const UnitScaling kDay
a unit which represents t -> day


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++