ome::bioformats::PlaneRegion Struct Reference

A rectangular region. More...

#include <ome/bioformats/PlaneRegion.h>

Public Member Functions
	PlaneRegion ()
	Default construct. More...
bool	valid () const
	Is the region valid? More...
	PlaneRegion (dimension_size_type x, dimension_size_type y, dimension_size_type w, dimension_size_type h)
	Construct from coordinates, width and height. More...
dimension_size_type	area () const
	Get area. More...

Public Attributes
dimension_size_type	x
	The X coordinate of the upper-left corner of the region.
dimension_size_type	y
	The Y coordinate of the upper-left corner of the region.
dimension_size_type	w
	The width of the region.
dimension_size_type	h
	The height of the region.

Detailed Description

A rectangular region.

The region is specified by top-left (x,y) coordinates plus width and height.

Constructor & Destructor Documentation

ome::bioformats::PlaneRegion::PlaneRegion ( )

inline

Default construct.

By default the region has zero width and height.

ome::bioformats::PlaneRegion::PlaneRegion ( dimension_size_type  x, dimension_size_type  y, dimension_size_type  w, dimension_size_type  h  )

inline

Construct from coordinates, width and height.

Parameters

x	the X coordinate of the upper-left corner of the region.
y	the Y coordinate of the upper-left corner of the region.
w	the width of the region.
h	the height of the region.

Member Function Documentation

dimension_size_type ome::bioformats::PlaneRegion::area ( ) const

inline

Get area.

Returns

the covered area.

References h.

Referenced by ome::bioformats::TileCoverage::coverage().

Here is the caller graph for this function:

bool ome::bioformats::PlaneRegion::valid ( ) const

inline

Is the region valid?

Returns

true if the region has a nonzero width and height, false otherwise.

References h.

Referenced by ome::bioformats::TileCoverage::coverage(), and ome::bioformats::TileCoverage::insert().

Here is the caller graph for this function:

---

The documentation for this struct was generated from the following file:

• ome/bioformats/PlaneRegion.h