Polygon Class Reference

A polygon, for use in detector masks. More...

Inheritance diagram for Polygon:

Collaboration diagram for Polygon:

Public Member Functions
	Polygon (const PolygonPrivate *d)
	Polygon (const std::vector< double > x, const std::vector< double > y)
	Polygon (const std::vector< std::vector< double >> points)
	Polygon defined by two dimensional array with (x,y) coordinates of polygon points. More...
virtual	~Polygon ()
virtual Polygon *	clone () const
virtual bool	contains (const Bin1D &binx, const Bin1D &biny) const
	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...
virtual bool	contains (double x, double y) const
	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
virtual void	print (std::ostream &ostr) const

Private Attributes
PolygonPrivate *	m_d
const char *const	m_name

Detailed 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.

Constructor & Destructor Documentation

Polygon() [1/3]

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

Parameters

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

Definition at line 63 of file Polygon.cpp.

    : IShape2D("Polygon"), m_d(new PolygonPrivate)
{
    m_d->init_from(x, y);
}

References PolygonPrivate::init_from(), and m_d.

Referenced by clone().

Here is the call graph for this function:

Polygon() [2/3]

Polygon::Polygon

(

const std::vector< std::vector< double >>

points

)

Polygon defined by two dimensional array with (x,y) coordinates of polygon points.

The size of second dimension should be 2. 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 75 of file Polygon.cpp.

    : IShape2D("Polygon"), m_d(new PolygonPrivate)
{
    std::vector<double> x;
    std::vector<double> y;
    for (size_t i = 0; i < points.size(); ++i) {
        if (points[i].size() != 2)
            throw std::runtime_error(
                "Polygon(const std::vector<std::vector<double> >& points) -> Error. "
                " Should be two-dimensional array with second dimension of 2 size.");
        x.push_back(points[i][0]);
        y.push_back(points[i][1]);
    }
    m_d->init_from(x, y);
}

References PolygonPrivate::init_from(), and m_d.

Here is the call graph for this function:

Polygon() [3/3]

Polygon::Polygon

(

const PolygonPrivate *

d

)

Definition at line 91 of file Polygon.cpp.

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

~Polygon()

Polygon::~Polygon ( )

virtual

Definition at line 93 of file Polygon.cpp.

{
    delete m_d;
}

References m_d.

Member Function Documentation

clone()

virtual Polygon* Polygon::clone ( ) const

inlinevirtual

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

virtual

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 104 of file Polygon.cpp.

{
    return 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

virtual

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

Implements IShape2D.

Definition at line 98 of file Polygon.cpp.

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

References m_d, and PolygonPrivate::polygon.

Referenced by contains().

getArea()

double Polygon::getArea

(

)

const

Definition at line 109 of file Polygon.cpp.

{
    return area(m_d->polygon);
}

References m_d, and PolygonPrivate::polygon.

getPoints()

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

Definition at line 114 of file Polygon.cpp.

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

References PolygonPrivate::get_points(), and m_d.

Here is the call graph for this function:

print()

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

protectedvirtual

Reimplemented from IShape2D.

Definition at line 119 of file Polygon.cpp.

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

References m_d, and PolygonPrivate::polygon.

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

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

Definition at line 34 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(), ~Polygon(), clone(), contains(), getArea(), getPoints(), and print().

m_name

const char* const IShape2D::m_name

privateinherited

Definition at line 49 of file IShape2D.h.

Referenced by IShape2D::print().

---

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

• /home/www/ba/Device/Mask/Polygon.h
• /home/www/ba/Device/Mask/Polygon.cpp