Base finder class for patterns.

A pattern is specifying a division type which applies only to a given shape type. The implemented patterns are for the moment equidistant slices on different axis. Implemented patterns are:

TGeoPatternX - a X axis divison pattern
TGeoPatternY - a Y axis divison pattern
TGeoPatternZ - a Z axis divison pattern
TGeoPatternParaX - a X axis divison pattern for PARA shape
TGeoPatternParaY - a Y axis divison pattern for PARA shape
TGeoPatternParaZ - a Z axis divison pattern for PARA shape
TGeoPatternTrapZ - a Z axis divison pattern for TRAP or GTRA shapes
TGeoPatternCylR - a cylindrical R divison pattern
TGeoPatternCylPhi - a cylindrical phi divison pattern
TGeoPatternSphR - a spherical R divison pattern
TGeoPatternSphTheta - a spherical theta divison pattern
TGeoPatternSphPhi - a spherical phi divison pattern
TGeoPatternHoneycomb - a divison pattern specialized for honeycombs

Definition at line 31 of file TGeoPatternFinder.h.

Classes
struct	ThreadData_t

Public Member Functions
	TGeoPatternFinder ()
	Default constructor. More...

	TGeoPatternFinder (TGeoVolume *vol, Int_t ndiv)
	Default constructor. More...

virtual	~TGeoPatternFinder ()
	Destructor. More...

virtual void	cd (Int_t)

virtual TGeoNode *	CdNext ()
	Make next node (if any) current. More...

void	ClearThreadData () const

virtual TGeoMatrix *	CreateMatrix () const =0

void	CreateThreadData (Int_t nthreads)
	Create thread data for n threads max. More...

virtual TGeoNode *	FindNode (Double_t , const Double_t =0)

virtual Int_t	GetByteCount () const

Int_t	GetCurrent ()
	Return current index. More...

virtual Int_t	GetDivAxis ()

Int_t	GetDivIndex ()

Double_t	GetEnd () const

virtual TGeoMatrix *	GetMatrix ()
	Return current matrix. More...

Int_t	GetNdiv () const

Int_t	GetNext () const
	Get index of next division. More...

TGeoNode *	GetNodeOffset (Int_t idiv)

Double_t	GetStart () const

Double_t	GetStep () const

ThreadData_t &	GetThreadData () const

TGeoVolume *	GetVolume () const

virtual Bool_t	IsOnBoundary (const Double_t *) const

Bool_t	IsReflected () const

Bool_t	IsSpacedOut () const

virtual TGeoPatternFinder *	MakeCopy (Bool_t reflect=kFALSE)=0

void	Reflect (Bool_t flag=kTRUE)

void	SetDivIndex (Int_t index)

void	SetNext (Int_t index)
	Set index of next division. More...

void	SetRange (Double_t start, Double_t step, Int_t ndivisions)
	Set division range. Use this method only when dividing an assembly. More...

void	SetSpacedOut (Bool_t flag)

void	SetVolume (TGeoVolume *vol)

virtual void	UpdateMatrix (Int_t, TGeoHMatrix &) const

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor. More...

	TObject (const TObject &object)
	TObject copy ctor. More...

virtual	~TObject ()
	TObject destructor. More...

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad. More...

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action. More...

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...

virtual const char *	ClassName () const
	Returns name of class to which the object belongs. More...

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility. More...

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method. More...

virtual void	Copy (TObject &object) const
	Copy this to obj. More...

virtual void	Delete (Option_t *option="")
	Delete this object. More...

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object. More...

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects. More...

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs. More...

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad for instance with: `gROOT->SetSelectedPad(gPad)`. More...

virtual void	Dump () const
	Dump contents of object on stdout. More...

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message. More...

virtual void	Execute (const char method, const char params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g. More...

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray. More...

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py). More...

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message. More...

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes. More...

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes. More...

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object. More...

virtual const char *	GetIconName () const
	Returns mime type name of object. More...

virtual const char *	GetName () const
	Returns name of object. More...

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py). More...

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object. More...

virtual UInt_t	GetUniqueID () const
	Return the unique object id. More...

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out. More...

virtual ULong_t	Hash () const
	Return hash value for this object. More...

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message. More...

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname". More...

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl. More...

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas. More...

void	InvertBit (UInt_t f)

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory). More...

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout. More...

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification. More...

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete. More...

void	operator delete (void *ptr)
	Operator delete. More...

void	operator delete[] (void *ptr)
	Operator delete []. More...

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator. More...

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself. More...

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list. More...

virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself. More...

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory. More...

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list. More...

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename. More...

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out". More...

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f. More...

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object. More...

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id. More...

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message. More...

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message. More...

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory. More...

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory. More...

Protected Types
enum	EGeoPatternFlags { kPatternReflected = BIT(14) , kPatternSpacedOut = BIT(15) }

Protected Member Functions
	TGeoPatternFinder (const TGeoPatternFinder &)
	Mutex for thread data. More...

TGeoPatternFinder &	operator= (const TGeoPatternFinder &)
	assignment operator More...

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected). More...

void	MakeZombie ()

Protected Attributes
Int_t	fDivIndex

Double_t	fEnd

std::mutex	fMutex
	Size of the thread vector. More...

Int_t	fNdivisions

Double_t	fStart

Double_t	fStep

std::vector< ThreadData_t * >	fThreadData

Int_t	fThreadSize
	Vector of thread private transient data. More...

TGeoVolume *	fVolume

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }

enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }

enum	EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) }

Static Public Member Functions inherited from TObject
static Long_t	GetDtorOnly ()
	Return destructor only flag. More...

static Bool_t	GetObjectStat ()
	Get status of object stat flag. More...

static void	SetDtorOnly (void *obj)
	Set destructor only flag. More...

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable. More...

#include <TGeoPatternFinder.h>

Inheritance diagram for TGeoPatternFinder:

[legend]

Member Enumeration Documentation

◆ EGeoPatternFlags

enum TGeoPatternFinder::EGeoPatternFlags

protected

Enumerator
kPatternReflected
kPatternSpacedOut

Definition at line 51 of file TGeoPatternFinder.h.

Constructor & Destructor Documentation

◆ TGeoPatternFinder() [1/3]

TGeoPatternFinder::TGeoPatternFinder ( const TGeoPatternFinder & pf )

protected

Mutex for thread data.

copy constructor

Definition at line 142 of file TGeoPatternFinder.cxx.

◆ TGeoPatternFinder() [2/3]

TGeoPatternFinder::TGeoPatternFinder ( )

Default constructor.

Definition at line 114 of file TGeoPatternFinder.cxx.

◆ TGeoPatternFinder() [3/3]

TGeoPatternFinder::TGeoPatternFinder	(	TGeoVolume *	vol,
		Int_t	ndiv
	)

Default constructor.

Definition at line 128 of file TGeoPatternFinder.cxx.

◆ ~TGeoPatternFinder()

TGeoPatternFinder::~TGeoPatternFinder ( )

virtual

Destructor.

Definition at line 173 of file TGeoPatternFinder.cxx.

Member Function Documentation

◆ cd()

virtual void TGeoPatternFinder::cd ( Int_t )

inlinevirtual

Reimplemented in TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternTrapZ, TGeoPatternCylR, TGeoPatternCylPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternSphPhi, and TGeoPatternHoneycomb.

Definition at line 78 of file TGeoPatternFinder.h.

◆ CdNext()

TGeoNode * TGeoPatternFinder::CdNext ( )

virtual

Make next node (if any) current.

Definition at line 213 of file TGeoPatternFinder.cxx.

◆ ClearThreadData()

void TGeoPatternFinder::ClearThreadData ( ) const

Definition at line 82 of file TGeoPatternFinder.cxx.

◆ CreateMatrix()

virtual TGeoMatrix * TGeoPatternFinder::CreateMatrix ( ) const

pure virtual

Implemented in TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternTrapZ, TGeoPatternCylR, TGeoPatternCylPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternSphPhi, and TGeoPatternHoneycomb.

◆ CreateThreadData()

void TGeoPatternFinder::CreateThreadData ( Int_t nthreads )

Create thread data for n threads max.

Definition at line 98 of file TGeoPatternFinder.cxx.

◆ FindNode()

virtual TGeoNode * TGeoPatternFinder::FindNode	(	Double_t *	,
		const Double_t *	= `0`
	)

inlinevirtual

Reimplemented in TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternTrapZ, TGeoPatternCylR, TGeoPatternCylPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternSphPhi, and TGeoPatternHoneycomb.

Definition at line 80 of file TGeoPatternFinder.h.

◆ GetByteCount()

virtual Int_t TGeoPatternFinder::GetByteCount ( ) const

inlinevirtual

Definition at line 81 of file TGeoPatternFinder.h.

◆ GetCurrent()

Int_t TGeoPatternFinder::GetCurrent ( )

Return current index.

Definition at line 181 of file TGeoPatternFinder.cxx.

◆ GetDivAxis()

virtual Int_t TGeoPatternFinder::GetDivAxis ( )

inlinevirtual

Reimplemented in TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternTrapZ, TGeoPatternCylR, TGeoPatternCylPhi, TGeoPatternSphR, TGeoPatternSphTheta, and TGeoPatternSphPhi.

Definition at line 84 of file TGeoPatternFinder.h.

◆ GetDivIndex()

Int_t TGeoPatternFinder::GetDivIndex ( )

inline

Definition at line 83 of file TGeoPatternFinder.h.

◆ GetEnd()

Double_t TGeoPatternFinder::GetEnd ( ) const

inline

Definition at line 91 of file TGeoPatternFinder.h.

◆ GetMatrix()

TGeoMatrix * TGeoPatternFinder::GetMatrix ( )

virtual

Return current matrix.

Definition at line 189 of file TGeoPatternFinder.cxx.

◆ GetNdiv()

Int_t TGeoPatternFinder::GetNdiv ( ) const

inline

Definition at line 86 of file TGeoPatternFinder.h.

◆ GetNext()

Int_t TGeoPatternFinder::GetNext ( ) const

Get index of next division.

Definition at line 197 of file TGeoPatternFinder.cxx.

◆ GetNodeOffset()

TGeoNode * TGeoPatternFinder::GetNodeOffset ( Int_t idiv )

inline

Definition at line 88 of file TGeoPatternFinder.h.

◆ GetStart()

Double_t TGeoPatternFinder::GetStart ( ) const

inline

Definition at line 89 of file TGeoPatternFinder.h.

◆ GetStep()

Double_t TGeoPatternFinder::GetStep ( ) const

inline

Definition at line 90 of file TGeoPatternFinder.h.

◆ GetThreadData()

TGeoPatternFinder::ThreadData_t & TGeoPatternFinder::GetThreadData ( ) const

Definition at line 74 of file TGeoPatternFinder.cxx.

◆ GetVolume()

TGeoVolume * TGeoPatternFinder::GetVolume ( ) const

inline

Definition at line 92 of file TGeoPatternFinder.h.

◆ IsOnBoundary()

virtual Bool_t TGeoPatternFinder::IsOnBoundary ( const Double_t * ) const

inlinevirtual

Reimplemented in TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternTrapZ, TGeoPatternCylR, TGeoPatternCylPhi, and TGeoPatternSphPhi.

Definition at line 93 of file TGeoPatternFinder.h.

◆ IsReflected()

Bool_t TGeoPatternFinder::IsReflected ( ) const

inline

Definition at line 94 of file TGeoPatternFinder.h.

◆ IsSpacedOut()

Bool_t TGeoPatternFinder::IsSpacedOut ( ) const

inline

Definition at line 95 of file TGeoPatternFinder.h.

◆ MakeCopy()

virtual TGeoPatternFinder * TGeoPatternFinder::MakeCopy ( Bool_t reflect = kFALSE )

pure virtual

Implemented in TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternTrapZ, TGeoPatternCylR, TGeoPatternCylPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternSphPhi, and TGeoPatternHoneycomb.

◆ operator=()

TGeoPatternFinder & TGeoPatternFinder::operator= ( const TGeoPatternFinder & pf )

protected

assignment operator

Definition at line 156 of file TGeoPatternFinder.cxx.

◆ Reflect()

void TGeoPatternFinder::Reflect ( Bool_t flag = kTRUE )

inline

Definition at line 98 of file TGeoPatternFinder.h.

◆ SetDivIndex()

void TGeoPatternFinder::SetDivIndex ( Int_t index )

inline

Definition at line 99 of file TGeoPatternFinder.h.

◆ SetNext()

void TGeoPatternFinder::SetNext ( Int_t index )

Set index of next division.

Definition at line 205 of file TGeoPatternFinder.cxx.

◆ SetRange()

void TGeoPatternFinder::SetRange	(	Double_t	start,
		Double_t	step,
		Int_t	ndivisions
	)

Set division range. Use this method only when dividing an assembly.

Definition at line 224 of file TGeoPatternFinder.cxx.

◆ SetSpacedOut()

void TGeoPatternFinder::SetSpacedOut ( Bool_t flag )

inline

Definition at line 102 of file TGeoPatternFinder.h.

◆ SetVolume()

void TGeoPatternFinder::SetVolume ( TGeoVolume * vol )

inline

Definition at line 103 of file TGeoPatternFinder.h.

◆ UpdateMatrix()

virtual void TGeoPatternFinder::UpdateMatrix	(	Int_t	,
		TGeoHMatrix &
	)		const

inlinevirtual

Reimplemented in TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternTrapZ, TGeoPatternCylR, TGeoPatternCylPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternSphPhi, and TGeoPatternHoneycomb.

Definition at line 104 of file TGeoPatternFinder.h.

Member Data Documentation

◆ fDivIndex

Int_t TGeoPatternFinder::fDivIndex

protected

Definition at line 59 of file TGeoPatternFinder.h.

◆ fEnd

Double_t TGeoPatternFinder::fEnd

protected

Definition at line 57 of file TGeoPatternFinder.h.

◆ fMutex

std::mutex TGeoPatternFinder::fMutex

mutableprotected

Size of the thread vector.

Definition at line 64 of file TGeoPatternFinder.h.

◆ fNdivisions

Int_t TGeoPatternFinder::fNdivisions

protected

Definition at line 58 of file TGeoPatternFinder.h.

◆ fStart

Double_t TGeoPatternFinder::fStart

protected

Definition at line 56 of file TGeoPatternFinder.h.

◆ fStep

Double_t TGeoPatternFinder::fStep

protected

Definition at line 55 of file TGeoPatternFinder.h.

◆ fThreadData

std::vector<ThreadData_t*> TGeoPatternFinder::fThreadData

mutableprotected

Definition at line 62 of file TGeoPatternFinder.h.

◆ fThreadSize

Int_t TGeoPatternFinder::fThreadSize

mutableprotected

Vector of thread private transient data.

Definition at line 63 of file TGeoPatternFinder.h.

◆ fVolume

TGeoVolume* TGeoPatternFinder::fVolume

protected

Definition at line 60 of file TGeoPatternFinder.h.

Libraries for TGeoPatternFinder:

[legend]

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ EGeoPatternFlags

Constructor & Destructor Documentation

◆ TGeoPatternFinder() [1/3]

◆ TGeoPatternFinder() [2/3]

◆ TGeoPatternFinder() [3/3]

◆ ~TGeoPatternFinder()

Member Function Documentation

◆ cd()

◆ CdNext()

◆ ClearThreadData()

◆ CreateMatrix()

◆ CreateThreadData()

◆ FindNode()

◆ GetByteCount()

◆ GetCurrent()

◆ GetDivAxis()

◆ GetDivIndex()

◆ GetEnd()

◆ GetMatrix()

◆ GetNdiv()

◆ GetNext()

◆ GetNodeOffset()

◆ GetStart()

◆ GetStep()

◆ GetThreadData()

◆ GetVolume()

◆ IsOnBoundary()

◆ IsReflected()

◆ IsSpacedOut()

◆ MakeCopy()

◆ operator=()

◆ Reflect()

◆ SetDivIndex()

◆ SetNext()

◆ SetRange()

◆ SetSpacedOut()

◆ SetVolume()

◆ UpdateMatrix()

Member Data Documentation

◆ fDivIndex

◆ fEnd

◆ fMutex

◆ fNdivisions

◆ fStart

◆ fStep

◆ fThreadData

◆ fThreadSize

◆ fVolume