BLTrackNTuple Class Reference

#include <BLTrackNTuple.hh>

List of all members.

---

Detailed Description

class BLTrackNTuple is an interface class to an NTuple for tracks.

This class implements two new formats that add additional fields to the NTuple: asciiEnhanced, rootEnhanced.

Public Member Functions
virtual	~BLTrackNTuple ()
	Destructor.
void	close ()
	close() will close the ntuple
void	appendTrack (const G4Track *track)
	appendTrack() appends the data for this Track to the NTuple. Uses arguments to create(): If the require expression is nonempty and evaluates to zero, no entry is made to the NTuple or callbacks. If noSingles is nonzero, the NTuple itself is not filled, but callbacks are made (to fill NTuples created by the ntuple command).
void	appendTrack (const G4Track *track, double time, G4ThreeVector position, G4ThreeVector momentum, double properTime, double trackLength)
	appendTrack() appends the data for this Track, with updated values of the other arguments
G4String	getName () const
	getName() returns the name of the NTuple (not including category)
G4String	getFields ()
	getFields() returns a colon-separated list of the fields.
virtual void	annotate (G4String line)
	annotate() will add an annotation line to any ASCII format. Normally line should begin with a "#", and have no "\r" or "\n". line == "" will output an empty line to ASCII files. Ignored for NTuples that don't support annotations.
virtual bool	needsReference ()
	needsReference() returns true if this NTuple needs the Reference particle.
Static Public Member Functions
static BLTrackNTuple *	create (G4String format, G4String category, G4String name, G4String filename, BLCoordinateType coordinateType=BLCOORD_CENTERLINE, G4String _require="", int _noSingles=0)
	create() will create a new NTuple for writing. Note that the field names are handled internally, and that the format can change the fields used. format must be a known format of NTuple ("" is default). "category/name" is the name of the NTuple (the "/" may be omitted if category is null, depending on format). filename is a hint, and is not used by all formats. coordinateType is the type of coordiantes to use. require is an expression using track variables that must be nonzero to enter a Step into the NTuple. If noSingles is nonzero, the NTuple itself is not filled, but callbacks are made (to fill NTuples created by the ntuple command).
static G4String	getFormatList ()
	getFormatList() returns a list of known formats. This class implements asciiEnhanced and rootEnhanced.
Protected Member Functions
	BLTrackNTuple ()
	Constructor.
Private Attributes
BLNTuple *	ntuple
G4String	require
BLEvaluator *	eval
int	noSingles
int	nFields
BLCoordinateType	coordinateType

---

Constructor & Destructor Documentation

BLTrackNTuple::BLTrackNTuple

(

)

[protected]

Constructor.

References BLCOORD_CENTERLINE, coordinateType, eval, nFields, noSingles, ntuple, and require.

Referenced by create().

{
        ntuple = 0;
        require = "";
        eval = 0;
        noSingles = 0;
        nFields = 0;
        coordinateType = BLCOORD_CENTERLINE;
}

virtual BLTrackNTuple::~BLTrackNTuple

(

)

[inline, virtual]

Destructor.

References eval, and ntuple.

                                 { 
                if(ntuple) delete ntuple;
                if(eval) delete eval;
        }

---

Member Function Documentation

void BLTrackNTuple::close

(

)

[inline]

close() will close the ntuple

References BLNTuple::close(), and ntuple.

Referenced by TraceNTuple::close().

{ if(ntuple) ntuple->close(); ntuple = 0; }

BLTrackNTuple * BLTrackNTuple::create	(	G4String	format,
		G4String	category,
		G4String	name,
		G4String	filename,
		BLCoordinateType	coordinateType = BLCOORD_CENTERLINE,
		G4String	_require = "",
		int	_noSingles = 0
	)			[static]

create() will create a new NTuple for writing. Note that the field names are handled internally, and that the format can change the fields used. format must be a known format of NTuple ("" is default). "category/name" is the name of the NTuple (the "/" may be omitted if category is null, depending on format). filename is a hint, and is not used by all formats. coordinateType is the type of coordiantes to use. require is an expression using track variables that must be nonzero to enter a Step into the NTuple. If noSingles is nonzero, the NTuple itself is not filled, but callbacks are made (to fill NTuples created by the ntuple command).

References BLTrackNTuple(), coordinateType, BLNTuple::create(), eval, EXTENDED, fieldNames, nFields, noSingles, ntuple, require, STANDARD, and TRACE.

Referenced by BLVirtualDetectorNTuple::BLVirtualDetectorNTuple(), BLCMDnewparticlentuple::command(), BLCMDbeamlossntuple::command(), BLCMDzntuple::Entry::Entry(), TimeNTuple::TimeNTuple(), and TraceNTuple::TraceNTuple().

{
        BLTrackNTuple *t = new BLTrackNTuple();
        t->require = _require;
        t->noSingles = _noSingles;
        t->coordinateType = _coordinateType;
        t->nFields = STANDARD;

        if(t->require != "") t->eval = new BLEvaluator();

        // get nFields and fields based on format
        for(G4String::size_type i=0; i<format.size(); ++i)
                format[i] = tolower(format[i]);
        G4String::size_type j=format.find("trace");
        if(j != format.npos) {
                t->nFields = TRACE;
                format.erase(j,format.npos);
        }
        j=format.find("extended");
        if(j != format.npos) {
                t->nFields = EXTENDED;
                format.erase(j,format.npos);
        }
        j=format.find("for009");
        if(j != format.npos) {
                t->nFields = TRACE;
        }
        G4String fields=fieldNames[0];
        for(int i=1; i<t->nFields; ++i) {
                fields += ":";
                fields += fieldNames[i];
        }

        t->ntuple = BLNTuple::create(format,category,name,fields,filename);
        if(!t->ntuple) {
                delete t;
                t = 0;
        }
        return t;
}

void BLTrackNTuple::appendTrack

(

const G4Track *

track

)

appendTrack() appends the data for this Track to the NTuple. Uses arguments to create(): If the require expression is nonempty and evaluates to zero, no entry is made to the NTuple or callbacks. If noSingles is nonzero, the NTuple itself is not filled, but callbacks are made (to fill NTuples created by the ntuple command).

Referenced by TraceNTuple::appendTrace(), BLCMDbeamlossntuple::PostUserTrackingAction(), BLCMDnewparticlentuple::PreUserTrackingAction(), BLVirtualDetectorNTuple::UserSteppingAction(), TimeNTuple::UserSteppingAction(), and BLCMDzntuple::Entry::UserZSteppingAction().

{
        appendTrack(track,track->GetGlobalTime(),track->GetPosition(),
                        track->GetMomentum(),track->GetProperTime(),
                        track->GetTrackLength());
}

void BLTrackNTuple::appendTrack	(	const G4Track *	track,
		double	time,
		G4ThreeVector	position,
		G4ThreeVector	momentum,
		double	properTime,
		double	trackLength
	)

appendTrack() appends the data for this Track, with updated values of the other arguments

References BLNTuple::appendRow(), B, BLAssert, coordinateType, BLNTuple::doCallbacks(), E, eval, BLEvaluator::evaluate(), EXTENDED, fieldNames, BLCoordinates::getCoords(), BLManager::getExternalParentID(), BLManager::getExternalTrackID(), BLGlobalField::GetFieldValue(), BLGlobalField::getObject(), BLManager::getObject(), BLCoordinates::getRotation(), BLEvaluator::isOK(), BLCoordinates::isValid(), nFields, noSingles, ntuple, require, STANDARD, and TRACE.

{
        G4RunManager* runmgr = G4RunManager::GetRunManager();
        const G4Event* event = runmgr->GetCurrentEvent();
        int evId = event->GetEventID();
        G4ThreeVector globalPosition = position;

        // transform to desired coordinates, if available
        BLCoordinates *coord = (BLCoordinates *)track->GetUserInformation();
        if(coord && coord->isValid()) {
                coord->getCoords(coordinateType,position);
                momentum = coord->getRotation() * momentum;
        } else {
                printf("BLCMDvirtualdetector::SteppingAction: track has no "
                        "BLCoordinates object\n");
        }

        double data[EXTENDED];
        BLAssert((unsigned int)nFields <= sizeof(data)/sizeof(data[0]));
        data[0] = position[0]/mm;               // x (mm)
        data[1] = position[1]/mm;               // y (mm)
        data[2] = position[2]/mm;               // z (mm)
        data[3] = momentum[0]/MeV;              // Px (MeV/c)
        data[4] = momentum[1]/MeV;              // Py (MeV/c)
        data[5] = momentum[2]/MeV;              // Pz (MeV/c)
        data[6] = time/ns;                      // t (ns)
        data[7] = track->GetDefinition()->GetPDGEncoding();
        data[8] = evId;                         // Event ID
        data[9] = BLManager::getObject()->getExternalTrackID(track);
        data[10] = BLManager::getObject()->getExternalParentID(track);
        data[11] = track->GetWeight();          // Weight
        if(nFields > STANDARD) {
                G4double field[6], point[4];
                point[0] = globalPosition[0];
                point[1] = globalPosition[1];
                point[2] = globalPosition[2];
                point[3] = time;
                BLGlobalField::getObject()->GetFieldValue(point,field);
                G4ThreeVector B(field[0],field[1],field[2]);
                G4ThreeVector E(field[3],field[4],field[5]);
                if(coord && coord->isValid()) {
                        B = coord->getRotation() * B;
                        E = coord->getRotation() * E;
                }
                data[12] = B[0]/tesla;
                data[13] = B[1]/tesla;
                data[14] = B[2]/tesla;
                data[15] = E[0]/(megavolt/meter);
                data[16] = E[1]/(megavolt/meter);
                data[17] = E[2]/(megavolt/meter);
        }
        if(nFields > TRACE) {
                G4ThreeVector pol, vertexPosition;
                pol = track->GetPolarization();
                if(coord && coord->isValid()) {
                        pol = coord->getRotation() * pol;
                }
                vertexPosition = track->GetVertexPosition();
                data[18] = properTime/ns;
                data[19] = trackLength/mm;
                data[20] = pol[0];
                data[21] = pol[1];
                data[22] = pol[2];
                data[23] = vertexPosition[0]/mm;
                data[24] = vertexPosition[1]/mm;
                data[25] = vertexPosition[2]/mm;
                data[26] = (time - track->GetLocalTime())/ns;
                data[27] = track->GetVertexKineticEnergy()/MeV;
        }

        // implement require
        if(eval) {
                for(int i=0; i<nFields; ++i)
                        eval->setVariable(fieldNames[i],data[i]);
                double v=eval->evaluate(require.c_str());
                if(!eval->isOK())
                        G4Exception("BLTrackNTuple",
                                "Invalid require expression",
                                FatalException,require);
                if(fabs(v) < 1.0e-16) return;
        }

        if(noSingles) 
                ntuple->doCallbacks(data,nFields);
        else
                ntuple->appendRow(data,nFields); // calls coCallbacks()
}

G4String BLTrackNTuple::getName

(

)

const [inline]

getName() returns the name of the NTuple (not including category)

References BLNTuple::getName(), and ntuple.

{ return ntuple->getName(); }

G4String BLTrackNTuple::getFields

(

)

[inline]

getFields() returns a colon-separated list of the fields.

References BLNTuple::getFields(), and ntuple.

{ return ntuple->getFields(); }

virtual void BLTrackNTuple::annotate

(

G4String

line

)

[inline, virtual]

annotate() will add an annotation line to any ASCII format. Normally line should begin with a "#", and have no "\r" or "\n". line == "" will output an empty line to ASCII files. Ignored for NTuples that don't support annotations.

References BLNTuple::annotate(), and ntuple.

Referenced by TraceNTuple::annotate().

{ ntuple->annotate(line); }

virtual bool BLTrackNTuple::needsReference

(

)

[inline, virtual]

needsReference() returns true if this NTuple needs the Reference particle.

References BLNTuple::needsReference(), and ntuple.

Referenced by BLCMDzntuple::callback(), and BLVirtualDetectorNTuple::needsReference().

{ return ntuple->needsReference(); }

G4String BLTrackNTuple::getFormatList

(

)

[static]

getFormatList() returns a list of known formats. This class implements asciiEnhanced and rootEnhanced.

References BLNTuple::getFormatList().

Referenced by BLCMDzntuple::help(), BLCMDvirtualdetector::help(), BLCMDtrace::help(), BLCMDtimentuple::help(), BLCMDnewparticlentuple::help(), and BLCMDbeamlossntuple::help().

{
        G4String s = BLNTuple::getFormatList();
        s += " Extended asciiExtended";
        if(s.find("root") != s.npos) s += " rootExtended";
        return s;
}

---

Member Data Documentation

BLNTuple* BLTrackNTuple::ntuple [private]

Referenced by annotate(), appendTrack(), BLTrackNTuple(), close(), create(), getFields(), getName(), needsReference(), and ~BLTrackNTuple().

G4String BLTrackNTuple::require [private]

Referenced by appendTrack(), BLTrackNTuple(), and create().

BLEvaluator* BLTrackNTuple::eval [private]

Referenced by appendTrack(), BLTrackNTuple(), create(), and ~BLTrackNTuple().

int BLTrackNTuple::noSingles [private]

Referenced by appendTrack(), BLTrackNTuple(), and create().

int BLTrackNTuple::nFields [private]

Referenced by appendTrack(), BLTrackNTuple(), and create().

BLCoordinateType BLTrackNTuple::coordinateType [private]

Referenced by appendTrack(), BLTrackNTuple(), and create().

---

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

• BLTrackNTuple.hh
• BLTrackNTuple.cc