SPATMOD::IMAGE::SOURCE_REGION Class Reference

Source which supports the REGION2D as a mask. More...

#include <spatmod/imagesourceregion.h>

Inheritance diagram for SPATMOD::IMAGE::SOURCE_REGION:

[legend]

List of all members.

Public Member Functions
	SOURCE_REGION (const REGION2D &Region, const TRANS2D_MAPGEN &TransToCRS, UINT32 TotalColumns, UINT32 TotalRows, double MemoryMaxUsage=4.0)
	SOURCE_REGION (const REGION2D &Region, const BASE &RefImage, double MemoryMaxUsage=4.0)
virtual	~SOURCE_REGION ()
const LRECT2D &	GetRegionExtents () const

---

Detailed Description

Source which supports the REGION2D as a mask.

The inside of the region is value '1' and the outside is value '0'. If the REGION2D is empty, an error will result in the call to Initialize().

---

Constructor & Destructor Documentation

SPATMOD::IMAGE::SOURCE_REGION::SOURCE_REGION	(	const REGION2D &	Region,
		const BASE &	RefImage,
		double	MemoryMaxUsage = 4.0
	)

Construct to match reference image.

The size of the source is determined by 'RefImage'. The decision whether to actually use memory is done during the Initialize() step.

Parameters:

	Region	Region to use
	RefImage	Reference image
	MemoryMaxUsage	Memory usage threshold (0 = none, < .5 = fraction of available, > .5 = MB)

SPATMOD::IMAGE::SOURCE_REGION::SOURCE_REGION	(	const REGION2D &	Region,
		const TRANS2D_MAPGEN &	TransToCRS,
		UINT32	TotalColumns,
		UINT32	TotalRows,
		double	MemoryMaxUsage = 4.0
	)

Construct with specified dimensions and image/map transformation.

The size of the source is determined by 'TotalRows' and 'TotalColumns'. The decision whether to actually use memory is done during the Initialize() step.

Parameters:

	Region	Region to use
	TransToCRS	Input section must contain transformation from image to a map CRS, not necessarily the one the 'region' is in. Output section is ignored. If 'Region' is already in 'RefImage' coordinates, pass an identity transformation.
	TotalColumns	Total columns
	TotalRows	Total rows
	MemoryMaxUsage	Memory usage threshold (0 = none, < .5 = fraction of available, > .5 = MB)

virtual SPATMOD::IMAGE::SOURCE_REGION::~SOURCE_REGION

(

)

[virtual]

Destructor.

---

Member Function Documentation

const LRECT2D& SPATMOD::IMAGE::SOURCE_REGION::GetRegionExtents

(

)

const [inline]

Obtain the extents of the region in image coordinates.

Only valid after call to Initialize(). Can be use as a parameter to FILTER_CROP.

Returns:

Extents of the region in image coordinates.

---

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

• spatmod/imagesourceregion.h