ProfileTaskMonitor.h

Go to the documentation of this file.

//# Copyright (C) 2005
//# 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
//#
#ifndef PROFILETASKMONITOR_H_
#define PROFILETASKMONITOR_H_

#include <QString>
#include <casa/BasicSL/String.h>
#include <casa/Arrays/Vector.h>
#include <coordinates/Coordinates/SpectralCoordinate.h>
#include <measures/Measures/MFrequency.h>

namespace casacore{

        template <class T> class ImageInterface;
}

namespace casa {


        class ProfileTaskMonitor {
        public:
                ProfileTaskMonitor();

                enum PURPOSE {
                    SPECTROSCOPY,
                    MOMENTS_COLLAPSE
                };
                virtual QString getFileName() const = 0;
                virtual QString getImagePath() const =0;
                virtual bool getBeamInfo( const QString& curveName, casacore::Double& beamAngle, casacore::Double& beamArea ) const = 0;
                virtual casacore::SpectralCoordinate getSpectralCoordinate(std::shared_ptr<const casacore::ImageInterface<casacore::Float> > imagePtr, casacore::Bool& validCoord ) = 0;
                virtual casacore::Vector<casacore::Float> getXValues() const = 0;
                virtual casacore::Vector<casacore::Float> getYValues() const = 0;
                virtual casacore::Vector<casacore::Float>getZValues() const = 0;
                virtual casacore::Vector<casacore::Double> getRegionXValues() const = 0;
                virtual casacore::Vector<casacore::Double> getRegionYValues() const = 0;
                virtual QString getYUnit() const = 0;
                virtual QString getYUnitPrefix() const = 0;
                virtual casacore::String getXAxisUnit() const = 0;
                virtual casacore::String getRegionShape() const = 0;
                virtual void postStatus( casacore::String str ) = 0;
                virtual void plotMainCurve() = 0;
                virtual std::shared_ptr<const casacore::ImageInterface<casacore::Float> > getImage( const QString& imageName = "") const = 0;
                virtual void getPixelBounds( casacore::Vector<double>& xPixels, casacore::Vector<double>& yPixels) const = 0;
                virtual casacore::MFrequency::Types getReferenceFrame() const = 0;
                //Specific to Moments
                virtual void persist( const QString& key, const QString& value ) = 0;
                virtual QString read( const QString & key ) const = 0;
                virtual void imageCollapsed(casacore::String path, casacore::String dataType, casacore::String displayType,
                                casacore::Bool autoRegister, casacore::Bool tmpData,
                                std::shared_ptr<casacore::ImageInterface<casacore::Float> > img = std::shared_ptr<casacore::ImageInterface<casacore::Float> >())=0;
                virtual void setPurpose( ProfileTaskMonitor::PURPOSE purpose ) = 0;

                //Specific to Spectrum Position setting.
                virtual void setPosition( const QList<double> &world_x, const QList<double> &world_y ) =0;


                virtual ~ProfileTaskMonitor();
        };

} // end namespace casa

#endif /* PROFILETASKMONITOR_H_ */