ImageRegridder.h

Go to the documentation of this file.

//# Copyright (C) 1998,1999,2000,2001,2003
//# 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
//#

#ifndef IMAGEANALYSIS_IMAGEREGRIDDER_H
#define IMAGEANALYSIS_IMAGEREGRIDDER_H

#include <imageanalysis/ImageAnalysis/ImageRegridderBase.h>

#include <casa/namespace.h>

namespace casacore{

template <class T> class SubImage;
template <class T> class TempImage;
}

namespace casa {


template<class T> class ImageRegridder : public ImageRegridderBase<T> {
        // <summary>
        // Top level interface which regrids an image to a specified coordinate
    // system
        // </summary>

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

        // <prerequisite>
        // </prerequisite>

        // <etymology>
        // Regrids image.
        // </etymology>

        // <synopsis>
        // High level interface for regridding an image. Note that in the case of a
    // complex-valued image, the image is first divided into its composite real
    // and imaginary parts, and these parts are regridded independently. The
    // resulting regridded images are combined to form the final regridded
    // complex-valued image.
        // </synopsis>

public:

        ImageRegridder() = delete;

        // if <src>outname</src> is empty, no image will be written
        // if <src>overwrite</src> is true, if image already exists it will be
        // removed if <src>overwrite</src> is false, if image already exists
        // exception will be thrown
        // <group>

        ImageRegridder(
                const SPCIIT image, const casacore::Record *const regionRec,
                const casacore::String& maskInp, const casacore::String& outname,
                casacore::Bool overwrite, const casacore::CoordinateSystem& csysTo,
                const casacore::IPosition& axes, const casacore::IPosition& shape
        );

        // FIXME Add support to allow image and templateIm to be of different data
        // types
        ImageRegridder(
                const SPCIIT image, const casacore::String& outname,
                const SPCIIT templateIm,
                const casacore::IPosition& axes=casacore::IPosition(),
                const casacore::Record *const regionRec=0,
                const casacore::String& maskInp="", casacore::Bool overwrite=false,
                const casacore::IPosition& shape=casacore::IPosition()
        );
        // </group>

        // destructor
        ~ImageRegridder();

        // perform the regrid.
        SPIIT regrid() const;

        inline casacore::String getClass() const { return _class; }

        void setDebug(casacore::Int debug) { _debug = debug; }

private:
        mutable SPIIT _subimage;
        casacore::Int _debug;
        static const casacore::String _class;

        SPIIT _regrid() const;

        SPIIT _regridByVelocity() const;

        casacore::Bool _doImagesOverlap(SPCIIT image0, SPCIIT image1) const;

        static casacore::Vector<std::pair<casacore::Double, casacore::Double> >
        _getDirectionCorners(
                const casacore::DirectionCoordinate& dc,
                const casacore::IPosition& directionShape
        );

        void _checkOutputShape(
                const casacore::SubImage<T>& subImage,
                const std::set<casacore::Coordinate::Type>& coordsToRegrid
        ) const;

        SPIIT _decimateStokes(SPIIT workIm) const;

        static casacore::Bool _doRectanglesIntersect(
                const casacore::Vector<
                    std::pair<casacore::Double, casacore::Double>
            >& corners0,
                const casacore::Vector<
                    std::pair<casacore::Double, casacore::Double>
            >& corners1
        );

};
}

#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <imageanalysis/ImageAnalysis/ImageRegridder.tcc>
#endif

#endif