MultiGridLimit Class Reference

Class describing xy-limits for grid datasets supporting multiple input datasets. More...

#include "MultiGridLimit.hpp"

+ Inheritance diagram for MultiGridLimit:

Public Member Functions

bool isIntersect () const
 returns true if the limit denotes the common area of multiple datasets
bool isUnion () const
 returns true if the limit denotes the overall area of multiple datasets
bool isDataset () const
 returns true if the limit denotes the limits of a specific dataset
void setIntersect ()
 set limit as intersection of multiple datasets
void setUnion ()
 set limit as union of multiple datasets
void setDataset (const unsigned char &datasetNr)
 set limit as limit of a specific dataset (number)
int getDatasetNr () const
 query number of specified dataset (in case isDataset()==true)
ArrayD4 getLimits (const Vector< ArrayD4 > &inLimits)
 query user defined limits (in case isUserDef()==true)
- Public Member Functions inherited from GridLimit
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

CustomOptionType interface

static const char * help ()
static const char * syntax ()
static bool exportsPythonType ()

Additional Inherited Members

- Public Types inherited from GridLimit
typedef opals::Array< double, 4 > ArrayD4
 limit coordinate array
- Static Public Member Functions inherited from GridLimit
- Static Public Member Functions inherited from CustomOptionType< GridLimit >
static const char * _help ()
 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)
- Static Public Member Functions inherited from CustomOptionType< MultiGridLimit >
static const char * _help ()
 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 Member Functions inherited from CustomOptionType< GridLimit >
 ~CustomOptionType ()
 protected, must be derived from
- Protected Member Functions inherited from CustomOptionType< MultiGridLimit >
 ~CustomOptionType ()
 protected, must be derived from
- Protected Attributes inherited from GridLimit
ArrayD4 userLim
 }@
unsigned pixRef
unsigned limType
bool forceRound

Detailed Description

Class describing xy-limits for grid datasets supporting multiple input datasets.