MarlinTPC  1.2.0
Public Member Functions | Protected Attributes | List of all members
marlintpc::Field Class Referenceabstract

Field : A base interface to an electric or magnetic field. More...

#include <Field.h>

Inheritance diagram for marlintpc::Field:
marlintpc::CGAElectricField marlintpc::CGAMagneticField marlintpc::ConstantUnidirectionalMagneticField marlintpc::DIDZMapMagneticField marlintpc::GEARMagneticField marlintpc::IdealSolenoidField marlintpc::MagneticField marlintpc::SolenoidZMapMagneticField marlintpc::UnitBiDirectionalElectricField

Public Member Functions

 Field (std::string field_typename)
 constructor
 
virtual ~Field ()
 destructor
 
virtual Fieldnew_field (void)=0
 returns a new field... More...
 
virtual bool construct (EVENT::LCCollection *)=0
 constructs the field from an LCCollection of data objects (could be anything... More...
 
CLHEP::HepVector get_field_value (const CLHEP::HepVector &)
 gets the field value at a specified point (in carthesian coordinates) More...
 
virtual CLHEP::Hep3Vector get_field_value (const CLHEP::Hep3Vector &)=0
 gets the field value at a specified point
 
virtual CLHEP::Hep3Vector get_field_error ()
 gets the field error. More...
 
std::string get_typename ()
 returns the typename of the field
 

Protected Attributes

CLHEP::Hep3Vector _field_error
 

Detailed Description

Field : A base interface to an electric or magnetic field.

Author
J. Abernathy (UVic)

Member Function Documentation

virtual bool marlintpc::Field::construct ( EVENT::LCCollection *  )
pure virtual
CLHEP::Hep3Vector marlintpc::Field::get_field_error ( )
virtual

gets the field error.

Assumes that the error is symmetric and independent of position

Reimplemented in marlintpc::MagneticField.

CLHEP::HepVector marlintpc::Field::get_field_value ( const CLHEP::HepVector &  position)

gets the field value at a specified point (in carthesian coordinates)

Deprecated:
replaced by get_field_value(const CLHEP::Hep3Vector&)}
virtual Field* marlintpc::Field::new_field ( void  )
pure virtual

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