GridLimit.hpp

#pragma once
 
//OPALS
#include "opals/config.hpp"
#include "opals/Array.hpp"
#include "opals/CustomOptionType.hpp"
 
namespace opals {
 
  /// Class describing xy-limits for grid datasets
  class OPALS_API GridLimit : public CustomOptionType<GridLimit>
  {
  public:
    typedef opals::Array<double,4>    ArrayD4;    ///< limit coordinate array
 
  public:
    GridLimit();
    virtual ~GridLimit();
 
    /// returns true if limit refers to pixel corner
    bool isPixelCorner() const { return pixRef==0; };
    /// returns true if limit refers to pixel center
    bool isPixelCenter() const { return pixRef==1; };
    /// returns true if a user defined limit is set
    bool isUserDef()     const { return limType==0; };
    // returns true if rounding of the limits required
    bool isRoundLimits() const { return forceRound; };
 
    /// set limit reference to pixel corner
    void setPixelCorner();
    /// set limit reference to pixel center
    void setPixelCenter();
    /// set limit as intersection of multiple datasets
    /// set user defined limits
    void setForceRound( const bool& Irb_active );
    /// set/reset the force round flag 
    void setUserLimits( const ArrayD4& lim );
 
    ArrayD4 getUserLimits() const { return userLim; };
    /// query limits of given input limits with respect to the class attributes (intersection/union/dataset)
 
    /// \name CustomOptionType interface
    ///@{
    static const char * help(bool);
    static const char * syntax();
    static bool exportsPythonType();
    ///@}
 
  protected: 
    ArrayD4 userLim;
    unsigned /*char*/ pixRef, limType;
    bool forceRound;
  };
}