BLCMDtrackermode Class Reference

Inheritance diagram for BLCMDtrackermode:

List of all members.

---

Detailed Description

class BLCMDtrackermode sets the mode for all trackers, and manages track fitting.

modes: true normal g4beamline operation; the "true" track is tracked. Same as if no trackermode command was given. fit special BLRunManager mode in which the Root file from an earlier run is read for the TrackerHits NTuple, and a track is fit to each such track. both special BLRunManager mode in which a single event is simulated, and then a track is fitted to the first track in each tracker. Primarily for testing.

Public Member Functions
	BLCMDtrackermode ()
G4String	commandName ()
int	command (BLArgumentVector &argv, BLArgumentMap &namedArgs)
void	defineNamedArgs ()
void	callback (int type)
	callback() from BLCallback. Implements the event loop for mode=fit and mode=both.
const G4String &	getMode () const
Private Attributes
G4String	filename
G4String	mode
G4bool	registered

---

Constructor & Destructor Documentation

BLCMDtrackermode::BLCMDtrackermode

(

)

References BLCMDTYPE_CONTROL, filename, mode, BLCommand::registerCommand(), registered, BLCommand::setDescription(), and BLCommand::setSynopsis().

                                   : BLCommand(), BLCallback()
{
        registerCommand(BLCMDTYPE_CONTROL);
        setSynopsis("Sets mode for all trackers, manages track fitting.");
        setDescription("USAGE: trackermode mode [file=...]\n"
                " mode can be any of:\n"
                "    true     tracks true tracks (normal operation)\n"
                "    fit      fits tracks to previous 'true' output\n"
                "    both     does both true and fit at once\n"
                "'fit' requires the filename argument to be the output of "
                "a previous 'true' run (filename is ignored in other modes); "
                "each tracker processes all of its tracks in the file. "
                "'true' mode simply denotes the standard G4beamline "
                "operation, and the simulated tracks are taken to be the "
                "'true' tracks of the system; the response of the tracker(s) "
                "to these tracks is then simulated in 'fit' mode. 'both' "
                "tracks a 'true' event, and then a fit is peerformed in each "
                "tracker for which its first track hit all trackerplane-s.\n\n"
                "Note that in 'true' "
                "mode every track that hits all trackerplane-s is considered, "
                "but in 'both' mode only the first track of the event can be "
                "considered.\n\n"
                "In fit mode, the filename argument MUST be different from "
                "the parameter 'histoFile', because this run must not "
                "overwrite the Root file from the previous (true) run.\n\n"
                "One trackermode command controls the mode of all trackers. "
                "'true' mode is normal G4beamline operation, and is the same "
                "as if no trackermode command was present.\n\n"
                "Note that the geometry of the system must not change "
                "between a 'true' run and a 'fit' run. You can, however, "
                "make small variations in fields to explore how errors in "
                "setting them will affect the fitted tracks. The trackerplane "
                "command can simulate survey errors.\n\n"
                "NOTE: the trackermode command must preceed all tracker "
                "commands in the input file."
        );

        filename = "";
        mode = "true";
        registered = false;
}

---

Member Function Documentation

G4String BLCMDtrackermode::commandName

(

)

[inline, virtual]

Implements BLCommand.

{ return "trackermode"; }

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

Implements BLCommand.

References filename, BLManager::getObject(), BLParam::getString(), BLCommand::handleNamedArgs(), BLCMDtracker::list, mode, Param, BLCommand::print(), BLCommand::printError(), BLManager::registerCallback(), and registered.

{
        if(registered) {
                printError("trackermode: Multiple commands not allowed");
                return -1;
        }

        if(BLCMDtracker::list.size() > 0) {
                // Ordering is required for the callbacks to work properly.
                printError("trackermode: must preceed all tracker commands.");
                return -1;
        }

        handleNamedArgs(namedArgs);

        if(argv.size() >= 1) mode = argv[0];

        if(mode == "true") {
                ;
        } else if(mode == "fit") {
                if(filename == "") 
                        printError("trackermode: mode 'fit' requires a file\n");
                if(filename == Param.getString("histoFile") ||
                   filename == (G4String)(Param.getString("histoFile")+".root"))
                        // Immediate fatal exception, trying not to clobber
                        // the Root file from the previous (true) run
                        G4Exception("trackermode","Overwriting input file",
                                FatalException, 
                                "filename must be different from histoFile");
        } else if(mode == "both") {
                ;
        } else {
                printError("trackermode: invalid mode '%s'\n",mode.c_str());
                mode = "true";
        }

        if(!registered) {
                if(mode == "true")
                        BLManager::getObject()->registerCallback(this,0);
                else
                        BLManager::getObject()->registerCallback(this,3);
                registered = true;
        }

        print(mode);

        return 0;
}

void BLCMDtrackermode::defineNamedArgs

(

)

[virtual]

Reimplemented from BLCommand.

References BLCommand::argString(), and filename.

{
        argString(filename,"filename","Filename to read for fitting tracks.");
        argString(filename,"file","Synonym for filename.");
}

void BLCMDtrackermode::callback

(

int

type

)

[virtual]

callback() from BLCallback. Implements the event loop for mode=fit and mode=both.

Reimplemented from BLCallback.

References BEAM, BLRunManager::beginEvent(), BLRunManager::beginRun(), BLAssert, BLTRACKER_FIT, BLTRACKER_TRUE, BLRunManager::endEvent(), BLRunManager::endRun(), filename, BLManager::GeneratePrimaries(), BLRunManager::getEventManager(), BLManager::getObject(), BLRunManager::getObject(), BLManager::getPhysics(), BLRunManager::getRunAborted(), BLParam::getString(), BLCMDtracker::list, mode, NORMAL, Param, BLCommand::printError(), BLPhysics::setDoStochastics(), and BLManager::setState().

{
        if(BLCMDtracker::list.size() == 0) {
                G4Exception("trackermode","No trackers",FatalException, "");
        }

        if(mode == "true") {
                BLAssert(type == 0);
                for(unsigned i=0; i<BLCMDtracker::list.size(); ++i) {
                        BLCMDtracker::list[i]->setMode(BLTRACKER_TRUE);
                }
                return;
        } else if(mode == "fit") {
                BLAssert(type==3);
                if(filename == Param.getString("histoFile") ||
                   filename == (G4String)(Param.getString("histoFile")+".root"))
                        // probably already clobbered the Root file (user
                        // could change histoFile between command() and here)
                        G4Exception("trackermode","Overwriting input file",
                                FatalException, 
                                "filename must be different from histoFile");
                for(unsigned i=0; i<BLCMDtracker::list.size(); ++i) {
                        BLCMDtracker::list[i]->handlePreviousTracks(filename);
                }
                return;
        } else if(mode != "both") {
                printError("trackermode::callback: invalid mode '%s'",
                        mode.c_str());
                return;
        }
        
        BLAssert(type==3);

        BLRunManager *runmgr = BLRunManager::getObject();
        G4EventManager *evmgr = runmgr->getEventManager();
        BLManager *mgr = BLManager::getObject();

        printf("================== Prepare Tracking Beam for Tracker Fit ==================\n");
        mgr->getPhysics()->setDoStochastics(NORMAL);
        runmgr->beginRun();

        printf("================== Begin Tracking Beam for Tracker Fit ===============\n");
        mgr->setState(BEAM);

        for(;;) {
                runmgr->beginEvent(0);
                G4Event *currentEvent = (G4Event *)runmgr->GetCurrentEvent();
                mgr->GeneratePrimaries(currentEvent);
                if(runmgr->getRunAborted()) break;
                for(unsigned i=0; i<BLCMDtracker::list.size(); ++i)
                        BLCMDtracker::list[i]->setMode(BLTRACKER_TRUE);
                evmgr->ProcessOneEvent(currentEvent);
                if(runmgr->getRunAborted()) break;
                for(unsigned i=0; i<BLCMDtracker::list.size(); ++i) {
                        BLCMDtracker::list[i]->setMode(BLTRACKER_FIT);
                        BLCMDtracker::list[i]->fitTrack();
                }
                runmgr->endEvent();
                delete currentEvent;
                currentEvent = 0;
        } 

        runmgr->endRun();
}

const G4String& BLCMDtrackermode::getMode

(

)

const [inline]

References mode.

Referenced by BLCMDtracker::callback().

{ return mode; }

---

Member Data Documentation

G4String BLCMDtrackermode::filename [private]

Referenced by BLCMDtrackermode(), callback(), command(), and defineNamedArgs().

G4String BLCMDtrackermode::mode [private]

Referenced by BLCMDtrackermode(), callback(), command(), and getMode().

G4bool BLCMDtrackermode::registered [private]

Referenced by BLCMDtrackermode(), and command().

---

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

• BLCMDtracker.cc