Cylindrical3DMagneticField : A magnetic field from a cylindrical 3d field map (r, phi and z) More...
#include <Cylindrical3DMagneticField.h>
Inheritance diagram for marlintpc::Cylindrical3DMagneticField:
Classes | |
| struct | FieldMapEntry |
Public Member Functions | |
| Cylindrical3DMagneticField () | |
| constructor | |
| virtual | ~Cylindrical3DMagneticField () |
| destructor | |
| virtual Field * | new_field (void) |
| returns a new field... More... | |
| virtual bool | construct (EVENT::LCCollection *) |
| constructs the field from an LCCollection of data objects More... | |
 Public Member Functions inherited from marlintpc::MagneticField | |
| MagneticField (std::string field_typename) | |
| constructor | |
| virtual | ~MagneticField () |
| destructor | |
| virtual CLHEP::Hep3Vector | get_field_value (const CLHEP::Hep3Vector &) |
| gets the field value at a specified point | |
| virtual CLHEP::Hep3Vector | get_field_error () |
| gets the field error. More... | |
| void | set_translation (const CLHEP::Hep3Vector &) |
| sets the relative position of the origin of the field map (i.e. More... | |
| void | set_rotation (const double &, const double &) |
| sets the orientation of the TPC with respect to the coil axis More... | |
| void | set_scale_factor (const double &) |
| sets the scale factor for the magnetic field, i.e. More... | |
| Public Member Functions inherited from marlintpc::Field | |
| Field (std::string field_typename) | |
| constructor | |
| virtual | ~Field () |
| destructor | |
| CLHEP::HepVector | get_field_value (const CLHEP::HepVector &) |
| gets the field value at a specified point (in carthesian coordinates) More... | |
| std::string | get_typename () |
| returns the typename of the field | |
Protected Member Functions | |
| CLHEP::Hep3Vector | get_field_value_coil_coordinates (const CLHEP::Hep3Vector &) |
| gets the field value at a point given in coil coordinates | |
Additional Inherited Members | |
| Protected Attributes inherited from marlintpc::Field | |
| CLHEP::Hep3Vector | _field_error |
Detailed Description
Cylindrical3DMagneticField : A magnetic field from a cylindrical 3d field map (r, phi and z)
Member Function Documentation
|
virtual |
constructs the field from an LCCollection of data objects
constructs the field from an LCCollection of data objects (could be anything...
field bin values or just parameters)
Implements marlintpc::MagneticField.
|
virtual |
returns a new field...
similar to how the Marlin processor registration works
Implements marlintpc::MagneticField.
References Cylindrical3DMagneticField().
The documentation for this class was generated from the following files:
- Cylindrical3DMagneticField.h
- Cylindrical3DMagneticField.cc
