class BasicDataDescriptor

Abstract object for describing plotting data

Inheritance:

Public Methods

explicit	BasicDataDescriptor (bool cmplx = false) Default constructor.
virtual	~BasicDataDescriptor () Destructor.
virtual bool	IsComplex () const Is complex method.
virtual void	SetComplex (bool cmplx) Set complex method.
virtual bool	IsDirty () const Is dirty.
virtual void	SetDirty (bool set = true) const Set dirty flag.
virtual bool	IsPersistent () const Is persistent.
virtual void	SetPersistent (bool set = true) Set persistent flag.
virtual bool	IsCalculated () const Is calculated.
virtual void	SetCalculated (bool set = true) Set calculated flag.
virtual bool	IsMarked () const Is marked.
virtual void	SetMarked (bool set = true) const Set marked flag.
virtual bool	IsXY () const Is XY.
virtual float	GetDX () const x spacing.
virtual int	GetN () const Get N method.
virtual float*	GetX () const Get X method.
virtual float*	GetY () const Get Y method.
virtual float*	GetEX () const Get error X method.
virtual float*	GetEXhigh () const Get error X high method.
virtual float*	GetEY () const Get error X method.
virtual float*	GetEYhigh () const Get error Y high method.
virtual bool	EraseData () Erase data method.
virtual double*	GetXBinEdges () const Get X bin edges method.
virtual double*	GetBinContents () const Get bin contents method.
virtual double*	GetBinErrors () const Get bin errors method.
virtual const char*	GetXLabel () const Get X-axis label method.
virtual const char*	GetNLabel () const Get bin content axis label method.
virtual int	GetNEntries () const Get number of data entries method.
virtual double*	GetStats () const Get statistics array method.

Protected Fields

bool	fComplexData Data is complex
mutable bool	fDirty Dirty bit
bool	fPersistent Persistent bit
bool	fCalculated Calulated bit
mutable bool	fMarked Marked bit (temporary use for marking data descriptors)

bool fComplexData

Data is complex

mutable bool fDirty

Dirty bit

bool fPersistent

Persistent bit

bool fCalculated

Calulated bit

mutable bool fMarked

Marked bit (temporary use for marking data descriptors)

explicit BasicDataDescriptor(bool cmplx = false)

Constructs a basic data descriptor. The convention for complex data arrays is to store real and imaginary part of each value in the array as two consequitive numbers.

Returns:

void

Parameters:

cmplx - if true Y array is complex

virtual ~BasicDataDescriptor()

Destructs a basic data descriptor.

Returns:

void

virtual bool IsComplex() const

Returns true if Y data array is complex.

Returns:

true if complex

virtual void SetComplex(bool cmplx)

Sets Y data array as either complex (true) or real (false).

Returns:

void

Parameters:

cmplx - true if complex

virtual bool IsDirty() const

Is dirty method.

Returns:

True if dirty

virtual void SetDirty(bool set = true) const

Set the dirty flag.

Returns:

void

virtual bool IsPersistent() const

Is persistent method.

Returns:

True if persistent

virtual void SetPersistent(bool set = true)

Set the persistent flag.

Returns:

void

virtual bool IsCalculated() const

Is calculated method.

Returns:

True if calculated

virtual void SetCalculated(bool set = true)

Set the calculated flag.

Returns:

void

virtual bool IsMarked() const

Is marked method.

Returns:

True if marked

virtual void SetMarked(bool set = true) const

Set the marked flag.

Returns:

void

virtual bool IsXY() const

Returns true if xy data and false if data can be represented as (x0, dx, y). A descriptor which returns false must also implement the function GetDX() to return the x spacing. The start value is assumed to be GetX()[0].

Returns:

true if xy

virtual float GetDX() const

Returns x spacing if (x0,dx,y) data.

Returns:

x spacing

virtual int GetN() const

Returns a the length of the data array.

Returns:

Length

virtual float* GetX() const

Returns a pointer to the X data array.

Returns:

X array

virtual float* GetY() const

Returns a pointer to the Y data array.

Returns:

Y array

virtual float* GetEX() const

Returns a pointer to the X error bar data array.

Returns:

X error array

virtual float* GetEXhigh() const

Returns a pointer to the X high error bar data array when error bars are asymmetric.

Returns:

X high error array

virtual float* GetEY() const

Returns a pointer to the X error bar data array.

Returns:

X error array

virtual float* GetEYhigh() const

Returns a pointer to the Y high error bar data array when error bars are asymmetric.

Returns:

Y high error array

virtual bool EraseData()

Erases the data. This function can be used to reload or recalculate the data values.

Returns:

true if successful

virtual double* GetXBinEdges() const

Returns a pointer to the X bin edges data array (histogram).

Returns:

X bin edges array

virtual double* GetBinContents() const

Returns a pointer to the bin content data array (histogram).

Returns:

bin contents array

virtual double* GetBinErrors() const

Returns a pointer to the bin error data array (histogram).

Returns:

bin error array

virtual const char* GetXLabel() const

Returns a pointer to the character array for X-axis label (histogram).

Returns:

X-axis label

virtual const char* GetNLabel() const

Returns a pointer to the character array for bin content axis label (histogram).

Returns:

bin content axis label

virtual int GetNEntries() const

Returns number of data entries to the histogram (histogram).

Returns:

number of data entries

virtual double* GetStats() const

Returns a pointer to the statistics data array (histogram).

Returns:

statistics array

Direct child classes:

OpDataDescriptor
IndirectDataDescriptor
HistDataDescriptor
DataDescriptor

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