ImageTask.h

Go to the documentation of this file.

//# tSubImage.cc: Test program for class SubImage
//# 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
//#
//# $Id: tSubImage.cc 20567 2009-04-09 23:12:39Z gervandiepen $

#ifndef IMAGEANALYSIS_IMAGETASK_H
#define IMAGEANALYSIS_IMAGETASK_H

#include <imageanalysis/ImageAnalysis/ImageInputProcessor.h>

#include <casa/IO/FiledesIO.h>

#include <memory>

#include <casa/namespace.h>

namespace casa {

class ImageTask {
    // <summary>
    // Virtual base class for image tasking.
    // </summary>

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

    // <prerequisite>
    // </prerequisite>

    // <etymology>
    // Image tasking
    // </etymology>

    // <synopsis>
    // Virtual base class for image tasking.
    // </synopsis>

public:

        // verbosity levels
        enum Verbosity {
                QUIET,
                WHISPER,
                LOW,
                NORMAL,
                HIGH,
                NOISY,
                DEAFENING
        };

    virtual ~ImageTask();

    virtual String getClass() const = 0;

    inline void setStretch(const Bool stretch) { _stretch = stretch;}

    void setLogfile(const String& lf);

    void setLogfileAppend(const Bool a);

    void setRegion(const Record& region);

    void setMask(const String& mask) { _mask = mask; }

    void setVerbosity(Verbosity verbosity) { _verbosity = verbosity; }

protected:

        // 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

        ImageTask(
                const ImageInterface<Float> *const &image,
        const String& region, const Record *const &regionPtr,
        const String& box, const String& chanInp,
        const String& stokes, const String& maskInp,
        const String& outname, const Bool overwrite
    );

        virtual CasacRegionManager::StokesControl _getStokesControl() const = 0;

    virtual vector<ImageInputProcessor::OutputStruct> _getOutputStruct();

    // does the lion's share of constructing the object, ie checks validity of
    // inputs, etc.

    virtual void _construct(Bool verbose=True);

    inline const ImageInterface<Float>* _getImage() const {return _image;}

    inline const String& _getMask() const {return _mask;}

    inline const Record* _getRegion() const {return &_regionRecord;}

    inline void _setStokes(const String& stokes) { _stokesString = stokes; }

    inline const String& _getStokes() const {return _stokesString;}

    inline const String& _getChans() const {return _chan;}

    inline const String& _getOutname() const {return _outname; }

    // Represents the minimum set of coordinates necessary for the
    // task to function.
    virtual vector<Coordinate::Type> _getNecessaryCoordinates() const = 0;

    void _removeExistingOutfileIfNecessary() const;

    static void _removeExistingFileIfNecessary(
        const String& filename, const Bool overwrite
    );

    String _summaryHeader() const;

    inline const std::auto_ptr<LogIO>& _getLog() const {return _log;}

    inline void _setSupportsLogfile(const Bool b) { _logfileSupport=b;}

    Bool _hasLogfileSupport() const {return _logfileSupport;}

    inline Bool _getStretch() const {return _stretch;}

    const String& _getLogfile() const;

    Bool _writeLogfile(
        const String& output, const Bool open=True,
        const Bool close=True
    );

    Bool _openLogfile();

    void _closeLogfile() const;

    virtual inline Bool _supportsMultipleRegions() {return False;}

    // Create a TempImage or PagedImage depending if _outname is empty or not. Generally meant
    // for the image to be returned to the UI or the final image product that the user will want.
    // values=0 => the pixel values from the subimage will be used
    // mask=0 => the mask attached to the subimage, if any will be used, outShape=0 => use subImage shape, coordsys=0 => use subImage coordinate
    // system
    std::auto_ptr<ImageInterface<Float> > _prepareOutputImage(
        const ImageInterface<Float> *const subImage, const Array<Float> *const values=0,
        const ArrayLattice<Bool> *const mask=0,
        const IPosition *const outShape=0, const CoordinateSystem *const coordsys=0
    ) const;

    Verbosity _getVerbosity() const { return _verbosity; }

private:
    const ImageInterface<Float> *const _image;
    std::auto_ptr<LogIO> _log;
    const Record *const _regionPtr;
    Record _regionRecord;
    String _region, _box, _chan, _stokesString, _mask, _outname, _logfile;
    Bool _overwrite, _stretch, _logfileSupport, _logfileAppend;
    Int _logFD;
        std::auto_ptr<FiledesIO> _logFileIO;
        Verbosity _verbosity;




};
}

#endif