RContourBaseCircle Class Reference

#include <RContourBaseCircle.hh>

Inheritance diagram for RContourBaseCircle:

Public Member Functions
	RContourBaseCircle (const Double_t r=1.)
	RContourBaseCircle (const RPoint2D ctr, const Double_t r)
	RContourBaseCircle (const Double_t xc, const Double_t yc, const Double_t r)
	RContourBaseCircle (const RContourBaseCircle &ct)
RContourBaseCircle &	operator= (const RContourBaseCircle &ct)
virtual	~RContourBaseCircle ()
virtual bool	Compare (const RContourBase *ct_ptr) const
virtual TList *	CreateObjectList () const
virtual bool	WriteData (ostream &os) const
virtual bool	WriteData (FILE *fptr) const
virtual bool	CheckPoint (const Double_t x, const Double_t y) const
virtual bool	CheckPoint (const RPoint2D &p) const
virtual Int_t	Type () const
virtual string	TypeName () const
virtual Double_t	NormalisedDistance (const RPoint2D &p) const
virtual Double_t	GetRadius () const
virtual RPoint2D	GetCenter () const
virtual void	SetCenter (const RPoint2D ctr)
virtual void	SetRadius (const Double_t r)
	ClassDef (RContourBaseCircle, 0)
Public Member Functions inherited from RContourBase2D
	RContourBase2D ()
	RContourBase2D (const RContourBase2D &ct)
RContourBase2D &	operator= (const RContourBase2D &ct)
virtual	~RContourBase2D ()
virtual bool	CheckValue (const Double_t val) const
virtual Int_t	Dimension () const
	ClassDef (RContourBase2D, 0)
Public Member Functions inherited from RContourBase
	RContourBase ()
	RContourBase (const RContourBase &ct)
RContourBase &	operator= (const RContourBase &ct)
virtual	~RContourBase ()
virtual bool	operator== (const RContourBase &ct) const
virtual bool	operator!= (const RContourBase &ct) const
virtual void	SetFlipAxis (const bool flip=true)
virtual bool	GetFlipAxis () const
virtual bool	Write (ostream &os) const
virtual bool	Write (FILE *fptr) const
	ClassDef (RContourBase, 0)

Static Public Member Functions
static RContourBaseCircle *	ReadNew (istream &is)
static RContourBaseCircle *	ReadNew (FILE *fptr)
Static Public Member Functions inherited from RContourBase
static RContourBase *	ReadNew (istream &is)
static RContourBase *	ReadNew (FILE *fptr)

Protected Attributes
RPoint2D	center
	Circle center.
Double_t	radius
	Circle radius.
Protected Attributes inherited from RContourBase
bool	flip_axis
	Axis inversion.

Private Member Functions
	GObject (RContourBaseCircle)

Additional Inherited Members

Detailed Description

Class for circle contour parameters.

Constructor & Destructor Documentation

RContourBaseCircle::RContourBaseCircle

(

const Double_t

r = 1.

)

Constructor for circle center at (0,0) and radius r.

Parameters

r	circle radius

References center, RVector2D::null, and radius.

Referenced by ReadNew().

RContourBaseCircle::RContourBaseCircle	(	const RPoint2D	ctr,
		const Double_t	r
	)

Constructor for circle center ctr and radius r.

Parameters

ctr	circle center
r	circle radius

References center, and radius.

RContourBaseCircle::RContourBaseCircle	(	const Double_t	xc,
		const Double_t	yc,
		const Double_t	r
	)

Constructor for circle center (xc,yc) and radius r.

Parameters

xc	center X position
yc	center Y position
r	circle radius

References center, and radius.

RContourBaseCircle::RContourBaseCircle

(

const RContourBaseCircle &

ct

)

Copy constructor.

Parameters

ct	contour to copy

References center, and radius.

RContourBaseCircle::~RContourBaseCircle ( )

virtual

Destructor.

Member Function Documentation

RContourBaseCircle::GObject ( RContourBaseCircle  )

private

Macro from GCpp library that defines the following functions:

• ClassName(): return the real class name of the object
• StaticClassName(): return the used class name of the object (that may be a base class of the real object).
• IsInstanceOf<T>(): return true if the current object is an instance of the template class name argument
• Clone(): return an allocated copy of the object.

RContourBaseCircle & RContourBaseCircle::operator=

(

const RContourBaseCircle &

ct

)

Affectation operator.

Parameters

ct	contour to copy

References center, and radius.

bool RContourBaseCircle::Compare ( const RContourBase *  ct_ptr ) const

virtual

Comparison function, operating only on content, not on name.

Parameters

ct_ptr

pointer to compared contour

Implements RContourBase.

References GetCenter(), GetRadius(), RContourBase::Type(), and RVector2D::zero.

TList * RContourBaseCircle::CreateObjectList ( ) const

virtual

Creation of associated ROOT objects list: a new list is created (allocated) and its pointer is returned.

Implements RContourBase.

References RContourBase::flip_axis, GetCenter(), and GetRadius().

bool RContourBaseCircle::WriteData ( ostream &  os ) const

virtual

Write contour data in an output C++ stream.

Parameters

os	output C++ stream

Implements RContourBase.

References GetCenter(), and GetRadius().

bool RContourBaseCircle::WriteData ( FILE *  fptr ) const

virtual

Write contour data in an output C-style file.

Parameters

fptr	C-style file pointer

Implements RContourBase.

References GetCenter(), and GetRadius().

RContourBaseCircle * RContourBaseCircle::ReadNew ( istream &  is )

static

Read contour data from an input C++ stream, and return the allocated pointer.

Parameters

is	input C++ stream

References RContourBaseCircle().

Referenced by RContourBase::ReadNew().

RContourBaseCircle * RContourBaseCircle::ReadNew ( FILE *  fptr )

static

Read contour data from an input C-style file, and return the allocated pointer.

Parameters

fptr	input C-style file pointer

References RContourBaseCircle().

bool RContourBaseCircle::CheckPoint ( const Double_t  x, const Double_t  y  ) const

inlinevirtual

Check whether a point (x,y) is inside a contour.

Parameters

x	point X position
y	point Y position

Reimplemented from RContourBase2D.

bool RContourBaseCircle::CheckPoint ( const RPoint2D &  p ) const

inlinevirtual

Check whether a point is inside a contour.

Parameters

p

point

Implements RContourBase2D.

References center, and radius.

Int_t RContourBaseCircle::Type ( ) const

inlinevirtual

Return contour type identifier.

Implements RContourBase.

string RContourBaseCircle::TypeName ( ) const

inlinevirtual

Return contour type name.

Implements RContourBase.

Double_t RContourBaseCircle::NormalisedDistance ( const RPoint2D &  p ) const

inlinevirtual

Get normalized distance (expressed in radius units) between a point and the circle center: from 0 (at center) to 1 (on circle) and more than 1 outside.

Parameters

p

point

References center, and radius.

Double_t RContourBaseCircle::GetRadius ( ) const

inlinevirtual

Get circle radius.

References radius.

Referenced by Compare(), CreateObjectList(), RGContourEdit::UpdateContourInfo(), and WriteData().

RPoint2D RContourBaseCircle::GetCenter ( ) const

inlinevirtual

Get circle center.

References center.

Referenced by Compare(), CreateObjectList(), and WriteData().

void RContourBaseCircle::SetCenter ( const RPoint2D  ctr )

inlinevirtual

Set circle center

Parameters

ctr

center

References center.

void RContourBaseCircle::SetRadius ( const Double_t  r )

inlinevirtual

Set circle raius

Parameters

r

radius

References radius.

RContourBaseCircle::ClassDef	(	RContourBaseCircle	,
		0
	)

For ROOT dictionary.

---

The documentation for this class was generated from the following files:

• RContourBaseCircle.hh
• RContourBaseCircle.icc
• RContourBaseCircle.cpp