casacore-dev 2.2.0-2 / usr / include / casacore / images / Regions / WCDifference.h

//# WCDifference.h: Make the difference of 2 image regions
//# Copyright (C) 1998
//# 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$

#ifndef IMAGES_WCDIFFERENCE_H
#define IMAGES_WCDIFFERENCE_H

//# Includes
#include <casacore/casa/aips.h>
#include <casacore/images/Regions/WCCompound.h>


namespace casacore { //# NAMESPACE CASACORE - BEGIN

// <summary>
// Make the difference of 2 image regions.
// </summary>

// <use visibility=export>

// <reviewed reviewer="" date="" tests="">
// </reviewed>

// <prerequisite>
//   <li> <linkto class=WCCompound>WCCompound</linkto>
// </prerequisite>

// <synopsis> 
// The WCDifference class is a specialization of class
// <linkto class=WCCompound>WCCompound</linkto>.
// It makes it possible to take the difference of 2 regions.
// Note that only world coordinate regions can be used in a compound,
// thus an LCSlicer object is not allowed in a difference.
// <p>
// The difference consists of all pixels masked-on in the first
// region and not masked-on in the second region.
// <p>
// The regions in a difference can have different axes and dimensionalities.
// The axes and dimensionality of a difference are determined by the
// collection of all different axes in its regions. Each individual region
// will be auto-extended along the axes not being part of the region.
// E.g. one can define a WCBox with axis RA and another WCBox with
// axis DEC. The difference will be 2-dim with axes RA and DEC. The first
// box will be auto-extended to cover the DEC axis, which results
// in a 2-dim box with its DEC axis the length of the image's DEC axis.
// Similarly the second box will be auto-extended to cover the RA axis.
// </synopsis> 

// <example>
// <srcblock>
// </srcblock>
// </example>

//# <todo asof="1997/11/11">
//# <li>
//# </todo>


class WCDifference: public WCCompound
{
public:
    // Construct the difference of one or more image regions.
    // The image regions have to contain WCRegion objects, otherwise an
    // exception is thrown.
    // <group>
    WCDifference (const ImageRegion& region1, const ImageRegion& region2);
    WCDifference (const PtrBlock<const ImageRegion*>& regions);
    // </group>

    // Construct from multiple regions given as a Block.
    // When <src>takeOver</src> is True, the destructor will delete the
    // given regions. Otherwise a copy of the regions is made.
    WCDifference (Bool takeOver, const PtrBlock<const WCRegion*>& regions);

    // Copy constructor (copy semantics).
    WCDifference (const WCDifference& other);

    virtual ~WCDifference();

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

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

    // Make a copy of the derived object.
    virtual WCRegion* cloneRegion() const;

    // Get the class name (to store in the record).
    static String className();

    // Get the region type.  Returns className()
    virtual String type() const;

    // Convert the (derived) object to a record.
    virtual TableRecord toRecord (const String& tableName) const;

    // Convert correct object from a record.
    static WCDifference* fromRecord (const TableRecord&,
				     const String& tableName);

protected:
    // Convert to an LCRegion using the given coordinate system and shape.
    // pixelAxesMap(i) gives the pixel axis in cSys of axes <src>i</src>
    // in the axesDesc.
    virtual LCRegion* doToLCRegion (const CoordinateSystem& cSys,
				    const IPosition& shape,
				    const IPosition& pixelAxesMap,
				    const IPosition& outOrder) const;
};



} //# NAMESPACE CASACORE - END

#endif