BLTrackFile Class Reference

#include <BLTrackFile.hh>

List of all members.

---

Detailed Description

class BLTrackFile creates or reads an ASCII file containing tracks.

The file format is ASCII: Lines begining with # are comments First line is a structured comment (if not present the input routine issues a warning): BLTrackFile ... user comment... Second line is a comment giving the column names: x y z Px Py Pz t PDGid EventID TrackID ParentID weight Third line is a comment giving the units: cm cm cm MeV/c MeV/c MeV/c ns - - - - - OR: mm mm mm MeV/c MeV/c MeV/c ns - - - - - (When writing, mm are used; on reading, mm are assumed, but a comment line containing "cm cm cm" switches to cm.) Thereafter follow the tracks, one per line. While the input routine can handle initial spaces in the first column, it is STRONGLY suggested you not put any there (so cut/grep will work). Any fixed or floating-point format will do; PDGid, EventID, TrackID, and ParentID are integers (but are read as doubles, so .00 can be appended). Common PDGid-s: e- 11 e+ -11 mu- 13 mu+ -13 pi+ 211 pi- -211 proton 2212 anti_proton -2212 neutron 2112 anti_neutron -2112 gamma 22

Public Member Functions
	BLTrackFile ()
	Default constructor. Reads return immediate EOF; writes do nothing.
	BLTrackFile (G4String filename, G4String comment, G4String mode)
	Constructor. Opens the file; mode="r" or "w". comment is an identifying comment in the first line of the file (ignored for mode=r).
	~BLTrackFile ()
	Destructor. Closes the file.
void	setLengthUnit (G4double mmorcm)
	setLengthUnit() will select either mm or cm. default is mm.
BLTrackFileStatus	write (G4ThreeVector &pos, G4double time, G4ThreeVector &momentum, int PDGid, int eventId, int trackId, int parentId, G4double weight=1.0)
	write() will write one track to the file (mode must have been "w"). Units are standard geant4 internal units. Note that weight is optional.
BLTrackFileStatus	read (G4ThreeVector &pos, G4double &time, G4ThreeVector &momentum, int &PDGid, int &eventId, int &trackId, int &parentId)
	read() will read one track from the file (mode must have been "r"). Units are standard geant4 internal units. Use the other version of read() if you want to use the weight.
BLTrackFileStatus	read (G4ThreeVector &pos, G4double &time, G4ThreeVector &momentum, int &PDGid, int &eventId, int &trackId, int &parentId, G4double &weight)
	read() will read one track from the file (mode must have been "r"). Units are standard geant4 internal units.
void	flush ()
	flush() will flush buffers to the file.
Private Attributes
BLTrackFileStatus	status
FILE *	file
G4String	mode
G4double	unit

---

Constructor & Destructor Documentation

BLTrackFile::BLTrackFile

(

)

Default constructor. Reads return immediate EOF; writes do nothing.

References BLTF_DUMMY, file, mode, status, and unit.

{
        status = BLTF_DUMMY;
        mode = "";
        unit = mm;
        file = 0;
}

BLTrackFile::BLTrackFile	(	G4String	filename,
		G4String	comment,
		G4String	mode
	)

Constructor. Opens the file; mode="r" or "w". comment is an identifying comment in the first line of the file (ignored for mode=r).

References BLTF_ENDOFFILE, BLTF_ERROR, BLTF_OK, file, BLAsciiFile::fopen(), mode, status, and unit.

{
        status = BLTF_ERROR;
        mode = _mode;
        unit = mm;
        if(mode == "w")
                file = BLAsciiFile::fopen(filename);
        else
                file = fopen(filename.c_str(),"r");
        if(!file || (mode != "r" && mode != "w")) {
                fprintf(stderr,"BLTrackFile: cannot open '%s' in mode '%s'",
                                        filename.c_str(),mode.c_str());
                return;
        }
        status = BLTF_OK;
        if(mode == "w") {
                fprintf(file,"#BLTrackFile %s\n",comment.c_str());
                fprintf(file,"#x y z Px Py Pz t PDGid EventID TrackID ParentID Weight\n");
                if(unit == mm)
                    fprintf(file,"#mm mm mm MeV/c MeV/c MeV/c ns - - - - -\n");
                else
                    fprintf(file,"#cm cm cm MeV/c MeV/c MeV/c ns - - - - -\n");
        } else if(mode == "r") {
                char line[512];
                if(!fgets(line,sizeof(line),file)) {
                        status = BLTF_ENDOFFILE;
                        return;
                }
                G4String s(line);
                if(s.substr(0,12) != "#BLTrackFile") {
                        G4Exception("BLTrackFIle input","Possible wrong format",
                                JustWarning, "Assumed OK");
                        rewind(file);
                }
        }
}

BLTrackFile::~BLTrackFile

(

)

Destructor. Closes the file.

References BLTF_ERROR, BLAsciiFile::fclose(), file, and status.

{
        if(file) BLAsciiFile::fclose(file);
        file = 0;
        status = BLTF_ERROR;
}

---

Member Function Documentation

void BLTrackFile::setLengthUnit

(

G4double

mmorcm

)

[inline]

setLengthUnit() will select either mm or cm. default is mm.

References unit.

{ unit = mmorcm; }

BLTrackFileStatus BLTrackFile::write	(	G4ThreeVector &	pos,
		G4double	time,
		G4ThreeVector &	momentum,
		int	PDGid,
		int	eventId,
		int	trackId,
		int	parentId,
		G4double	weight = 1.0
	)

write() will write one track to the file (mode must have been "w"). Units are standard geant4 internal units. Note that weight is optional.

References BLTF_DUMMY, BLTF_ERROR, BLTF_OK, file, mode, status, and unit.

Referenced by TrackFileNTuple::appendRow().

{
        if(status == BLTF_DUMMY) return BLTF_OK;
        if(status != BLTF_OK || mode != "w") return BLTF_ERROR;

        // left justified to avoid pesky initial spaces in column 1
        fprintf(file,"%.6g %.6g %.6g ",pos[0]/unit,pos[1]/unit,pos[2]/unit);
        fprintf(file,"%.6g %.6g %.6g ",momentum[0]/MeV,momentum[1]/MeV,
                                                momentum[2]/MeV);
        fprintf(file,"%.6g %d %d %d %d %.6g\n",time/ns,PDGid,eventId,
                                                trackId,parentId,weight);
        return status;
}

BLTrackFileStatus BLTrackFile::read	(	G4ThreeVector &	pos,
		G4double &	time,
		G4ThreeVector &	momentum,
		int &	PDGid,
		int &	eventId,
		int &	trackId,
		int &	parentId
	)

read() will read one track from the file (mode must have been "r"). Units are standard geant4 internal units. Use the other version of read() if you want to use the weight.

Referenced by BLCMDbeam::nextBeamEvent().

{
        G4double weight;        // ignored
        return read(pos,time,momentum,PDGid,eventId,trackId,parentId,weight);
}

BLTrackFileStatus BLTrackFile::read	(	G4ThreeVector &	pos,
		G4double &	time,
		G4ThreeVector &	momentum,
		int &	PDGid,
		int &	eventId,
		int &	trackId,
		int &	parentId,
		G4double &	weight
	)

read() will read one track from the file (mode must have been "r"). Units are standard geant4 internal units.

References BLTF_DUMMY, BLTF_ENDOFFILE, BLTF_ERROR, BLTF_OK, file, mode, status, and unit.

{
        if(status == BLTF_DUMMY) return BLTF_ENDOFFILE;
        if(status != BLTF_OK || mode != "r") return BLTF_ERROR;

        char line[1024];
        do {
                if(!fgets(line,sizeof(line),file)) {
                        status = BLTF_ENDOFFILE;
                        return status;
                }
                if(line[0] == '#' && strstr(line,"cm cm cm"))
                        unit = cm;
        } while(line[0] == '#' || line[0] == '\n' || line[0] == '\r' || 
                                                        line[0] == '\0');

        // Tom Roberts 2010-04-05
        // Read into doubles, and then convert. This permits event numbers 1.0e7
        // and 10000001 to be read as accurately as possible.
        double data[12];

        //Ajit Kurup 2008-06-02
        //Read in PDGid, eventId,trackId and parentId as integers
        //since the float->int conversion doesn't work properly for
        //large numbers

        data[11] = 1.0; // in case weight is missing from file
        if(sscanf(line,"%lf%lf%lf%lf%lf%lf%lf%lf%lf%lf%lf%lf",
                                data+0,data+1,data+2,data+3,data+4,data+5,
                                data+6,data+7,data+8,data+9,data+10,
                                data+11) < 11) {
                printf("BLTrackFile invalid input line (file abandoned): '%s'\n",
                                line);
                fflush(stdout);
                status = BLTF_ERROR;
                return status;
        }

        pos[0] = data[0]*unit;
        pos[1] = data[1]*unit;
        pos[2] = data[2]*unit;
        momentum[0] = data[3]*MeV;
        momentum[1] = data[4]*MeV;
        momentum[2] = data[5]*MeV;
        time = data[6]*ns;
        PDGid = (int)data[7];
        eventId = (int)data[8];
        trackId = (int)data[9];
        parentId = (int)data[10];
        weight = data[11];

        return status;
}

void BLTrackFile::flush

(

)

[inline]

flush() will flush buffers to the file.

References file.

{ fflush(file); }

---

Member Data Documentation

BLTrackFileStatus BLTrackFile::status [private]

Referenced by BLTrackFile(), read(), write(), and ~BLTrackFile().

FILE* BLTrackFile::file [private]

Referenced by BLTrackFile(), flush(), read(), write(), and ~BLTrackFile().

G4String BLTrackFile::mode [private]

Referenced by BLTrackFile(), read(), and write().

G4double BLTrackFile::unit [private]

Referenced by BLTrackFile(), read(), setLengthUnit(), and write().

---

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

• BLTrackFile.hh
• BLTrackFile.cc