class DataDescriptor : public BasicDataDescriptor

Object for describing pointers to plotting data

Inheritance:

Public Methods

	DataDescriptor () Default constructor.
	DataDescriptor (float* x, float* y, int& n, bool cmplx = false) Constructor.
	DataDescriptor (float x0, float dx, float* y, int& n, bool cmplx = false) Constructor.
virtual	~DataDescriptor () Destructor.
virtual bool	SetData (float* x, float* y, int& n, bool cmplx = false) Set data method.
virtual bool	SetData (float x0, float dx, float* y, int& n, bool cmplx = false) Set data method.
virtual bool	IsXY () const Is XY.
virtual float	GetDX () const x spacing.
virtual int	GetN () const Get N method.
virtual int&	GetNRef () const Get N ref method.
virtual float*	GetX () const Get X method.
virtual float*	GetY () const Get Y method.

Protected Fields

bool	fXYData XY or just Y with x0 and dx
float	fdX dx distance
float	fX0 first x value
float*	fX Data pointer (X)
float*	fY Data pointer (Y)
int*	fN Number of data points

Inherited from BasicDataDescriptor:

Public Methods

virtual bool IsComplex() const

virtual void SetComplex(bool cmplx)

virtual bool IsDirty() const

virtual void SetDirty(bool set = true) const

virtual bool IsPersistent() const

virtual void SetPersistent(bool set = true)

virtual bool IsCalculated() const

virtual void SetCalculated(bool set = true)

virtual bool IsMarked() const

virtual void SetMarked(bool set = true) const

virtual float* GetEX() const

virtual float* GetEXhigh() const

virtual float* GetEY() const

virtual float* GetEYhigh() const

virtual bool EraseData()

virtual double* GetXBinEdges() const

virtual double* GetBinContents() const

virtual double* GetBinErrors() const

virtual const char* GetXLabel() const

virtual const char* GetNLabel() const

virtual int GetNEntries() const

virtual double* GetStats() const

Protected Fields

bool fComplexData

mutable bool fDirty

bool fPersistent

bool fCalculated

mutable bool fMarked

bool fXYData

XY or just Y with x0 and dx

float fdX

dx distance

float fX0

first x value

float* fX

Data pointer (X)

float* fY

Data pointer (Y)

int* fN

Number of data points

DataDescriptor()

Constructs a data descriptor without data references.

Returns:

void

DataDescriptor(float* x, float* y, int& n, bool cmplx = false)

Constructs a data descriptor by providing pointer to an x array, a y array and the array length.

Returns:

void

Parameters:

x - Pointer to X array
y - Pointer to Y array
n - Reference to array length
cmplx - true if data is complex

DataDescriptor(float x0, float dx, float* y, int& n, bool cmplx = false)

Constructs a data descriptor by providing a start and delta for the x data, a pointer to a y array and the array length.

Returns:

void

Parameters:

x0 - First X value
dx - X array spacing
y - Pointer to Y array
n - Reference to array length
cmplx - true if data is complex

virtual ~DataDescriptor()

Destructs the data descriptor.

Returns:

void

virtual bool SetData(float* x, float* y, int& n, bool cmplx = false)

Sets a new data for descriptor by providing pointer to an x array, a y array and the array length.

Returns:

void

Parameters:

x - Pointer to X array
y - Pointer to Y array
n - Reference to array length
cmplx - true if data is complex

virtual bool SetData(float x0, float dx, float* y, int& n, bool cmplx = false)

Sets a new data for descriptor by providing a start and delta for the x data, a pointer to a y array and the array length.

Returns:

void

Parameters:

x0 - First X value
dx - X array spacing
y - Pointer to Y array
n - Reference to array length
cmplx - true if data is complex

virtual bool IsXY() const

Returns true if xy data.

Returns:

true if xy

virtual float GetDX() const

Returns x spacing if xy data.

Returns:

x spacing

virtual int GetN() const

Returns a the length of the data array.

Returns:

Length

virtual int& GetNRef() const

Returns a reference to 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

Direct child classes:

DataRefCount
DataRef
DataCopy

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