BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Ellipse Class Reference

Ellipse shape. More...

+ Inheritance diagram for Ellipse:

Public Member Functions

 Ellipse (double xcenter, double ycenter, double xradius, double yradius, double theta=0.0)
 
Ellipseclone () const
 
bool contains (double x, double y) const
 Returns true if point with given coordinates is inside or on border of the shape.
 
bool contains (const Bin1D &binx, const Bin1D &biny) const
 Returns true if area defined by two bins is inside or on border of ellipse; more precisely, if mid point of two bins satisfy this condition.
 
double getCenterX () const
 
double getCenterY () const
 
double getRadiusX () const
 
double getRadiusY () const
 
double getTheta () const
 
- Public Member Functions inherited from IShape2D
 IShape2D (const char *name)
 
- Public Member Functions inherited from ICloneable
 ICloneable (const ICloneable &)=delete
 
 ICloneable (ICloneable &&)=default
 
virtual void transferToCPP ()
 Used for Python overriding of clone (see swig/tweaks.py)
 

Additional Inherited Members

- Protected Member Functions inherited from IShape2D
virtual void print (std::ostream &ostr) const
 

Detailed Description

Ellipse shape.

Definition at line 23 of file Ellipse.h.

Constructor & Destructor Documentation

◆ Ellipse()

Ellipse::Ellipse ( double  xcenter,
double  ycenter,
double  xradius,
double  yradius,
double  theta = 0.0 
)
Parameters
xcenterx-coordinate of Ellipse's center
ycentery-coordinate of Ellipse's center
xradiusRadius along x-axis
yradiusRadius along y-axis
thetaAngle of Ellipse rotation in radians

Definition at line 24 of file Ellipse.cpp.


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