GridLimit Class Reference

Class describing xy-limits for grid datasets. More...

#include "GridLimit.hpp"

Inheritance diagram for GridLimit:

Public Types
typedef opals::Array< double, 4 >	ArrayD4
	limit coordinate array

Public Member Functions
bool	isPixelCorner () const
	returns true if limit refers to pixel corner
bool	isPixelCenter () const
	returns true if limit refers to pixel center
bool	isUserDef () const
	returns true if a user defined limit is set
bool	isRoundLimits () const
void	setPixelCorner ()
	set limit reference to pixel corner
void	setPixelCenter ()
	set limit reference to pixel center
void	setForceRound (const bool &Irb_active)
void	setUserLimits (const ArrayD4 &lim)
	set/reset the force round flag
ArrayD4	getUserLimits () const

Static Public Member Functions
CustomOptionType interface
query limits of given input limits with respect to the class attributes (intersection/union/dataset)
static const char *	help (bool)
static const char *	syntax ()
static bool	exportsPythonType ()
Static Public Member Functions inherited from CustomOptionType< GridLimit >
static const char *	_help (bool forDoxygen)
	get general help on this type
static const char *	_syntax ()
	get the syntax used for parsing this type
static bool	_exportsPythonType ()
	returns true if this type is exposed to Python as a custom type, false otherwise (if it is represented as Python-string)

Protected Attributes
ArrayD4	userLim
unsigned	pixRef
unsigned	limType
bool	forceRound

Additional Inherited Members
Protected Member Functions inherited from CustomOptionType< GridLimit >
	~CustomOptionType ()
	protected, must be derived from

Detailed Description

Class describing xy-limits for grid datasets.

Member Function Documentation

setForceRound()

void setForceRound

(

const bool &

Irb_active

)

set limit as intersection of multiple datasets set user defined limits