BfldMapRect2d.h

Go to the documentation of this file.

// $Id: BfldMapRect2d.h,v 1.8 2005/02/03 23:00:29 rhatcher Exp $
//
// BfldMapRect2d
//
// This structure provides services for holding the magnetic field components
// at a series of points (cf. BfldMesh).  It encapsulates knowledge 
// about the field values themselves, an possibly how to adjust them
// for external effects (chemistry, coil current, etc.) but doesn't
// explicitly hold any knowledge about the relative spatial placement
// of the field values; that it must glean from BfldMesh.
//
// This class is specialized to handle the old rectangular 2d grid maps
//
// Author:  R. Hatcher 2000.06.20
//
#ifndef BFLDMAPRECT2D_H
#define BFLDMAPRECT2D_H

#include <string>

#include "BField/BfldMap.h"

class BfldMapRect2d : public BfldMap {

 public:
   BfldMapRect2d();
   BfldMapRect2d(BfldGrid::Grid_t grid, Int_t variant);
   virtual ~BfldMapRect2d();

   // BfldMeshRect2d needs to know the position info for this map
   inline Float_t       GetX0() const { return fX0; }
   inline Float_t       GetY0() const { return fY0; }
   inline Float_t       GetDx() const { return fDx; }
   inline Float_t       GetDy() const { return fDy; }
   inline Int_t         GetNx() const { return fNx; }
   inline Int_t         GetNy() const { return fNy; }

   inline Bool_t        GetIsUVZ() const { return fIsUVZ; }

   inline const Int_t*  GetQuadFlags() const { return fQuadFlags; }

 protected:

   std::string   fHeader;       // descriptive header in file

   Float_t       fX0;           // lowest x value
   Float_t       fDx;           // x increment (base length unit)
   Int_t         fNx;           // number of x values

   Float_t       fY0;           // lowest y value
   Float_t       fDy;           // y increment (base length unit)
   Int_t         fNy;           // number of y values

   Bool_t        fIsUVZ;        // data is in UVZ coordinates

   Bool_t        fQuadrant;     // true if map only has one quadrant
   Int_t         fQuadFlags[4]; // sign flips for different quadrants
   Int_t         fFileForm;     // file format (3 types of files)


 private:

   void Clear(const Option_t* = "");
   
   ClassDef(BfldMapRect2d,2)
};
#endif // BFLDMAPRECT2D_H

---