Cordic Class Reference

#include <Cordic.h>

Public Member Functions
	Cordic (const uint32_t &aPhiScale, const uint32_t &aMagnitudeBits, const uint32_t &aSteps)
	Cordic ()
	Cordic (int aPhiScale, int aMagnitudeBits, const int aSteps, bool debug)
int32_t	IntegerizeMagnitude (const double &aMagnitude) const
double	NormalizeMagnitude (const uint32_t &aMagnitude) const
double	NormalizePhi (const uint32_t &aPhi) const
void	operator() (int32_t aX, int32_t aY, int32_t &aPhi, uint32_t &aMagnitude) const
l1tmetemu::EtMiss	toPolar (l1tmetemu::Et_t x, l1tmetemu::Et_t y) const
virtual	~Cordic ()

Private Member Functions
uint32_t	tower (const double &aRadians) const

Private Attributes
std::vector< l1tmetemu::METphi_t >	atanLUT
const int	cordicSteps
const bool	debug
std::vector< l1tmetemu::Et_t >	magNormalisationLUT
uint32_t	mMagnitudeBits
const int	mMagnitudeBits
uint64_t	mMagnitudeRenormalization
uint32_t	mMagnitudeScale
const int	mMagnitudeScale
uint32_t	mPhiScale
const int	mPhiScale
const double	mPi
std::vector< uint32_t >	mRotations
uint32_t	mSteps

Detailed Description

Definition at line 7 of file Cordic.h.

Constructor & Destructor Documentation

Cordic() [1/3]

Cordic::Cordic	(	const uint32_t &	aPhiScale,
		const uint32_t &	aMagnitudeBits,
		const uint32_t &	aSteps
	)

Definition at line 9 of file Cordic.cc.

References mMagnitudeRenormalization, mMagnitudeScale, mRotations, mSteps, funct::pow(), mathSSE::sqrt(), and tower().

    : mPhiScale(aPhiScale),
      mMagnitudeScale(1 << aMagnitudeBits),
      mMagnitudeBits(aMagnitudeBits),
      mSteps(aSteps),
      mPi(3.1415926535897932384626433832795) {
  mRotations.reserve(mSteps);

  double lValue(1.0);

  for (uint32_t lStep(0); lStep != mSteps; ++lStep) {
    lValue /= sqrt(1.0 + pow(4.0, -double(lStep)));
    mRotations.push_back(tower(atan(pow(2.0, -double(lStep)))));
  }
  mMagnitudeRenormalization = uint32_t(round(mMagnitudeScale * lValue));
}

~Cordic()

Cordic::~Cordic ( )

virtual

Definition at line 26 of file Cordic.cc.

{}

Cordic() [2/3]

Cordic::Cordic

(

)

Cordic() [3/3]

Cordic::Cordic	(	int	aPhiScale,
		int	aMagnitudeBits,
		const int	aSteps,
		bool	debug
	)

Definition at line 8 of file Cordic.cc.

References atanLUT, debug, mps_fire::i, dqmiolumiharvest::j, M_PI, magNormalisationLUT, mMagnitudeScale, mPhiScale, funct::pow(), and heppy_batch::val.

    : mPhiScale(aPhiScale),
      mMagnitudeScale(1 << aMagnitudeBits),
      mMagnitudeBits(aMagnitudeBits),
      cordicSteps(aSteps),
      debug(debug) {
  atanLUT.reserve(aSteps);
  magNormalisationLUT.reserve(aSteps);

  if (debug) {
    edm::LogVerbatim("L1TkEtMissEmulator") << "=====atan LUT=====";
  }

  for (int i = 0; i < aSteps; i++) {
    atanLUT.push_back(METphi_t(round(mPhiScale * atan(pow(2, -i)) / (2 * M_PI))));
    if (debug) {
      edm::LogVerbatim("L1TkEtMissEmulator") << atanLUT[i] << " | ";
    }
  }
  if (debug) {
    edm::LogVerbatim("L1TkEtMissEmulator") << "\n=====Normalisation LUT=====";
  }

  float val = 1.0;
  for (int j = 0; j < aSteps; j++) {
    val = val / (pow(1 + pow(4, -j), 0.5));
    magNormalisationLUT.push_back(Et_t(round(mMagnitudeScale * val)));
    if (debug) {
      edm::LogVerbatim("L1TkEtMissEmulator") << magNormalisationLUT[j] << " | ";
    }
  }
}

Member Function Documentation

IntegerizeMagnitude()

int32_t Cordic::IntegerizeMagnitude

(

const double &

aMagnitude

)

const

Definition at line 34 of file Cordic.cc.

References mMagnitudeScale.

{ return int32_t(aMagnitude * mMagnitudeScale); }

NormalizeMagnitude()

double Cordic::NormalizeMagnitude

(

const uint32_t &

aMagnitude

)

const

Definition at line 30 of file Cordic.cc.

References mMagnitudeScale.

                                                                  {
  return double(aMagnitude) / double(mMagnitudeScale);
}

NormalizePhi()

double Cordic::NormalizePhi

(

const uint32_t &

aPhi

)

const

Definition at line 28 of file Cordic.cc.

References simKBmtfDigis_cfi::aPhi, and mPhiScale.

{ return double(aPhi) / double(mPhiScale); }

operator()()

void Cordic::operator()	(	int32_t	aX,
		int32_t	aY,
		int32_t &	aPhi,
		uint32_t &	aMagnitude
	)		const

Definition at line 38 of file Cordic.cc.

References simKBmtfDigis_cfi::aPhi, mMagnitudeBits, mMagnitudeRenormalization, mPi, mRotations, mSteps, tower(), testProducerWithPsetDescEmpty_cfi::x1, and testProducerWithPsetDescEmpty_cfi::x2.

                                                                                         {
  bool lSign(true);

  switch (((aY >= 0) ? 0x0 : 0x2) | ((aX >= 0) ? 0x0 : 0x1)) {
    case 0:
      aPhi = tower(mPi);
      break;
    case 1:
      aPhi = tower(2 * mPi);
      lSign = false;
      aX = -aX;
      break;
    case 2:
      aPhi = tower(mPi);
      lSign = false;
      aY = -aY;
      break;
    case 3:
      aPhi = 0;
      aX = -aX;
      aY = -aY;
      break;
    default:
      throw 0;
  }

  for (uint32_t lStep(0); lStep != mSteps; ++lStep) {
    if ((aY < 0) == lSign) {
      aPhi -= mRotations[lStep];
    } else {
      aPhi += mRotations[lStep];
    }

    int32_t lX(aX), lY(aY);
    if (lY < 0) {
      aX = lX - (lY >> lStep);
      aY = lY + (lX >> lStep);
    } else {
      aX = lX + (lY >> lStep);
      aY = lY - (lX >> lStep);
    }
  }

  aMagnitude = (aX * mMagnitudeRenormalization) >> mMagnitudeBits;
}

toPolar()

EtMiss Cordic::toPolar	(	l1tmetemu::Et_t	x,
		l1tmetemu::Et_t	y
	)		const

Definition at line 41 of file Cordic.cc.

References atanLUT, cordicSteps, debug, l1tmetemu::EtMiss::Et, dqmMemoryStats::float, createfilelist::int, l1tmetemu::kMaxMET, l1tmetemu::kMaxTrackPt, l1tmetemu::kMETSize, magNormalisationLUT, mMagnitudeBits, mPhiScale, phi, l1tmetemu::EtMiss::Phi, Validation_hcalonly_cfi::sign, x, and y.

                                           {
  Et_t new_x = 0;
  Et_t new_y = 0;

  METphi_t phi = 0;
  METphi_t new_phi = 0;
  bool sign = false;

  EtMiss ret_etmiss;

  if (debug) {
    edm::LogVerbatim("L1TkEtMissEmulator") << "\n=====Cordic Steps=====";
  }

  if (x >= 0 && y >= 0) {
    phi = 0;
    sign = true;
    //x = x;
    //y = y;
  } else if (x < 0 && y >= 0) {
    phi = mPhiScale >> 1;
    sign = false;
    x = -x;
    //y = y;
  } else if (x < 0 && y < 0) {
    phi = mPhiScale >> 1;
    sign = true;
    x = -x;
    y = -y;
  } else {
    phi = mPhiScale;
    sign = false;
    //x = x;
    y = -y;
  }

  for (int step = 0; step < cordicSteps; step++) {
    if (y < 0) {
      new_x = x - (y >> step);
      new_y = y + (x >> step);
    } else {
      new_x = x + (y >> step);
      new_y = y - (x >> step);
    }

    if ((y < 0) == sign) {
      new_phi = phi - atanLUT[step];
    } else {
      new_phi = phi + atanLUT[step];
    }

    x = new_x;
    y = new_y;
    phi = new_phi;

    if (debug) {
      edm::LogVerbatim("L1TkEtMissEmulator")
          << " Cordic x: " << x << " Cordic y: " << y << " Cordic phi: " << phi << "\n";
    }
  }

  // Cordic performs calculation in internal Et granularity, convert to final
  // granularity for Et word

  // emulate fw rounding with float division then floor
  float tempMET = (float)(x * magNormalisationLUT[cordicSteps - 1] * kMaxTrackPt) / ((float)kMaxMET);
  ret_etmiss.Et = (int)floor(tempMET) >> (mMagnitudeBits + TTTrack_TrackWord::TrackBitWidths::kRinvSize - kMETSize);
  ret_etmiss.Phi = phi;
  return ret_etmiss;
}

tower()

uint32_t Cordic::tower ( const double &  aRadians ) const

private

Definition at line 36 of file Cordic.cc.

References mPhiScale, and mPi.

Referenced by Cordic(), and operator()().

{ return uint32_t(round(mPhiScale * 0.5 * aRadians / mPi)); }

Member Data Documentation

atanLUT

std::vector<l1tmetemu::METphi_t> Cordic::atanLUT

private

Definition at line 35 of file Cordic.h.

Referenced by Cordic(), and toPolar().

cordicSteps

const int Cordic::cordicSteps

private

Definition at line 30 of file Cordic.h.

Referenced by toPolar().

debug

const bool Cordic::debug

private

Definition at line 32 of file Cordic.h.

Referenced by Cordic(), runTauIdMVA.TauIDEmbedder::loadMVA_WPs_run2_2017(), runTauIdMVA.TauIDEmbedder::runTauID(), and toPolar().

magNormalisationLUT

std::vector<l1tmetemu::Et_t> Cordic::magNormalisationLUT

private

Definition at line 37 of file Cordic.h.

Referenced by Cordic(), and toPolar().

mMagnitudeBits [1/2]

uint32_t Cordic::mMagnitudeBits

private

Definition at line 24 of file Cordic.h.

Referenced by operator()(), and toPolar().

mMagnitudeBits [2/2]

const int Cordic::mMagnitudeBits

private

Definition at line 28 of file Cordic.h.

mMagnitudeRenormalization

uint64_t Cordic::mMagnitudeRenormalization

private

Definition at line 26 of file Cordic.h.

Referenced by Cordic(), and operator()().

mMagnitudeScale [1/2]

uint32_t Cordic::mMagnitudeScale

private

Definition at line 23 of file Cordic.h.

Referenced by Cordic(), IntegerizeMagnitude(), and NormalizeMagnitude().

mMagnitudeScale [2/2]

const int Cordic::mMagnitudeScale

private

Definition at line 26 of file Cordic.h.

mPhiScale [1/2]

uint32_t Cordic::mPhiScale

private

Definition at line 22 of file Cordic.h.

Referenced by Cordic(), NormalizePhi(), toPolar(), and tower().

mPhiScale [2/2]

const int Cordic::mPhiScale

private

Definition at line 24 of file Cordic.h.

mPi

const double Cordic::mPi

private

Definition at line 29 of file Cordic.h.

Referenced by operator()(), and tower().

mRotations

std::vector<uint32_t> Cordic::mRotations

private

Definition at line 27 of file Cordic.h.

Referenced by Cordic(), and operator()().

mSteps

uint32_t Cordic::mSteps

private

Definition at line 25 of file Cordic.h.

Referenced by Cordic(), and operator()().