Polygon Class Reference

Description

A polygon, for use in detector masks.

Polygon defined by two arrays with x and y coordinates of points. Sizes of arrays should coincide. If polygon is unclosed (the last point doesn't repeat the first one), it will be closed automatically.

Definition at line 30 of file Polygon.h.

Inheritance diagram for Polygon:

Collaboration diagram for Polygon:

Public Member Functions
	Polygon (const PolygonPrivate *d)
	Polygon (std::vector< double > x, std::vector< double > y)
	If polygon is unclosed (the last point doesn't repeat the first one), it will be closed automatically. More...
	Polygon (std::vector< std::pair< double, double >> points)
	If polygon is unclosed (the last point doesn't repeat the first one), it will be closed automatically. More...
	~Polygon () override
Polygon *	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
void	getPoints (std::vector< double > &xpos, std::vector< double > &ypos) const
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

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

Private Attributes
PolygonPrivate *	m_d
const char *const	m_name

Constructor & Destructor Documentation

Polygon() [1/3]

Polygon::Polygon	(	std::vector< double >	x,
		std::vector< double >	y
	)

If polygon is unclosed (the last point doesn't repeat the first one), it will be closed automatically.

Parameters

x	Vector of x-coordinates of polygon points.
y	Vector of y-coordinates of polygon points.

Definition at line 71 of file Polygon.cpp.

    : IShape2D("Polygon")
    , m_d(new PolygonPrivate(x, y))
{
}

Referenced by clone().

Polygon() [2/3]

Polygon::Polygon

(

std::vector< std::pair< double, double >>

points

)

If polygon is unclosed (the last point doesn't repeat the first one), it will be closed automatically.

Parameters

points

Two dimensional vector of (x,y) coordinates of polygon points.

Definition at line 82 of file Polygon.cpp.

    : IShape2D("Polygon")
    , m_d(new PolygonPrivate(points))
{
}

Polygon() [3/3]

Polygon::Polygon

(

const PolygonPrivate *

d

)

Definition at line 88 of file Polygon.cpp.

    : IShape2D("Polygon")
    , m_d(new PolygonPrivate(*d))
{
}

~Polygon()

Polygon::~Polygon ( )

override

Definition at line 94 of file Polygon.cpp.

{
    delete m_d;
}

References m_d.

Member Function Documentation

clone()

Polygon* Polygon::clone ( ) const

inlineoverridevirtual

Implements IShape2D.

Definition at line 38 of file Polygon.h.

{ return new Polygon(m_d); }

References Polygon(), and m_d.

Here is the call graph for this function:

contains() [1/2]

bool Polygon::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 105 of file Polygon.cpp.

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

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

Here is the call graph for this function:

contains() [2/2]

bool Polygon::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 99 of file Polygon.cpp.

{
    // including borders
    return boost::geometry::covered_by(PolygonPrivate::point_t(x, y), m_d->polygon);
}

References m_d.

Referenced by contains().

getArea()

double Polygon::getArea

(

)

const

Definition at line 110 of file Polygon.cpp.

{
    return boost::geometry::area(m_d->polygon);
}

References m_d.

getPoints()

void Polygon::getPoints	(	std::vector< double > &	xpos,
		std::vector< double > &	ypos
	)		const

Definition at line 115 of file Polygon.cpp.

{
    m_d->get_points(xpos, ypos);
}

References m_d.

print()

void Polygon::print ( std::ostream &  ostr ) const

overrideprotectedvirtual

Reimplemented from IShape2D.

Definition at line 120 of file Polygon.cpp.

{
    ostr << boost::geometry::wkt<PolygonPrivate::polygon_t>(m_d->polygon);
}

References m_d.

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_d

PolygonPrivate* Polygon::m_d

private

Definition at line 51 of file Polygon.h.

Referenced by ~Polygon(), clone(), contains(), getArea(), getPoints(), and print().

m_name

const char* const IShape2D::m_name

privateinherited

Definition at line 52 of file IShape2D.h.

Referenced by IShape2D::print().

---

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

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