region_base.h

Go to the documentation of this file.

/*
Arroyo - software for the simulation of electromagnetic wave propagation
through turbulence and optics.

Copyright (c) 2000-2004 California Institute of Technology.  Written by
Dr. Matthew Britton.  For comments or questions about this software,
please contact the author at mbritton@astro.caltech.edu.

This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as  published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.

This program is provided "as is" and distributed in the hope that it
will be useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  In no
event shall California Institute of Technology be liable to any party
for direct, indirect, special, incidental or consequential damages,
including lost profits, arising out of the use of this software and its
documentation, even if the California Institute of Technology has been
advised of the possibility of such damage.   The California Institute of
Technology has no obligation to provide maintenance, support, updates,
enhancements or modifications.  See the GNU General Public License for
more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
*/

#ifndef REGION_BASE_H
#define REGION_BASE_H

#include <iostream>
#include <string>
#include "three_point.h"

namespace Arroyo {

  class three_point;

  using std::string;
  using std::ostream;
  using std::vector;


  class region_base {

  public:
  
    region_base(){};

    virtual ~region_base(){};

    virtual void print(ostream & os, const char * prefix = "",
                                        long precision = 6) const = 0;

    virtual void print(ostream & os, const three_frame & tf,
                const char * prefix = "", long precision = 6) const = 0;
    

    static int verbose_level;

  };


  class rectangular_region :
    public region_base {

    vector<three_point> corners;

    string region_status(const rectangular_region & rec_region) const;

    void sort_corners();

    public:

    rectangular_region(){};
    
    rectangular_region(const rectangular_region & rec_region);
    
    rectangular_region(const vector<three_point> & in_corners);
    
    rectangular_region(const three_frame & tf, vector<long> axes, double pix);
    
    rectangular_region(const rectangular_region & rec_region,
                        const three_vector & nrml, bool along_nrml);
    
    rectangular_region(const rectangular_region & rec_region,
                       double pix);
    
    ~rectangular_region(){};
    
    rectangular_region & operator=(const rectangular_region & rec_region);

    bool aligned(const rectangular_region & rec_region) const;

    bool contains(const rectangular_region & rec_region) const;

    bool is_contained(const rectangular_region & rec_region) const;

    bool is_disjoint(const rectangular_region & rec_region) const;

    vector<three_point> get_corners() const;

    three_point get_center() const;    

    void print(ostream & os, const char * prefix = "", long precision = 6) const;

    void print(ostream & os, const three_frame & tf,
                const char * prefix = "", long precision = 6) const;

    friend rectangular_region region_union(const rectangular_region & rec_region1,
                                           const rectangular_region & rec_region2);

    friend rectangular_region region_intersection(
                        const rectangular_region & rec_region1,
                        const rectangular_region & rec_region2);

    friend bool operator==(const rectangular_region & rec_region1,
                           const rectangular_region & rec_region2);

  };

  bool operator!=(const rectangular_region & rec_region1,
                  const rectangular_region & rec_region2);

}

#endif

---