![]() |
SynAPSE
0.6.0
Synergistic Analysis of Phase Space Evolution
|
Holds a set of beam line apertures. More...
#include <Aperture.hh>
Public Member Functions | |
| Aperture () | |
| Default constructor, initilizes everything to 0. More... | |
| Aperture (std::vector< double > starts, std::vector< double > ends, std::vector< double > radii, std::vector< std::string > names=std::vector< std::string >()) | |
| Normal constructor, sets apertures. More... | |
| Aperture (const Aperture &Aperture) | |
| Copy constructor. More... | |
| Aperture & | operator= (const Aperture &Aperture) |
| Equality operator. More... | |
| ~Aperture () | |
| Destructor. More... | |
| void | Initialize (std::vector< double > starts=std::vector< double >(), std::vector< double > ends=std::vector< double >(), std::vector< double > radii=std::vector< double >(), std::vector< std::string > names=std::vector< std::string >()) |
| Initializes the apertures. More... | |
| void | SetMICEDefault (const std::string &filename) |
| Sets the default MICE apertures. More... | |
| void | Add (double start, double end, double radius, std::string name="") |
| Adds a single aperture to the object. More... | |
| const double & | Radius (double z) const |
| Checks the aperture radius at a given position along the beam line. More... | |
| bool | IsIn (double x, double y, double z) const |
| Checks if the particle is within the apertures. More... | |
| void | Draw (std::string name="", double dz=1) const |
| Draws the apertures on a canvas. More... | |
Private Attributes | |
| std::vector< double > | _apertures |
| Summary vector used to fetch the smallest. More... | |
| std::vector< double > | _starts |
| Starting points vector of the apertures. More... | |
| std::vector< double > | _ends |
| End points vector of the apertures. More... | |
| std::vector< double > | _radii |
| Radii of the apertures. More... | |
| std::vector< std::string > | _names |
| Names of the apertures. More... | |
Holds a set of beam line apertures.
The object stores and manages a set of apertures encountered in the beam line. It contains definitions of methods associated with the apertures.
| Beam::Aperture::Aperture | ( | ) |
Default constructor, initilizes everything to 0.
| Beam::Aperture::Aperture | ( | std::vector< double > | starts, |
| std::vector< double > | ends, | ||
| std::vector< double > | radii, | ||
| std::vector< std::string > | names = std::vector<std::string>() |
||
| ) |
Normal constructor, sets apertures.
| starts | Starting points of the apertures [mm] |
| ends | End points of the apertures [mm] |
| radii | Radii of the apertures [mm] |
| names | Names of the apertures |
| Beam::Aperture::Aperture | ( | const Aperture & | Aperture | ) |
Copy constructor.
| Beam::Aperture::~Aperture | ( | ) |
Destructor.
| void Beam::Aperture::Add | ( | double | start, |
| double | end, | ||
| double | radius, | ||
| std::string | name = "" |
||
| ) |
Adds a single aperture to the object.
| start | Starting point of the aperture [mm] |
| end | End point of the aperture [mm] |
| radius | Radius of the aperture [mm] |
| name | Name of the aperture |
| void Beam::Aperture::Draw | ( | std::string | name = "", |
| double | dz = 1 |
||
| ) | const |
Draws the apertures on a canvas.
| name | Name of the beam line |
| dz | Stepping size between points [mm] |
| void Beam::Aperture::Initialize | ( | std::vector< double > | starts = std::vector<double>(), |
| std::vector< double > | ends = std::vector<double>(), |
||
| std::vector< double > | radii = std::vector<double>(), |
||
| std::vector< std::string > | names = std::vector<std::string>() |
||
| ) |
Initializes the apertures.
| starts | Starting points of the apertures [mm] |
| ends | End points of the apertures [mm] |
| radii | Radii of the apertures [mm] |
| names | Names of the apertures |
| bool Beam::Aperture::IsIn | ( | double | x, |
| double | y, | ||
| double | z | ||
| ) | const |
Checks if the particle is within the apertures.
| x | Horizontal coordinate [mm] |
| y | Vertical coordinate [mm] |
| z | Position along the beam line [mm] |
| const double & Beam::Aperture::Radius | ( | double | z | ) | const |
Checks the aperture radius at a given position along the beam line.
| z | Position along the beam line [mm] |
| void Beam::Aperture::SetMICEDefault | ( | const std::string & | filename | ) |
Sets the default MICE apertures.
| filename | Path to the MICE geometry file |
|
private |
Summary vector used to fetch the smallest.
|
private |
End points vector of the apertures.
|
private |
Names of the apertures.
|
private |
Radii of the apertures.
|
private |
Starting points vector of the apertures.
1.8.6