RegionManager.h

Go to the documentation of this file.

//# RegionManager.h: framework independent class that provides 
//# functionality to tool of same name
//# Copyright (C) 2007
//# Associated Universities, Inc. Washington DC, USA.
//#
//# 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 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.  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.,
//# 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//#        Internet email: aips2-request@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#                        Charlottesville, VA 22903-2475 USA
//#
//# $Id$

#ifndef IMAGES_REGIONMANAGER_H
#define IMAGES_REGIONMANAGER_H

#include <casacore/casa/aips.h>
#include <casacore/casa/Quanta/Quantum.h>
#include <casacore/coordinates/Coordinates/CoordinateSystem.h>
#include <casacore/lattices/LRegions/RegionType.h>
#include <casacore/tables/Tables/Table.h>


namespace casacore {

  class LogIO;
  class String;
  class Record;
  template<class T> class Vector;
  class WCRegion;
  class WCBox;
  template<class T> class PtrBlock;
  class ImageRegion;

  class RegionManager
    {
      
      
    public:

      //blank constructor
      RegionManager();
      RegionManager(const CoordinateSystem& csys);
      virtual ~RegionManager();
      String absreltype(const Int absrelval=0);

      //Some little but useful tidbits.
      static Bool isPixelRegion(const ImageRegion& reg);
      static Bool isWorldRegion(const ImageRegion& reg);
      void setcoordsys(const CoordinateSystem& csys);
      const CoordinateSystem& getcoordsys() const ;
      
      //LCSlicer box
      Record* box(const Vector<Double>& blc, const Vector<Double>& trc, 
                  const Vector<Double>& inc, const String& absrel,
                  const Bool frac, const String& comment="");
      //LCBox box
      static Record* box(const Vector<Double>& blc, const Vector<Double>& trc, 
                         const Vector<Int>& shape, const String& comment="");
      Record* wbox(const Vector<Quantity>& blc, 
                        const Vector<Quantity>& trc, 
                        const Vector<Int>& pixelaxes, 
                        const CoordinateSystem& csys,
                        const String& absrel, const String& comment);
      Record* wbox(const Vector<String>& blc, 
                        const Vector<String>& trc, 
                        const Vector<Int>& pixelaxes, 
                        const CoordinateSystem& csys,
                        const String& absrel, const String& comment);
      Record* wbox(const Vector<Quantity>& blc, 
                        const Vector<Quantity>& trc, 
                        const Vector<Int>& pixelaxes, 
                        const String& absrel, const String& comment);
      Record* wbox(const Vector<String>& blc, 
                        const Vector<String>& trc, 
                        const Vector<Int>& pixelaxes, 
                        const String& absrel, const String& comment);
      ImageRegion* wbox(const Vector<Quantity>& blc, 
                        const Vector<Quantity>& trc, 
                        const Vector<Int>& pixelaxes, 
                        const CoordinateSystem& csys,
                        const String& absrel="abs" );
      //Wpolygon with coordsys and if pixelaxes[0] is -1 then its assumed
      //to be 0,1,...
      ImageRegion* wpolygon(const Vector<Quantity>& x, 
                            const Vector<Quantity>& y, 
                            const Vector<Int>& pixelaxes, 
                            const CoordinateSystem& csys, 
                            const String& absrel);
      //wpolygon version without csys...throws an exception if 
      //setcoordsys is not run
      ImageRegion* wpolygon(const Vector<Quantity>& x, 
                            const Vector<Quantity>& y, 
                            const Vector<Int>& pixelaxes,  
                            const String& absrel);
      
     static ImageRegion* wellipse(
                  const Quantity& xc,
                  const Quantity& yc,
                  const Quantity& a,
                  const Quantity& b,
                  const Quantity& pa,
                  const uInt pixelAxis0,
                  const uInt pixelAxis1,
                  const CoordinateSystem& csys,
                  const String& absrel
      );

      //wellipse version without csys...throws an exception if
      //setcoordsys is not run
      ImageRegion* wellipse(
                  const Quantity& xc,
                  const Quantity& yc,
                  const Quantity& a,
                  const Quantity& b,
                  const Quantity& pa,
                  const uInt pixelAxis0,
                  const uInt pixelAxis1,
                  const String& absrel
      ) const;

      static ImageRegion* wsphere(
                  const Vector<Quantity>& center,
                  const Quantity& radius,
                  const Vector<Int>& pixelaxes,
                  const CoordinateSystem& csys,
                  const String& absrel
      );
      //wsphere version without csys...throws an exception if
      //setcoordsys is not run
      ImageRegion* wsphere(
                  const Vector<Quantity>& center,
                  const Quantity& radius,
                  const Vector<Int>& pixelaxes,
                  const String& absrel
      ) const;

      static ImageRegion* wellipsoid(
                  const Vector<Quantity>& center,
                  const Vector<Quantity>& radii,
                  const Vector<Int>& pixelaxes,
                  const CoordinateSystem& csys,
                  const String& absrel
      );

      ImageRegion* wellipsoid(
                  const Vector<Quantity>& center,
                  const Vector<Quantity>& radii,
                  const Vector<Int>& pixelaxes,
                  const String& absrel
      ) const;

      static ImageRegion* wshell(
                  const Vector<Quantity>& center,
                  const Vector<Quantity>& innerRadii,
                  const Vector<Quantity>& outerRadii,
                  const Vector<Int>& pixelaxes,
                  const CoordinateSystem& csys,
                  const String& absrel
      );

      ImageRegion* wshell(
                  const Vector<Quantity>& center,
                  const Vector<Quantity>& innerRadii,
                  const Vector<Quantity>& outerRadii,
                  const Vector<Int>& pixelaxes,
                  const String& absrel
      ) const;

      static ImageRegion* wmask(const String& command);


      /**************************************************************
       ** Routines for combining regions                           **
       **                                                          **
       ** Note: Many of the WCXxx classes which are used to do the **
       **       work can take multiple regions at once, why not    **
       **       accept a ptr block of Image Regions then?          **
       **************************************************************/

      //Various versions of creating a complement region
      ImageRegion*  doComplement(const WCRegion& reg1);
      ImageRegion*  doComplement(const PtrBlock<const WCRegion*>& reg1);
      ImageRegion*  doComplement(const ImageRegion& reg1);

      //Various versions of concatenating a region onto another.
      ImageRegion*  doConcatenation(const WCRegion& region, const WCBox& box);
      ImageRegion*  doconcatenation(const PtrBlock<const WCRegion*>& regions, const WCBox& box);
      ImageRegion*  doConcatenation(const PtrBlock<const ImageRegion*>& regions, const TableRecord& box);
      ImageRegion*  doConcatenation(const Record& regions, const TableRecord& box);


      //Various versions of handling the difference of regions
      ImageRegion*  doDifference(const WCRegion& reg1, const WCRegion& reg2);
      ImageRegion*  doDifference(const PtrBlock<const WCRegion*>& reg1);
      ImageRegion*  doDifference(const ImageRegion& reg1, const ImageRegion& reg2);
      
      //Different versions of intersecting regions
      ImageRegion*  doIntersection(const WCRegion& reg1, const WCRegion& reg2);
      ImageRegion*  doIntersection(const PtrBlock<const WCRegion*>& reg1);
      ImageRegion*  doIntersection(const ImageRegion& reg1, const ImageRegion& reg2);

      //Different versions of unioning regions
      ImageRegion*  doUnion(const WCRegion& reg1, const WCRegion& reg2);
      ImageRegion*  doUnion(const PtrBlock<const WCRegion*>& reg1);
      ImageRegion*  doUnion(const ImageRegion& reg1, const ImageRegion& reg2) const;
      

      /**************************************************************
       ** Routines for reading/writing regions                     **
       **************************************************************/

      //Reading of a file containing an ImageRegion in the AipsIO format dump
      static Record* readImageFile( String filename, String regionname );
      //Writing a file of the AipsIO dump of the record representation of the region
      static Bool writeImageFile(const String& file, const String& regionname, const Record& regionRecord);

      
      //save region into a table (image, blank table or any other such)
      String imageRegionToTable(const String& tabName, 
                                const ImageRegion& imreg,
                                const String& regName, Bool asmask=False); 

      String recordToTable(const String& tabName, const RecordInterface& rec, 
                           const String& regName="", Bool asmask=False);
      //recover region from table
      Record* tableToRecord(const String& tabName,   const String& regname);

      //names of regions in table
      Vector<String> namesInTable(const String& tabName);

      //Remove a region from table...refuse is regionname is ""
      Bool removeRegionInTable(const String& tabName, const String& regName);


    protected:
      inline LogIO* _getLog() const { return itsLog; }

    private:
      LogIO *itsLog;
      std::unique_ptr<CoordinateSystem> itsCSys;
      // Function to return the internal Table object to the RegionHandler.
      static Table& getTable (void* ptr, Bool writable);
      //Convert a string to Quantity
      void toQuantity(Quantity& out, const String& in);
      Table tab_p;

    };


} // casa namespace
#endif