BLCMDtimentuple Class Reference

Inheritance diagram for BLCMDtimentuple:

List of all members.

---

Detailed Description

class BLCMDtimentuple - implements a time NTuple Each command of this class generates an NTuple of the beam at a specified global time.

This is a "perfect" detector in that it does not perturb the beam at all, and intrinsically has the resolution of a float (it measures position and momentum and time).

The userSteppingAction() for the timentuple is called for every volume, and checks if the step brackets the time specified; if so it linearly interpolates to the specified time and enters the result into the NTuple.

Note that if a BLCoordinates instance is linked into the track, its centerline coordinates are used; otherwise global coordinates are used.

Public Member Functions
	BLCMDtimentuple ()
	Default constructor.
virtual	~BLCMDtimentuple ()
	Destructor.
	BLCMDtimentuple (const BLCMDtimentuple &r)
	Copy constructor.
G4String	commandName ()
	commandName() returns "timentuple".
int	command (BLArgumentVector &argv, BLArgumentMap &namedArgs)
	command() implements the timentuple command.
void	defineNamedArgs ()
	defineNamedArgs() defines the named arguments for the command.
void	help (bool detailed)
	help() prints help text.
void	setName (G4String _name)
Private Attributes
G4double	time
G4String	name
G4String	format
G4String	filename
G4String	require
G4String	coordinates
G4int	referenceParticle
BLCoordinateType	coordinateType

---

Constructor & Destructor Documentation

BLCMDtimentuple::BLCMDtimentuple

(

)

Default constructor.

References BLCMDTYPE_DATA, BLCOORD_CENTERLINE, coordinates, coordinateType, filename, format, name, referenceParticle, BLCommand::registerCommand(), require, BLCommand::setDescription(), BLCommand::setSynopsis(), and time.

Referenced by command().

                                 : BLCommand()
{
        registerCommand(BLCMDTYPE_DATA);
        setSynopsis("Construct an NTuple of tracks at a specified time.");
        setDescription("A time NTuple generates an NTuple of every track at a\n"
                "specified global time.\n"
                "It uses a linear interpolation in the step that straddles "
                "the required time, so accuracy will suffer for large steps. "
                "The NTuple uses centerline coordinates, if available.\n\n"
                "The standard NTuple fields are:\n"
                "    x,y,z (mm)\n"
                "    Px,Py,Pz (MeV/c)\n"
                "    t (ns)\n"
                "    PDGid (11=e-, 13=mu-, 22=gamma, 211=pi+, 2212=proton, ...)\n"
                "    EventID (may be inexact above 16,777,215)\n"
                "    TrackID\n"
                "    ParentID (0 => primary particle)\n"
                "    Weight (defaults to 1.0)\n\n"
                "The following additional fields are appended for "
                "format=Extended, format=asciiExtended, and "
                "format=rootExtended:\n"
                "    Bx, By, Bz (Tesla)\n"
                "    Ex, Ey, Ez (Megavolts/meter)\n"
                "    ProperTime (ns)\n"
                "    PathLength (mm)\n"
                "    PolX, PolY, PolZ (polarization)\n"
                "    InitialKE (MeV when track was created)\n\n"
                "Valid Formats (ignore case): ");
        
        time = 0.0;
        name = "";
        format = "";
        filename = "";
        require = "";
        coordinates = "Centerline";
        referenceParticle = 0;
        coordinateType = BLCOORD_CENTERLINE;
}

BLCMDtimentuple::~BLCMDtimentuple

(

)

[virtual]

Destructor.

{
}

BLCMDtimentuple::BLCMDtimentuple

(

const BLCMDtimentuple &

r

)

Copy constructor.

References coordinates, coordinateType, filename, format, name, referenceParticle, require, and time.

                                                         : BLCommand(r)
{
        time = r.time;
        name = r.name;
        format = r.format;
        filename = r.filename;
        G4String require;
        coordinates = r.coordinates;
        referenceParticle = r.referenceParticle;
        coordinateType = r.coordinateType;
}

---

Member Function Documentation

G4String BLCMDtimentuple::commandName

(

)

[inline, virtual]

commandName() returns "timentuple".

Implements BLCommand.

{ return "timentuple"; }

int BLCMDtimentuple::command	(	BLArgumentVector &	argv,
		BLArgumentMap &	namedArgs
	)			[virtual]

command() implements the timentuple command.

Implements BLCommand.

References BLCMDtimentuple(), coordinates, coordinateType, filename, format, BLCoordinates::getCoordinateType(), BLManager::getObject(), BLCommand::handleNamedArgs(), name, BLCommand::print(), BLCommand::printError(), referenceParticle, BLManager::registerBeamStep(), BLManager::registerReferenceParticleStep(), require, setName(), and time.

{
        if(argv.size() != 1) {
                printError("timentuple: Invalid command, must have name");
                return -1;
        }

        if(argv[0] == "default") {
                return handleNamedArgs(namedArgs);
        }

        BLCMDtimentuple *t = new BLCMDtimentuple(defaultTimeNTuple);
        t->setName(argv[0]);
        int retval = t->handleNamedArgs(namedArgs);

        t->coordinateType = BLCoordinates::getCoordinateType(t->coordinates);

        // ascii->bltrackfile format, for accuracy and consistency of output
        for(unsigned i=0; i<t->format.size(); ++i)
                t->format[i] = tolower(t->format[i]);
        if(t->format == "ascii")
                t->format = "bltrackfile";

        t->print(argv[0]);

        TimeNTuple *tn = new TimeNTuple(t->name,t->time,t->format,t->filename,
                                                t->require,t->coordinateType);
        BLManager::getObject()->registerBeamStep(0,tn);
        if(t->referenceParticle != 0)
                BLManager::getObject()->registerReferenceParticleStep(0,tn);

        return retval;
}

void BLCMDtimentuple::defineNamedArgs

(

)

[virtual]

defineNamedArgs() defines the named arguments for the command.

Reimplemented from BLCommand.

References BLCommand::argDouble(), BLCommand::argInt(), BLCommand::argString(), coordinates, filename, format, referenceParticle, require, and time.

{
        argDouble(time,"time","The global time of the sampling (ns).");
        argString(format,"format","The NTuple format (see above for list).");
        argString(filename,"filename","The filename of the NTuple.");
        argString(filename,"file","Synonym for filename.");
        argString(require,"require","Expression which must be nonzero to include the track (default=1)",false);
        argString(coordinates,"coordinates","Coordinates: global, centerline, or reference (default=c).");
        argInt(referenceParticle,"referenceParticle","Set to 1 to include the Reference Particle.");
}

void BLCMDtimentuple::help

(

bool

detailed

)

[inline, virtual]

help() prints help text.

Reimplemented from BLCommand.

References BLCommand::description, BLTrackNTuple::getFormatList(), and BLCommand::help().

                                 {
                if(description[description.size()-2] == ':')
                        description += BLTrackNTuple::getFormatList(); 
                BLCommand::help(detailed);
        }

void BLCMDtimentuple::setName

(

G4String

_name

)

[inline]

References name.

Referenced by command().

{ name = _name; }

---

Member Data Documentation

G4double BLCMDtimentuple::time [private]

Referenced by BLCMDtimentuple(), command(), and defineNamedArgs().

G4String BLCMDtimentuple::name [private]

Referenced by BLCMDtimentuple(), command(), and setName().

G4String BLCMDtimentuple::format [private]

Referenced by BLCMDtimentuple(), command(), and defineNamedArgs().

G4String BLCMDtimentuple::filename [private]

Referenced by BLCMDtimentuple(), command(), and defineNamedArgs().

G4String BLCMDtimentuple::require [private]

Referenced by BLCMDtimentuple(), command(), and defineNamedArgs().

G4String BLCMDtimentuple::coordinates [private]

Referenced by BLCMDtimentuple(), command(), and defineNamedArgs().

G4int BLCMDtimentuple::referenceParticle [private]

Referenced by BLCMDtimentuple(), command(), and defineNamedArgs().

BLCoordinateType BLCMDtimentuple::coordinateType [private]

Referenced by BLCMDtimentuple(), and command().

---

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

• BLCMDtimentuple.cc