Detailed Description

Base class for lines/cuts used for particle identification in 2D data maps.

This provides all methods for calculating the shortest distance between a point (x,y) in the map and the line, or for finding the relative orientation of the point and the line (above/below, left/right). These methods are modified versions of methods existing in the TGraph base class.

Note: by default, a KVIDLine cannot be graphically modified using the mouse. This is to avoid accidents! This can of course be changed either with the context menu of the line, or when using the KVIDGridManagerGUI in Edit mode.

Double_t KVIDLine::DistanceToLine(Double_t px, Double_t py, Int_t &i_near)

KVIDLine::DistanceToLine

Double_t DistanceToLine(Double_t px, Double_t py, Int_t &)

Definition: KVIDLine.h:246

Compute the closest distance of approach from point px,py to this line. The units of px, py are the same as the coordinates of the graph. WARNING: can be NEGATIVE - see below.

The distance from the point to each segment is calculated in turn.

If the point lies between the endpoints of at least one segment, the returned distance will be the closest of these segments. In this case i_near gives the index of the first point of the closest segment.

If not then the distance is the smallest distance between the endpoint of a segment and the point. In this case i_near gives the index of the closest endpoint. If the closest segment-endpoint is not one of the endpoints of the whole line, the returned distance is positive. On the other hand, if the closest part of the line to the point is one of the two endpoints of the line, the returned distance is NEGATIVE.

Double_t KVIDLine::DistanceToLine(Double_t px, Double_t py, Double_t xp1, Double_t yp1, Double_t xp2, Double_t yp2, Int_t &i_nearest_point)

Given a line segment defined by endpoints (xp1,yp1) and (xp2,yp2) find the shortest distance between point (px,py) and the line.

                                             M
P1 (xp1,yp1) x---------------------------------------x P2 (xp2,yp2)
                                                |
                                                |
                                                |
                                                |
                                                |
                                                x
                                                          P (px,py)

This is simply the magnitude of the component of vector P1->P (or P2->P) perpendicular to P1->P2.

If the point is indeed between the two endpoints as shown, then \(P1M + P2M = P1P2\). If not, \(P1M + P2M > P1P2\). In this case the closest distance is that to the nearer of the two endpoints, but the value returned is negative; i_nearest_point gives the index (0 or 1) of the nearer endpoint

Bool_t KVIDLine::PosRelToLine(Option_t* opt, Double_t px, Double_t py, Double_t xp1, Double_t yp1, Double_t xp2, Double_t yp2 )

KVIDLine::PosRelToLine

Bool_t PosRelToLine(Option_t *opt, Double_t px, Double_t py, Double_t xp1, Double_t yp1, Double_t xp2, Double_t yp2)

Given a line segment defined by endpoints (xp1,yp1) and (xp2,yp2) test the direction of (px,py) with respect to the line in the (x,y) plane.

                                                  M
P1 (xp1,yp1) x---------------------------------------x P2 (xp2,yp2)
                                                   |
                                                   |
                                                   |
                                                   |
                                                   |
                                                   x
                                                          P (px,py)

This is given by the angle phi between vector MP (component of vector P1->P (or P2->P) perpendicular to P1->P2) and the +ve x-axis.

Point is left of line if 90<phi<270
Point is right of line if 270<phi<90
Point is above line if 0<phi<180
Point is below line if 180<phi<360

The option string is "left", "right", "above" or "below", and the result is either kTRUE or kFALSE depending on the relative position of the point and the line. E.g. in the diagram shown above, PosRelToLine("below", ...) would give kTRUE - the point is below the line.

Bool_t KVIDLine::WhereAmI(Double_t px, Double_t py, Option_t *opt)

KVIDLine::WhereAmI

Bool_t WhereAmI(Double_t px, Double_t py, Option_t *opt)

The relative position of point (px,py) with respect to the line is tested. The option string can be "left", "right", "above" or "below". WhereAmI( px, py, "above") returns kTRUE if the point is above the line etc. etc.

First of all, the closest segment/point of the line to the point is found. Then the relative position of the point and this segment/point is tested.

void KVIDLine::GetStartPoint(Double_t& x, Double_t& y) const

KVIDLine::GetStartPoint

void GetStartPoint(Double_t &x, Double_t &y) const

Coordinates of first point in line

void KVIDLine::GetEndPoint(Double_t& x, Double_t& y) const

KVIDLine::GetEndPoint

void GetEndPoint(Double_t &x, Double_t &y) const

Coordinates of last point in line

Bool_t KVIDLine::IsBetweenEndPoints(Double_t x, Double_t y, const Char_t* axis) const

KVIDLine::IsBetweenEndPoints

Bool_t IsBetweenEndPoints(Double_t x, Double_t y, const Char_t *axis="") const

Returns kTRUE for point (x,y) if :

axis = "" (default) and both x and y lie inside the endpoints of the line x1 < x < x2, y1 < y < y2
axis = "x" and x lies inside the endpoints x1 < x < x2
axis = "y" and y lies inside the endpoints y1 < y < y2

Definition at line 143 of file KVIDLine.h.

#include <KVIDLine.h>

Inheritance diagram for KVIDLine:

[legend]

Classes
class	MyVector2
	A lightweight replacement for the TVector2 class. More...

Public Member Functions
	KVIDLine ()
	Default ctor. More...

	KVIDLine (const KVIDLine &)
	copy constructor More...

	KVIDLine (const TGraph &gr)
	initialize KVIDLine using TGraph copy ctor More...

virtual	~ KVIDLine ()

Double_t	DistanceToLine (Double_t px, Double_t py, Double_t xp1, Double_t yp1, Double_t xp2, Double_t yp2, Int_t &)

Double_t	DistanceToLine (Double_t px, Double_t py, Int_t &)

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)

void	GetEndPoint (Double_t &x, Double_t &y) const

void	GetStartPoint (Double_t &x, Double_t &y) const

Bool_t	IsBetweenEndPoints (Double_t x, Double_t y, const Char_t *axis="") const

Bool_t	PosRelToLine (Option_t *opt, Double_t px, Double_t py, Double_t xp1, Double_t yp1, Double_t xp2, Double_t yp2)

virtual void	WaitForPrimitive ()

Bool_t	WhereAmI (Double_t px, Double_t py, Option_t *opt)

Public Member Functions inherited from KVIDentifier
	KVIDentifier ()
	Default constructor. More...

	KVIDentifier (const KVIDentifier &)

	KVIDentifier (const TCutG &)
	copy a TCutG More...

	KVIDentifier (const TGraph &)
	copy a TGraph More...

virtual	~KVIDentifier ()
	Destructor. More...

virtual Int_t	AddPointAtTheEnd ()

virtual void	ChechHierarchy (KVIDentifier *gr)

virtual void	CloneScaleStore (Int_t newzt, Int_t newat, Double_t dy=0., Double_t sx=1., Double_t sy=1.)

Int_t	Compare (const TObject *) const

virtual Int_t	ContinueDrawing ()
	Continue to draw an existing the line. More...

void	Copy (TObject &obj) const
	Copy attributes of this identifier into 'obj'. More...

void	CopyGraph (const TGraph &)
	Copy coordinates of points from the TGraph. More...

void	CopyGraph (TGraph *)
	Copy coordinates of points from the TGraph. More...

virtual Int_t	DecreaseNumberOfPoints ()

virtual void	Delete (Option_t *option="")

virtual void	DrawClass () const

virtual TObject *	DrawClone (Option_t *option="") const

virtual void	DrawPanel ()

virtual void	Dump () const

void	ExtendLine (bool fromBeginning, Double_t Limit, Option_t *Direction)

void	ExtendLine (Double_t, Option_t *Direction="")

virtual TFitResultPtr	Fit (const char formula, Option_t option="", Option_t *goption="", Axis_t xmin=0, Axis_t xmax=0)

virtual TFitResultPtr	Fit (TF1 f1, Option_t option="", Option_t *goption="", Axis_t xmin=0, Axis_t xmax=0)

virtual void	FitPanel ()

virtual Int_t	GetA () const

virtual Int_t	GetID () const

virtual Int_t	GetMassFormula () const

KVIDGraph *	GetParent () const
	Get pointer to parent ID graph. More...

virtual Double_t	GetPID () const

virtual Int_t	GetZ () const

virtual Int_t	IncreaseNumberOfPoints ()

virtual Int_t	InsertPoint ()
	Insert a new point at the mouse position. More...

virtual Int_t	InsertSmoothPoint ()
	Insert a new point at the mouse X position using a smooth evaluation of the Y. More...

virtual void	Inspect () const

virtual Bool_t	OnlyZId () const

virtual void	Print (Option_t *opt) const

virtual void	ReadAsciiFile (std::ifstream &)

virtual Int_t	RemoveFirstPoint ()

virtual Int_t	RemoveLastPoint ()

virtual Int_t	RemovePoint ()

virtual Int_t	RemovePoint (Int_t i)

virtual void	SaveAs (const char filename="", Option_t option="") const

virtual void	Scale (Double_t sx=-1, Double_t sy=-1)

virtual void	Scale (TF1 sx, TF1 sy)

virtual void	SetA (Int_t atnum)

virtual void	SetAandZ (Int_t atnum, Int_t ztnum)

virtual void	SetDrawOption (Option_t *option="")

virtual void	SetFillAttributes ()

virtual void	SetLineAttributes ()

virtual void	SetMarkerAttributes ()

virtual void	SetMassFormula (Int_t mf)

virtual void	SetMaximum (Double_t maximum=-1111)

virtual void	SetMinimum (Double_t minimum=-1111)

virtual void	SetName (const char *name)

virtual void	SetOnlyZId (Bool_t onlyz=kTRUE)

void	SetParent (KVIDGraph *)
	Set pointer to parent ID graph. More...

virtual void	SetTitle (const char *title="")

virtual void	SetZ (Int_t ztnum)

virtual Int_t	SortPoints (Bool_t ascending=kTRUE)

virtual Bool_t	TestPoint (Double_t, Double_t)

virtual void	WriteAsciiFile (std::ofstream &, const Char_t *name_prefix="")

Static Public Member Functions
static KVIDLine *	MakeIDLine (TObject *obj, Double_t xdeb=-1., Double_t xfin=-1., Double_t np=1., Bool_t save=kFALSE)

Constructor & Destructor Documentation

◆ KVIDLine() [1/3]

KVIDLine::KVIDLine ( )

Default ctor.

Definition at line 38 of file KVIDLine.cpp.

◆ KVIDLine() [2/3]

KVIDLine::KVIDLine ( const TGraph & gr )

initialize KVIDLine using TGraph copy ctor

Definition at line 69 of file KVIDLine.cpp.

◆ KVIDLine() [3/3]

KVIDLine::KVIDLine ( const KVIDLine & obj )

copy constructor

Definition at line 58 of file KVIDLine.cpp.

◆ ~ KVIDLine()

virtual KVIDLine::~ KVIDLine ( )

virtual

Member Function Documentation

◆ DistanceToLine() [1/2]

Double_t KVIDLine::DistanceToLine	(	Double_t	px,
		Double_t	py,
		Double_t	xp1,
		Double_t	yp1,
		Double_t	xp2,
		Double_t	yp2,
		Int_t &	i_nearest_point
	)

inline

Definition at line 310 of file KVIDLine.h.

◆ DistanceToLine() [2/2]

Double_t KVIDLine::DistanceToLine	(	Double_t	px,
		Double_t	py,
		Int_t &	i_near
	)

inline

Compute the closest distance of approach from point px,py to this line. The units of px, py are the same as the coordinates of the graph

WARNING: result can be NEGATIVE - see below.

The distance from the point to each segment is calculated in turn.

If the point lies between the endpoints of at least one segment, the returned distance will be the closest of these segments. In this case i_near gives the index of the first point of the closest segment.

If not then the distance is the smallest distance between the endpoint of a segment and the point. In this case i_near gives the index of the closest endpoint. If the closest segment-endpoint is not one of the endpoints of the whole line, the returned distance is positive. On the other hand, if the closest part of the line to the point is one of the two endpoints of the line, the returned distance is NEGATIVE.

distance = closest approach to a segment with point lying between endpoints dist2 = closest approach to a segment with point outside endpoints if distance == 9999 at end, then dist2 is used

cout << "i=" << i << " X1="<<fX[i]<<" Y1="<<fY[i]<<" X2="<<fX[i+1]<<" Y2="<<fY[i+1]<<" --- d = "<<d<<endl;

point not between endpoints of segment

closest point is an 'internal' point of line - POSITIVE distance

closest point is one of endpoints of line - NEGATIVE distance

Definition at line 246 of file KVIDLine.h.

◆ ExecuteEvent()

void KVIDLine::ExecuteEvent	(	Int_t	event,
		Int_t	px,
		Int_t	py
	)

virtual

We override the TGraph::ExecuteEvent which contains a TCutG-specific part making sure that the first and last point are the same. This is a copy of that method with the "if(InheritsFrom("TCutG"))" part commented out.

Execute action corresponding to one event.

This member function is called when a graph is clicked with the locator

If Left button clicked on one of the line end points, this point follows the cursor until button is released.

if Middle button clicked, the line is moved parallel to itself until the button is released.

Definition at line 226 of file KVIDLine.cpp.

◆ GetEndPoint()

void KVIDLine::GetEndPoint	(	Double_t &	x,
		Double_t &	y
	)		const

inline

◆ GetStartPoint()

void KVIDLine::GetStartPoint	(	Double_t &	x,
		Double_t &	y
	)		const

inline

◆ IsBetweenEndPoints()

Bool_t KVIDLine::IsBetweenEndPoints	(	Double_t	x,
		Double_t	y,
		const Char_t *	axis = `""`
	)		const

inline

◆ MakeIDLine()

KVIDLine * KVIDLine::MakeIDLine	(	TObject *	obj,
		Double_t	xdeb = `-1.`,
		Double_t	xfin = `-1.`,
		Double_t	np = `1.`,
		Bool_t	save = `kFALSE`
	)

static

create an IDLine from different objects (Inherited from TProfile, TGraph, TF1)

"xdeb" and "xfin" stand for the delimitation of the line - dafault values are -1 in this case range is the one of the considered object if the choosen range is greater than the object one, one point for each limit is added with the value corresponding to the first and/or last of the object
"np" is in the TF1 case the number point (default value 20), in the TProfile case is the minimum threshold for the bin entries (default value is one); for the TGraph case it has no effect; In the TProfile and TGraph cases the number of points are determined by the object considering the interval
"save" allow to save the TF1 or TProfile object which can be recall with the GetListofFunction() method

Definition at line 88 of file KVIDLine.cpp.

◆ PosRelToLine()

Bool_t KVIDLine::PosRelToLine	(	Option_t *	opt,
		Double_t	px,
		Double_t	py,
		Double_t	xp1,
		Double_t	yp1,
		Double_t	xp2,
		Double_t	yp2
	)

inline

◆ WaitForPrimitive()

void KVIDLine::WaitForPrimitive ( )

virtual

Method used to draw a new identifier in the active pad Override in child classes so that gPad->WaitPrimitive has correct arguments

Reimplemented from KVIDentifier.

Definition at line 194 of file KVIDLine.cpp.

◆ WhereAmI()

Bool_t KVIDLine::WhereAmI	(	Double_t	px,
		Double_t	py,
		Option_t *	opt
	)

inline

Detailed Description

Classes

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

◆ KVIDLine() [1/3]

◆ KVIDLine() [2/3]

◆ KVIDLine() [3/3]

◆ ~ KVIDLine()

Member Function Documentation

◆ DistanceToLine() [1/2]

◆ DistanceToLine() [2/2]

◆ ExecuteEvent()

◆ GetEndPoint()

◆ GetStartPoint()

◆ IsBetweenEndPoints()

◆ MakeIDLine()

◆ PosRelToLine()

◆ WaitForPrimitive()

◆ WhereAmI()