MarlinTPC  1.2.0
Classes | Public Member Functions | Protected Member Functions | List of all members
marlintpc::Cylindrical2DMagneticField Class Reference

Cylindrical2DMagneticField : A magnetic field from a cylindrical 2d field map (r and z) More...

#include <Cylindrical2DMagneticField.h>

Inheritance diagram for marlintpc::Cylindrical2DMagneticField:
marlintpc::MagneticField marlintpc::Field

Classes

struct  FieldMapEntry
 

Public Member Functions

 Cylindrical2DMagneticField ()
 constructor
 
virtual ~Cylindrical2DMagneticField ()
 destructor
 
void init (double, double, double, double, double)
 initialize function – if one copies the marlin registration process it might be better to do it right I know this is a mess, but it needs a complete redesign
 
virtual Fieldnew_field (void)
 returns a new field... More...
 
virtual bool construct (EVENT::LCCollection *)
 constructs the field from an LCCollection of data objects (could be anything... 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

Cylindrical2DMagneticField : A magnetic field from a cylindrical 2d field map (r and z)

Author
Christian Grefe

Member Function Documentation

bool marlintpc::Cylindrical2DMagneticField::construct ( EVENT::LCCollection *  collection)
virtual

constructs the field from an LCCollection of data objects (could be anything...

field bin values or just parameters)

Implements marlintpc::MagneticField.

Field * marlintpc::Cylindrical2DMagneticField::new_field ( void  )
virtual

returns a new field...

similar to how the Marlin processor registration works

Implements marlintpc::MagneticField.

References Cylindrical2DMagneticField().


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