Rectangle Class Reference

Description

A rectangle, for use in detector masks.

Edges are along the coordinate axes.

Definition at line 25 of file Rectangle.h.

Inheritance diagram for Rectangle:

Collaboration diagram for Rectangle:

Public Member Functions
	Rectangle (double xlow, double ylow, double xup, double yup, bool inverted=false)
Rectangle *	clone () const override
bool	contains (const Bin1D &binx, const Bin1D &biny) const override
	Returns true if area defined by two bins is inside or on border of polygon (more precisely, if mid point of two bins satisfy this condition). More...
bool	contains (double x, double y) const override
	Returns true if point with given coordinates is inside or on border of the shape. More...
double	getArea () const
double	getXlow () const
double	getXup () const
double	getYlow () const
double	getYup () const
void	setInverted (bool inverted=true)
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Protected Member Functions
virtual void	print (std::ostream &ostr) const

Private Attributes
bool	m_inverted
const char *const	m_name
double	m_xlow
double	m_xup
double	m_ylow
double	m_yup

Constructor & Destructor Documentation

Rectangle()

Rectangle::Rectangle	(	double	xlow,
		double	ylow,
		double	xup,
		double	yup,
		bool	inverted = false
	)

Parameters

xlow	x-coordinate of lower left corner
ylow	y-coordinate of lower left corner
xup	x-coordinate of upper right corner
yup	y-coordinate of upper right corner
inverted	swap inside/outside

Definition at line 23 of file Rectangle.cpp.

    : IShape2D("Rectangle")
    , m_inverted(inverted)
{
    if (xup <= xlow) {
        std::ostringstream message;
        message << "Rectangle(double xlow, double ylow, double xup, double yup) -> Error. ";
        message << " xup <= xlow" << std::endl;
        throw std::runtime_error(message.str());
    }
    if (yup <= ylow) {
        std::ostringstream message;
        message << "Rectangle(double xlow, double ylow, double xup, double yup) -> Error. ";
        message << " yup <= ylow" << std::endl;
        throw std::runtime_error(message.str());
    }
    m_xlow = xlow;
    m_ylow = ylow;
    m_xup = xup;
    m_yup = yup;
}

References m_xlow, m_xup, m_ylow, and m_yup.

Referenced by clone().

Member Function Documentation

clone()

Rectangle* Rectangle::clone ( ) const

inlineoverridevirtual

Implements IShape2D.

Definition at line 28 of file Rectangle.h.

    {
        return new Rectangle(m_xlow, m_ylow, m_xup, m_yup, m_inverted);
    }

References Rectangle(), m_inverted, m_xlow, m_xup, m_ylow, and m_yup.

Here is the call graph for this function:

contains() [1/2]

bool Rectangle::contains ( const Bin1D &  binx, const Bin1D &  biny  ) const

overridevirtual

Returns true if area defined by two bins is inside or on border of polygon (more precisely, if mid point of two bins satisfy this condition).

Implements IShape2D.

Definition at line 56 of file Rectangle.cpp.

{
    return contains(binx.center(), biny.center());
}

References Bin1D::center(), and contains().

Here is the call graph for this function:

contains() [2/2]

bool Rectangle::contains ( double  x, double  y  ) const

overridevirtual

Returns true if point with given coordinates is inside or on border of the shape.

Implements IShape2D.

Definition at line 50 of file Rectangle.cpp.

{
    const bool inRect = x <= m_xup && x >= m_xlow && y <= m_yup && y >= m_ylow;
    return m_inverted ? !inRect : inRect;
}

References m_inverted, m_xlow, and m_ylow.

Referenced by contains().

getArea()

double Rectangle::getArea

(

)

const

Definition at line 61 of file Rectangle.cpp.

{
    return (m_xup - m_xlow) * (m_yup - m_ylow);
}

References m_xlow, m_xup, m_ylow, and m_yup.

getXlow()

double Rectangle::getXlow ( ) const

inline

Definition at line 40 of file Rectangle.h.

{ return m_xlow; }

References m_xlow.

getXup()

double Rectangle::getXup ( ) const

inline

Definition at line 42 of file Rectangle.h.

{ return m_xup; }

References m_xup.

getYlow()

double Rectangle::getYlow ( ) const

inline

Definition at line 41 of file Rectangle.h.

{ return m_ylow; }

References m_ylow.

getYup()

double Rectangle::getYup ( ) const

inline

Definition at line 43 of file Rectangle.h.

{ return m_yup; }

References m_yup.

print()

virtual void IShape2D::print ( std::ostream &  ostr ) const

inlineprotectedvirtualinherited

Reimplemented in Polygon.

Definition at line 49 of file IShape2D.h.

{ ostr << m_name; }

References IShape2D::m_name.

setInverted()

void Rectangle::setInverted

(

bool

inverted = true

)

Definition at line 45 of file Rectangle.cpp.

{
    m_inverted = inverted;
}

References m_inverted.

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

Used for Python overriding of clone (see swig/tweaks.py)

Definition at line 32 of file ICloneable.h.

Member Data Documentation

m_inverted

bool Rectangle::m_inverted

private

Definition at line 47 of file Rectangle.h.

Referenced by clone(), contains(), and setInverted().

m_name

const char* const IShape2D::m_name

privateinherited

Definition at line 52 of file IShape2D.h.

Referenced by IShape2D::print().

m_xlow

double Rectangle::m_xlow

private

Definition at line 46 of file Rectangle.h.

Referenced by Rectangle(), clone(), contains(), getArea(), and getXlow().

m_xup

double Rectangle::m_xup

private

Definition at line 46 of file Rectangle.h.

Referenced by Rectangle(), clone(), getArea(), and getXup().

m_ylow

double Rectangle::m_ylow

private

Definition at line 46 of file Rectangle.h.

Referenced by Rectangle(), clone(), contains(), getArea(), and getYlow().

m_yup

double Rectangle::m_yup

private

Definition at line 46 of file Rectangle.h.

Referenced by Rectangle(), clone(), getArea(), and getYup().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Mask/Rectangle.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Mask/Rectangle.cpp