FWMagField Class Reference

#include <FWMagField.h>

Inheritance diagram for FWMagField:

Public Types
enum	ESource { kNone, kEvent, kUser }

Public Member Functions
void	checkFieldInfo (const edm::EventBase *)
	FWMagField ()
TEveVector	GetField (Float_t x, Float_t y, Float_t z) const override
Float_t	GetMaxFieldMag () const override
ESource	getSource () const
float	getUserField () const
void	guessField (float estimate) const
void	guessFieldIsOn (bool guess) const
bool	isReverse () const
bool	isSimpleModel () const
void	resetFieldEstimate () const
void	setFFFieldMag (float)
void	setReverseState (bool state)
void	setSimpleModel (bool simpleModel)
void	setSource (ESource x)
void	setUserField (float b)
	~FWMagField () override

Private Member Functions
	FWMagField (const FWMagField &)=delete
Float_t	GetFieldMag () const
const FWMagField &	operator= (const FWMagField &)=delete

Private Attributes
float	m_eventField
float	m_guessedField
TH1F *	m_guessValHist
int	m_numberOfFieldEstimates
int	m_numberOfFieldIsOnEstimates
bool	m_reverse
bool	m_simpleModel
ESource	m_source
bool	m_updateFieldEstimate
float	m_userField

Detailed Description

Definition at line 15 of file FWMagField.h.

Member Enumeration Documentation

enum FWMagField::ESource

Enumerator
kNone
kEvent
kUser

Definition at line 20 of file FWMagField.h.

{ kNone, kEvent, kUser };

Constructor & Destructor Documentation

FWMagField::FWMagField

(

)

Definition at line 11 of file FWMagField.cc.

References m_guessValHist.

                       :
   TEveMagField(),

   m_source(kNone),
   m_userField(-1),
   m_eventField(-1),

   m_reverse(true),
   m_simpleModel(false),

   m_guessValHist(nullptr),
   m_numberOfFieldIsOnEstimates(0),
   m_numberOfFieldEstimates(0),
   m_updateFieldEstimate(true),
   m_guessedField(0)
{
   m_guessValHist = new TH1F("FieldEstimations", "Field estimations from tracks and muons",
                             200, -4.5, 4.5);
   m_guessValHist->SetDirectory(nullptr);
}

FWMagField::~FWMagField ( )

override

Definition at line 32 of file FWMagField.cc.

References m_guessValHist.

{
   delete m_guessValHist;
}

FWMagField::FWMagField ( const FWMagField &  )

privatedelete

Member Function Documentation

void FWMagField::checkFieldInfo

(

const edm::EventBase *

event

)

Definition at line 172 of file FWMagField.cc.

References edm::ConditionsInRunBlock::BAvgCurrent, event(), fwLog, fwlite::Run::getByLabel(), fwlite::Event::getRun(), mps_fire::i, edm::HandleBase::isValid(), fwlog::kDebug, kEvent, kNone, m_eventField, and m_source.

Referenced by CmsShowMainBase::draw().

{
   const static float  currentToField = 3.8/18160;
   bool available = false;
   try
   {
      edm::InputTag conditionsTag("conditionsInEdm");
      edm::Handle<edm::ConditionsInRunBlock> runCond;
      // FIXME: ugly hack to avoid exposing an fwlite::Event. Need to ask
      //        Chris / Ianna how to get mag field from an EventBase.
      const fwlite::Event *fwEvent = dynamic_cast<const fwlite::Event*>(event);
      if (!fwEvent)
         return;

      m_source = kNone;
      fwEvent->getRun().getByLabel(conditionsTag, runCond);
      
      if( runCond.isValid())
      {
         available = true;
         m_eventField = currentToField * runCond->BAvgCurrent;
         m_source = kEvent;
         fwLog( fwlog::kDebug ) << "Magnetic field info found in ConditionsInEdm branch : "<< m_eventField << std::endl;
      }
      else
      {
         edm::InputTag dcsTag("scalersRawToDigi");
         edm::Handle< std::vector<DcsStatus> > dcsStatus;
         event->getByLabel(dcsTag, dcsStatus);
         
         if (dcsStatus.isValid() && !dcsStatus->empty())
         {
            float sum = 0;
            for (std::vector<DcsStatus>::const_iterator i = dcsStatus->begin(); i <  dcsStatus->end(); ++i)
               sum += (*i).magnetCurrent();

            available = true;
            m_eventField = currentToField * sum/dcsStatus->size();
            m_source = kEvent;
            fwLog( fwlog::kDebug) << "Magnetic field info found in DcsStatus branch: " << m_eventField << std::endl;
         }

      }
   }
   catch (cms::Exception&)
   {
      fwLog( fwlog::kDebug ) << "Cought exception in FWMagField::checkFieldInfo\n";
   }

   if (!available)
   {
      fwLog( fwlog::kDebug ) << "No magnetic field info available in Event\n";
   }
}

TEveVector FWMagField::GetField ( Float_t  x, Float_t  y, Float_t  z  ) const

override

Definition at line 40 of file FWMagField.cc.

References Abs(), GetFieldMag(), m_reverse, m_simpleModel, dttmaxenums::R, and mathSSE::sqrt().

{
   // Virtual method of TEveMagField class.

   Float_t R = sqrt(x*x+y*y);
   Float_t field = m_reverse ? -GetFieldMag() : GetFieldMag();

   //barrel
   if ( TMath::Abs(z)<724 ){
    
      //inside solenoid
      if ( R < 300) return TEveVector(0,0,field);
      // outside solinoid
      if ( m_simpleModel ||
           ( R>461.0 && R<490.5 ) ||
           ( R>534.5 && R<597.5 ) ||
           ( R>637.0 && R<700.0 ) )
         return TEveVector(0,0,-field/3.8*1.2);
  
   } else {
      // endcaps
      if (m_simpleModel){
         if ( R < 50 ) return TEveVector(0,0,field);
         if ( z > 0 )
            return TEveVector(x/R*field/3.8*2.0, y/R*field/3.8*2.0, 0);
         else
            return TEveVector(-x/R*field/3.8*2.0, -y/R*field/3.8*2.0, 0);
      }
      // proper model
      if ( ( ( TMath::Abs(z)>724 ) && ( TMath::Abs(z)<786 ) ) ||
           ( ( TMath::Abs(z)>850 ) && ( TMath::Abs(z)<910 ) ) ||
           ( ( TMath::Abs(z)>975 ) && ( TMath::Abs(z)<1003 ) ) )
      {
         if ( z > 0 )
            return TEveVector(x/R*field/3.8*2.0, y/R*field/3.8*2.0, 0);
         else
            return TEveVector(-x/R*field/3.8*2.0, -y/R*field/3.8*2.0, 0);
      }
   }
   return TEveVector(0,0,0);
}

Float_t FWMagField::GetFieldMag ( ) const

private

Definition at line 85 of file FWMagField.cc.

References kEvent, kUser, m_eventField, m_guessedField, m_guessValHist, m_numberOfFieldEstimates, m_numberOfFieldIsOnEstimates, m_source, m_updateFieldEstimate, and m_userField.

Referenced by GetField(), and GetMaxFieldMag().

{
   float res;
   switch ( m_source )
   {
      case kEvent:
      {
         res = m_eventField;  
         break;
      }
      case kUser:
      {
         res = m_userField;   
         break;
      }
      default:
      {
         if ( m_updateFieldEstimate )
         {
            if ( m_guessValHist->GetEntries() > 2  && m_guessValHist->GetRMS()  < 0.5 )
            {
               m_guessedField = m_guessValHist->GetMean();
            

               // std::cout << "FWMagField::GetFieldMag(), get average "
               //  << m_guessValHist->GetMean() << " guessed value: RMS= "<< m_guessValHist->GetRMS()
               //  <<" samples "<< m_guessValHist->GetEntries() << std::endl;
            
            }
            else if ( m_numberOfFieldIsOnEstimates > m_numberOfFieldEstimates/2 || m_numberOfFieldEstimates == 0 )
            {
               m_guessedField = 3.8;
               // fwLog(fwlog::kDebug) << "FWMagField::GetFieldMag() get default field, number estimates "
               //  << m_numberOfFieldEstimates << " number fields is on  m_numberOfFieldIsOnEstimates" <<std::endl;
            }
            else
            {
               m_guessedField = 0;
               //  fwLog(fwlog::kDebug) << "Update field estimate, guess field is OFF." <<std::endl;
            }
            m_updateFieldEstimate  = false;
         }

         res = m_guessedField;
      }
   }

   return res;
}

Float_t FWMagField::GetMaxFieldMag ( ) const

override

Definition at line 136 of file FWMagField.cc.

References Abs(), f, GetFieldMag(), and Max().

{
   // Runge-Kutta stepper does not like this to be zero.
   // Will be fixed in root.
   // The return value should definitley not be negative -- so Abs
   // should stay!

   return TMath::Max(TMath::Abs(GetFieldMag()), 0.01f);
}

ESource FWMagField::getSource ( ) const

inline

Definition at line 33 of file FWMagField.h.

Referenced by FWMuonBuilder::calculateField(), CmsShowMainBase::draw(), and CmsShowMain::fileChangedSlot().

{ return m_source; }

float FWMagField::getUserField ( ) const

inline

Definition at line 31 of file FWMagField.h.

{ return  m_userField; }

void FWMagField::guessField

(

float

estimate

)

const

Definition at line 155 of file FWMagField.cc.

References m_guessValHist, and m_updateFieldEstimate.

Referenced by FWTrackProxyBuilder::build(), and FWMuonBuilder::calculateField().

{
   // fwLog(filedDebug) <<  "FWMagField::guessField "<< val << std::endl;
   m_guessValHist->Fill(val);
   m_updateFieldEstimate = true; 
}

void FWMagField::guessFieldIsOn

(

bool

guess

)

const

Definition at line 148 of file FWMagField.cc.

References m_numberOfFieldEstimates, m_numberOfFieldIsOnEstimates, and m_updateFieldEstimate.

Referenced by FWMuonBuilder::calculateField().

{
   if ( isOn ) ++m_numberOfFieldIsOnEstimates;
   ++m_numberOfFieldEstimates;
   m_updateFieldEstimate  = true;
}

bool FWMagField::isReverse ( ) const

inline

Definition at line 37 of file FWMagField.h.

{ return m_reverse;}

bool FWMagField::isSimpleModel ( ) const

inline

Definition at line 39 of file FWMagField.h.

{ return m_simpleModel;}

const FWMagField& FWMagField::operator= ( const FWMagField &  )

privatedelete

void FWMagField::resetFieldEstimate

(

)

const

Definition at line 162 of file FWMagField.cc.

References m_guessValHist, m_numberOfFieldEstimates, m_numberOfFieldIsOnEstimates, and m_updateFieldEstimate.

Referenced by CmsShowMain::fileChangedSlot().

{
   m_guessValHist->Reset();
   m_guessValHist->SetAxisRange(-4, 4);
   m_numberOfFieldIsOnEstimates = 0;
   m_numberOfFieldEstimates = 0;
   m_updateFieldEstimate = true;   
}

void FWMagField::setFFFieldMag

(

float

mag

)

Definition at line 229 of file FWMagField.cc.

References kEvent, m_eventField, m_source, and mag().

{
   // AMT this is a workaround for seting FF in FFLooper
   // Correct imeplementation is having a base class of  FWMagField amd do implementation for FF and FWLite version

   m_source = kEvent;
   m_eventField = mag;
}

void FWMagField::setReverseState ( bool  state )

inline

Definition at line 36 of file FWMagField.h.

{ m_reverse = state; }

void FWMagField::setSimpleModel ( bool  simpleModel )

inline

Definition at line 38 of file FWMagField.h.

{ m_simpleModel = simpleModel; }

void FWMagField::setSource ( ESource  x )

inline

Definition at line 32 of file FWMagField.h.

{ m_source = x; }

void FWMagField::setUserField ( float  b )

inline

Definition at line 30 of file FWMagField.h.

References b.

{ m_userField = b; }

Member Data Documentation

float FWMagField::m_eventField

private

Definition at line 55 of file FWMagField.h.

Referenced by checkFieldInfo(), GetFieldMag(), and setFFFieldMag().

float FWMagField::m_guessedField

mutableprivate

Definition at line 65 of file FWMagField.h.

Referenced by GetFieldMag().

TH1F* FWMagField::m_guessValHist

mutableprivate

Definition at line 61 of file FWMagField.h.

Referenced by FWMagField(), GetFieldMag(), guessField(), resetFieldEstimate(), and ~FWMagField().

int FWMagField::m_numberOfFieldEstimates

mutableprivate

Definition at line 63 of file FWMagField.h.

Referenced by GetFieldMag(), guessFieldIsOn(), and resetFieldEstimate().

int FWMagField::m_numberOfFieldIsOnEstimates

mutableprivate

Definition at line 62 of file FWMagField.h.

Referenced by GetFieldMag(), guessFieldIsOn(), and resetFieldEstimate().

bool FWMagField::m_reverse

private

Definition at line 57 of file FWMagField.h.

Referenced by GetField().

bool FWMagField::m_simpleModel

private

Definition at line 58 of file FWMagField.h.

Referenced by GetField().

ESource FWMagField::m_source

private

Definition at line 53 of file FWMagField.h.

Referenced by checkFieldInfo(), GetFieldMag(), and setFFFieldMag().

bool FWMagField::m_updateFieldEstimate

mutableprivate

Definition at line 64 of file FWMagField.h.

Referenced by GetFieldMag(), guessField(), guessFieldIsOn(), and resetFieldEstimate().

float FWMagField::m_userField

private

Definition at line 54 of file FWMagField.h.

Referenced by GetFieldMag().