MagField::H8FieldSvc Class Reference

#include <H8FieldSvc.h>

Inheritance diagram for MagField::H8FieldSvc:

Collaboration diagram for MagField::H8FieldSvc:

Public Member Functions
	H8FieldSvc (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor. More...
virtual	~H8FieldSvc ()
	Destructor. More...
StatusCode	initialize ()
	Athena algorithm's interface methods. More...
StatusCode	start ()
StatusCode	finalize ()
virtual void	getField (const double *xyz, double *bxyz, double *deriv=nullptr) const
	get B field value at given position More...
virtual void	getFieldZR (const double *xyz, double *bxyz, double *deriv=nullptr) const
	getFieldZR simply calls getField More...

Private Member Functions
StatusCode	initializeMap ()
StatusCode	readMap (const std::string &mapFile)

Private Attributes
std::string	m_H8MapFilename
	Data members. More...
std::vector< BFieldH8Grid >	m_grid
double	m_dx1
double	m_dy1
double	m_dz1
double	m_dx2
double	m_dy2
double	m_dz2

Detailed Description

Definition at line 31 of file H8FieldSvc.h.

Constructor & Destructor Documentation

H8FieldSvc()

MagField::H8FieldSvc::H8FieldSvc	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Constructor.

Definition at line 30 of file H8FieldSvc.cxx.

                                                                       :
    base_class(name,svc),
    m_H8MapFilename("MagneticFieldMaps/mbps1-all-id-800-mbps2-muons-800x4.data"),
    m_dx1(0),
    m_dy1(0),
    m_dz1(0),
    m_dx2(43830), // default H8MS2 x offset
    m_dy2(0),
    m_dz2(0)
{
    declareProperty("H8MapFile", m_H8MapFilename, "File storing the H8 magnetic field map");
    declareProperty("dx1", m_dx1, "x component of magnet #1 shift (in mm)");
    declareProperty("dy1", m_dy1, "y component of magnet #1 shift (in mm)");
    declareProperty("dz1", m_dz1, "z component of magnet #1 shift (in mm)");
    declareProperty("dx2", m_dx2, "x component of magnet #2 shift (in mm)");
    declareProperty("dy2", m_dy2, "y component of magnet #2 shift (in mm)");
    declareProperty("dz2", m_dz2, "z component of magnet #2 shift (in mm)");
}

~H8FieldSvc()

MagField::H8FieldSvc::~H8FieldSvc ( )

virtual

Destructor.

Definition at line 49 of file H8FieldSvc.cxx.

{
}

Member Function Documentation

finalize()

StatusCode MagField::H8FieldSvc::finalize

(

)

Definition at line 66 of file H8FieldSvc.cxx.

{
    ATH_MSG_INFO( "finalize() ..." );
    return StatusCode::SUCCESS;
}

getField()

void MagField::H8FieldSvc::getField ( const double *  xyz, double *  bxyz, double *  deriv = nullptr  ) const

virtual

get B field value at given position

xyz[3] is in mm, bxyz[3] is in kT if deriv[9] is given, field derivatives are returned in kT/mm

Definition at line 137 of file H8FieldSvc.cxx.

{
    for ( unsigned i = 0; i < m_grid.size(); i++ ) {
        // find the grid that contains xyz
        if ( m_grid[i].inside( xyz ) ) {
            m_grid[i].getB( xyz, B, deriv );
            return;
        }
    }
    // xyz is outside all grids
    B[0] = B[1] = B[2] = 0.0;
    if ( deriv != nullptr ) {
        for ( int j = 0; j < 9; j++ ) deriv[j] = 0.0;
    }
    }

getFieldZR()

void MagField::H8FieldSvc::getFieldZR ( const double *  xyz, double *  bxyz, double *  deriv = nullptr  ) const

virtual

getFieldZR simply calls getField

Definition at line 153 of file H8FieldSvc.cxx.

{
    getField( xyz, B, deriv );
}

initialize()

StatusCode MagField::H8FieldSvc::initialize

(

)

Athena algorithm's interface methods.

framework methods

Definition at line 54 of file H8FieldSvc.cxx.

{
    ATH_MSG_INFO( "initialize() ..." );
    return StatusCode::SUCCESS;
}

initializeMap()

StatusCode MagField::H8FieldSvc::initializeMap ( )

private

readMap()

StatusCode MagField::H8FieldSvc::readMap ( const std::string &  mapFile )

private

Definition at line 72 of file H8FieldSvc.cxx.

{
    // find the path to the map file
    std::string resolvedMapFile = PathResolver::find_file( mapFile, "DATAPATH" );
    if ( resolvedMapFile.empty() ) {
        ATH_MSG_ERROR( "Field map file " << mapFile << " not found" );
        return StatusCode::FAILURE;
    }
    // opne the map file
    std::ifstream input( resolvedMapFile.c_str() );
    if ( ! input.good() ) {
        ATH_MSG_ERROR( "Failed to open the field map " << resolvedMapFile );
        return StatusCode::FAILURE;
    }
    // skip the file header line
    char line[256];
    input.getline( line, 256 );
    // read grids
    unsigned igrid(0);
    double offset[3];
    while (1) {
    // first determine offset
    if (igrid == 0) {
      // magnet #1
          offset[0] = m_dx1;
          offset[1] = m_dy1;
          offset[2] = m_dz1;
    } else if (igrid == 1) {
      // magnet #2
          offset[0] = m_dx2;
          offset[1] = m_dy2;
          offset[2] = m_dz2;
    } else {
      // shift up to two magnets
          offset[0] = 0;
          offset[1] = 0;
          offset[2] = 0;
    }
 
    // then, read the map and shift it
        BFieldH8Grid grid;
        grid.readMap( input );
    grid.setOffset(offset);
    
        if ( grid.defined() ) {
            ATH_MSG_INFO("setting offset for magnet " << igrid << " to " << offset[0] << ", " << offset[1] << ", " << offset[2] << " mm");
        // save grid
        double its_min[3];
        double its_max[3];
        double its_d[3];
        grid.getBounds(its_min, its_max, its_d);
            ATH_MSG_INFO("new magnet grid #" << igrid << " found");
            ATH_MSG_INFO("  - min    (mm) " << its_min[0] << ", " << its_min[1] << ", " << its_min[2]);
            ATH_MSG_INFO("  - max    (mm) " << its_max[0] << ", " << its_max[1] << ", " << its_max[2]);
            ATH_MSG_INFO("  - offset (mm) " << its_d[0] << ", " << its_d[1] << ", " << its_d[2]);
            m_grid.push_back( grid );
        igrid++;
        } else {
            break;
        }
    }
    ATH_MSG_INFO( "Initialized the field map from " << resolvedMapFile );
    return StatusCode::SUCCESS;
}

start()

StatusCode MagField::H8FieldSvc::start

(

)

Definition at line 60 of file H8FieldSvc.cxx.

{
    ATH_MSG_INFO( "start() ..." );
    return readMap( m_H8MapFilename );
}

Member Data Documentation

m_dx1

double MagField::H8FieldSvc::m_dx1

private

Definition at line 67 of file H8FieldSvc.h.

m_dx2

double MagField::H8FieldSvc::m_dx2

private

Definition at line 71 of file H8FieldSvc.h.

m_dy1

double MagField::H8FieldSvc::m_dy1

private

Definition at line 68 of file H8FieldSvc.h.

m_dy2

double MagField::H8FieldSvc::m_dy2

private

Definition at line 72 of file H8FieldSvc.h.

m_dz1

double MagField::H8FieldSvc::m_dz1

private

Definition at line 69 of file H8FieldSvc.h.

m_dz2

double MagField::H8FieldSvc::m_dz2

private

Definition at line 73 of file H8FieldSvc.h.

m_grid

std::vector<BFieldH8Grid> MagField::H8FieldSvc::m_grid

private

Definition at line 64 of file H8FieldSvc.h.

m_H8MapFilename

std::string MagField::H8FieldSvc::m_H8MapFilename

private

Data members.

Definition at line 61 of file H8FieldSvc.h.

---

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

• H8FieldSvc.h
• H8FieldSvc.cxx