Mille Class Reference

#include <Mille.h>

Public Member Functions
void	end ()
void	flushOutputFile ()
void	kill ()
	Mille (const char *outFileName, bool asBinary=true, bool writeZero=false)
void	mille (int NLC, const float *derLc, int NGL, const float *derGl, const int *label, float rMeas, float sigma)
void	resetOutputFile ()
void	special (int nSpecial, const float *floatings, const int *integers)
	~Mille ()

Private Types
enum	{ maxLabel_ = (0xFFFFFFFF - (1 << 31)) }
enum	{ bufferSize_ = 5000 }

Private Member Functions
bool	checkBufferSize (int nLocal, int nGlobal)
void	newSet ()

Private Attributes
bool	asBinary_
float	bufferFloat_ [bufferSize_]
int	bufferInt_ [bufferSize_]
int	bufferPos_
const std::ios_base::openmode	fileMode_
const std::string	fileName_
bool	hasSpecial_
std::ofstream	outFile_
bool	writeZero_

Detailed Description

Class to write a C binary (cf. below) file of a given name and to fill it with information used as input to pede. Use its member functions mille(...), special(...), kill() and end() as you would use the fortran MILLE and its entry points MILLSP, KILLE and ENDLE.

For debugging purposes constructor flags enable switching to text output and/or to write also derivatives and lables which are ==0. But note that pede will not be able to read text output and has not been tested with derivatives/labels ==0.

Author

: Gero Flucke date : October 2006

Revision

1.2

Date

2007/03/16 16:44:47

(last update by

Author

flucke

)

Definition at line 26 of file Mille.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
maxLabel_

Definition at line 54 of file Mille.h.

{ maxLabel_ = (0xFFFFFFFF - (1 << 31)) };  // largest label allowed: 2^31 - 1

anonymous enum

anonymous enum

private

Enumerator
bufferSize_

Definition at line 48 of file Mille.h.

{ bufferSize_ = 5000 };

Constructor & Destructor Documentation

Mille()

Mille::Mille	(	const char *	outFileName,
		bool	asBinary = true,
		bool	writeZero = false
	)

Definition at line 17 of file Mille.cc.

References bufferFloat_, bufferInt_, fileName_, and outFile_.

    : fileMode_(asBinary ? (std::ios::binary | std::ios::out) : std::ios::out),
      fileName_(outFileName),
      outFile_(fileName_, fileMode_),
      asBinary_(asBinary),
      writeZero_(writeZero),
      bufferPos_(-1),
      hasSpecial_(false) {
  // opens outFileName, by default as binary file

  // Instead bufferPos_(-1), hasSpecial_(false) and the following two lines
  // we could call newSet() and kill()...
  bufferInt_[0] = 0;
  bufferFloat_[0] = 0.;

  if (!outFile_.is_open()) {
    edm::LogError("Alignment") << "Mille::Mille: Could not open " << fileName_ << " as output file.";
  }
}

~Mille()

Mille::~Mille

(

)

Definition at line 39 of file Mille.cc.

References outFile_.

              {
  // closes file
  outFile_.close();
}

Member Function Documentation

checkBufferSize()

bool Mille::checkBufferSize ( int  nLocal, int  nGlobal  )

private

Definition at line 186 of file Mille.cc.

References bufferInt_, bufferPos_, and bufferSize_.

Referenced by mille(), and special().

                                                   {
  // enough space for next nLocal + nGlobal derivatives incl. measurement?

  if (bufferPos_ + nLocal + nGlobal + 2 >= bufferSize_) {
    ++(bufferInt_[0]);  // increase error count
    edm::LogError("Alignment") << "Mille::checkBufferSize: Buffer too short (" << bufferSize_ << "),"
                               << "\n need space for nLocal (" << nLocal << ")"
                               << "/nGlobal (" << nGlobal << ") local/global derivatives, " << bufferPos_ + 1
                               << " already stored!";
    return false;
  } else {
    return true;
  }
}

end()

void Mille::end

(

)

Definition at line 149 of file Mille.cc.

References asBinary_, bufferFloat_, bufferInt_, bufferPos_, mps_fire::i, and outFile_.

Referenced by Types.LuminosityBlockRange::cppID(), and Types.EventRange::cppID().

                {
  // write set of derivatives with same local parameters to file
  if (bufferPos_ > 0) {  // only if anything stored...
    const int numWordsToWrite = (bufferPos_ + 1) * 2;

    if (asBinary_) {
      outFile_.write(reinterpret_cast<const char *>(&numWordsToWrite), sizeof(numWordsToWrite));
      outFile_.write(reinterpret_cast<char *>(bufferFloat_), (bufferPos_ + 1) * sizeof(bufferFloat_[0]));
      outFile_.write(reinterpret_cast<char *>(bufferInt_), (bufferPos_ + 1) * sizeof(bufferInt_[0]));
    } else {
      outFile_ << numWordsToWrite << "\n";
      for (int i = 0; i < bufferPos_ + 1; ++i) {
        outFile_ << bufferFloat_[i] << " ";
      }
      outFile_ << "\n";

      for (int i = 0; i < bufferPos_ + 1; ++i) {
        outFile_ << bufferInt_[i] << " ";
      }
      outFile_ << "\n";
    }
  }
  bufferPos_ = -1;  // reset buffer for next set of derivatives
}

flushOutputFile()

void Mille::flushOutputFile

(

)

Definition at line 131 of file Mille.cc.

References outFile_.

                            {
  // flush output file
  outFile_.flush();
}

kill()

void Mille::kill

(

)

Definition at line 124 of file Mille.cc.

References bufferPos_.

                 {
  // reset buffers, i.e. kill derivatives accumulated for current set
  bufferPos_ = -1;
}

mille()

void Mille::mille	(	int	NLC,
		const float *	derLc,
		int	NGL,
		const float *	derGl,
		const int *	label,
		float	rMeas,
		float	sigma
	)

Definition at line 46 of file Mille.cc.

References bufferFloat_, bufferInt_, bufferPos_, checkBufferSize(), mps_fire::i, label, maxLabel_, newSet(), and writeZero_.

                                                                                                                      {
  if (sigma <= 0.)
    return;
  if (bufferPos_ == -1)
    this->newSet();  // start, e.g. new track
  if (!this->checkBufferSize(NLC, NGL))
    return;

  // first store measurement
  ++bufferPos_;
  bufferFloat_[bufferPos_] = rMeas;
  bufferInt_[bufferPos_] = 0;

  // store local derivatives and local 'lables' 1,...,NLC
  for (int i = 0; i < NLC; ++i) {
    if (derLc[i] || writeZero_) {  // by default store only non-zero derivatives
      ++bufferPos_;
      bufferFloat_[bufferPos_] = derLc[i];  // local derivatives
      bufferInt_[bufferPos_] = i + 1;       // index of local parameter
    }
  }

  // store uncertainty of measurement in between locals and globals
  ++bufferPos_;
  bufferFloat_[bufferPos_] = sigma;
  bufferInt_[bufferPos_] = 0;

  // store global derivatives and their lables
  for (int i = 0; i < NGL; ++i) {
    if (derGl[i] || writeZero_) {                                   // by default store only non-zero derivatives
      if ((label[i] > 0 || writeZero_) && label[i] <= maxLabel_) {  // and for valid labels
        ++bufferPos_;
        bufferFloat_[bufferPos_] = derGl[i];  // global derivatives
        bufferInt_[bufferPos_] = label[i];    // index of global parameter
      } else {
        edm::LogError("Alignment") << "Mille::mille: Invalid label " << label[i] << " <= 0 or > " << maxLabel_;
      }
    }
  }
}

newSet()

void Mille::newSet ( )

private

Definition at line 176 of file Mille.cc.

References bufferFloat_, bufferInt_, bufferPos_, and hasSpecial_.

Referenced by mille(), and special().

                   {
  // initilise for new set of locals, e.g. new track
  bufferPos_ = 0;
  hasSpecial_ = false;
  bufferFloat_[0] = 0.0;
  bufferInt_[0] = 0;  // position 0 used as error counter
}

resetOutputFile()

void Mille::resetOutputFile

(

)

Definition at line 138 of file Mille.cc.

References fileMode_, fileName_, and outFile_.

                            {
  // flush output file
  outFile_.close();
  outFile_.open(fileName_, fileMode_);
  if (!outFile_.is_open()) {
    edm::LogError("Alignment") << "Mille::resetOutputFile: Could not reopen " << fileName_ << ".";
  }
}

special()

void Mille::special	(	int	nSpecial,
		const float *	floatings,
		const int *	integers
	)

Definition at line 88 of file Mille.cc.

References bufferFloat_, bufferInt_, bufferPos_, checkBufferSize(), hasSpecial_, mps_fire::i, and newSet().

                                                                             {
  if (nSpecial == 0)
    return;
  if (bufferPos_ == -1)
    this->newSet();  // start, e.g. new track
  if (hasSpecial_) {
    edm::LogError("Alignment") << "Mille::special: Special values already stored for this record.";
    return;
  }
  if (!this->checkBufferSize(nSpecial, 0))
    return;
  hasSpecial_ = true;  // after newSet() (Note: MILLSP sets to buffer position...)

  //  bufferFloat_[.]   | bufferInt_[.]
  // ------------------------------------
  //      0.0           |      0
  //  -float(nSpecial)  |      0
  //  The above indicates special data, following are nSpecial floating and nSpecial integer data.

  ++bufferPos_;  // zero pair
  bufferFloat_[bufferPos_] = 0.;
  bufferInt_[bufferPos_] = 0;

  ++bufferPos_;                          // nSpecial and zero
  bufferFloat_[bufferPos_] = -nSpecial;  // automatic conversion to float
  bufferInt_[bufferPos_] = 0;

  for (int i = 0; i < nSpecial; ++i) {
    ++bufferPos_;
    bufferFloat_[bufferPos_] = floatings[i];
    bufferInt_[bufferPos_] = integers[i];
  }
}

Member Data Documentation

asBinary_

bool Mille::asBinary_

private

Definition at line 45 of file Mille.h.

Referenced by end().

bufferFloat_

float Mille::bufferFloat_[bufferSize_]

private

Definition at line 50 of file Mille.h.

Referenced by end(), Mille(), mille(), newSet(), and special().

bufferInt_

int Mille::bufferInt_[bufferSize_]

private

Definition at line 49 of file Mille.h.

Referenced by checkBufferSize(), end(), Mille(), mille(), newSet(), and special().

bufferPos_

int Mille::bufferPos_

private

Definition at line 51 of file Mille.h.

Referenced by checkBufferSize(), end(), kill(), mille(), newSet(), and special().

fileMode_

const std::ios_base::openmode Mille::fileMode_

private

Definition at line 42 of file Mille.h.

Referenced by resetOutputFile().

fileName_

const std::string Mille::fileName_

private

Definition at line 43 of file Mille.h.

Referenced by Mille(), and resetOutputFile().

hasSpecial_

bool Mille::hasSpecial_

private

Definition at line 52 of file Mille.h.

Referenced by newSet(), and special().

outFile_

std::ofstream Mille::outFile_

private

Definition at line 44 of file Mille.h.

Referenced by end(), flushOutputFile(), Mille(), resetOutputFile(), and ~Mille().

writeZero_

bool Mille::writeZero_

private

Definition at line 46 of file Mille.h.

Referenced by mille().