QtWCBox.h

Go to the documentation of this file.

//# QtWCBox.h: Class to define a box shaped WC region
//# Copyright (C) 1998,1999,2001
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library 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 Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; 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: QtWCBox.h 20567 2009-04-09 23:12:39Z gervandiepen $



#ifndef QT_WCBOX_H
#define QT_WCBOX_H

//# Includes
#include <casa/aips.h>
#include <coordinates/Coordinates/CoordinateSystem.h>
#include <images/Regions/WCRegion.h>
#include <lattices/Lattices/RegionType.h>
#include <casa/Arrays/Vector.h>
#include <casa/Quanta/Quantum.h>

namespace casa { //# NAMESPACE CASA - BEGIN

//# Forward Declarations
class LCRegion;
class TableRecord;
class IPosition;


class QtWCBox : public WCRegion
{
public:
   QtWCBox();

   // Construct from vectors of world coordinates 
   // defining the box corners.  It is assumed that the
   // order of the values is in the order of the pixel axes
   // in the given coordinate system.
   // <group>
   QtWCBox(const Vector<Quantum<Double> >& blc,
         const Vector<Quantum<Double> >& trc,
         const CoordinateSystem& cSys,
         const Vector<Int>& absRel);
   // </group>

   // Construct from vectors of world coordinates 
   // defining the box corners.   You specify the pixel 
   // axis order of the world values. 
   // <group>
   QtWCBox(const Vector<Quantum<Double> >& blc,
         const Vector<Quantum<Double> >& trc,
         const IPosition& pixelAxes,
         const CoordinateSystem& cSys,
         const Vector<Int>& absRel);
   // </group>

   // Construct from the bounding box of an  <src>LCRegion</src>.  
   QtWCBox(const LCRegion& region,
         const CoordinateSystem& cSys);

   // Copy constructor (reference semantics [except for <src>CoordinateSystem</src>])
   QtWCBox (const QtWCBox& other);

   // Destructor
   virtual ~QtWCBox();

   // Assignment (copy semantics) 
   QtWCBox& operator= (const QtWCBox& other);

   // Comparison
   virtual Bool operator==(const WCRegion& other) const;

   // Clone a QtWCBox object.
   virtual WCRegion* cloneRegion() const;

   // QtWCBox can extend a region.
   virtual Bool canExtend() const;

   // Make a new box from the given axesin this box.
   QtWCBox splitBox (const IPosition& axes) const;

   // Convert to an LCRegion using the supplied <src>CoordinateSystem</src> 
   // and shape.  
   virtual LCRegion* doToLCRegion (const CoordinateSystem& cSys,
                                   const IPosition& latticeShape,
                                   const IPosition& pixelAxesMap,
                                   const IPosition& outOrder) const;

   // Convert the QtWCBox object to a record.
   // The record can be used to make the object persistent.
   // The <src>tableName</src> argument can be used by derived
   // classes (e.g. LCPagedMask) to put very large objects.
   virtual TableRecord toRecord(const String& tableName) const;

   // Convert to a QtWCBox from a record.
   static QtWCBox* fromRecord (const TableRecord& rec,
                             const String& tableName);

   // Returns QtWCBox
   static String className();

   // Return region type.  Returns the class name 
   virtual String type() const;

   // Convert from/to boxit format string
   String toBoxString() const;
   static QtWCBox* fromBoxString(const String&, 
                               const CoordinateSystem& cSys, String& err);

   // FIXME: refactor to someplace more appropriate
   // get/set chan extension
   void setChanExt(const Double, const Double);
   Bool getChanExt(Double&, Double&);

   // FIXME: refactor to someplace more appropriate
   // get/set pol extension
   void setPolExt(const Double, const Double);
   Bool getPolExt(Double&, Double&);

   static void unitInit();

private:
   Vector<Quantum<Double> > itsBlc;
   Vector<Quantum<Double> > itsTrc;
   IPosition itsPixelAxes;
   CoordinateSystem itsCSys;
   Vector<Int> itsAbsRel;
   Bool itsNull;


// Check units of quanta are consistent with CoordinateSystem
   void checkUnits (const IPosition& pixelAxes,
                    const Vector<Quantum<Double> >& values,
                    const CoordinateSystem& cSys);

// Convert relative pixels to absolute or fill in defaults
   void convertPixel(Double& pixel,
                     const Quantum<Double>& value,
                     const Int absRel,
                     const Double refPix,
                     const Int shape,
                     const Bool isBlc) const;

};



} //# NAMESPACE CASA - END

#endif