ImageProperties.h

Go to the documentation of this file.

//# ImageProperties.qo.h: an object that collects data-range and other info about a casa image
//# Copyright (C) 2012
//# 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 DISPLAY_IMAGEINFO_H_
#define DISPLAY_IMAGEINFO_H_
#include <string>
#include <casa/Arrays/Vector.h>
#include <display/Display/DisplayCoordinateSystem.h>
#include <images/Images/ImageInterface.h>

namespace casa {

    class GaussianBeam;

        namespace viewer {

                // This class provides a priori image information derived from the image itself. It was
                // created to standardize the access to image properties, since this information is needed
                // in a variety of places and is currently found in a variety of manners. The idea was that
                // it would provide easy, standardized (e.g. velocity provided in km/s) access. There are still
                // likely issues to iron out with expericence from new images.
                //
                // It may be desirable to have 2nd order image information, e.g. which axes map to the x, y
                // and z viewer display axes (or perhaps not), but if so, this information should be provided
                // by a derived class.
                //
                class ImageProperties {

                public:
                        ImageProperties( );
                        ImageProperties( const std::string &/*path*/ );
                        ImageProperties( SHARED_PTR<ImageInterface<Float> > );
                        ImageProperties( SHARED_PTR<ImageInterface<std::complex<float> > > );   /**** throws exception ****/
                        const ImageProperties &operator=( const std::string & );

                        bool hasDirectionAxis( ) const {
                                return has_direction_axis;
                        }
                        const std::string &directionType( ) const {
                                return direction_type;
                        }
                        bool hasSpectralAxis( ) const {
                                return has_spectral_axis;
                        }
                        const Vector<Int> &shape( ) const {
                                return shape_;
                        }
                        Vector<double> raRange( ) const {
                                return ra_range;
                        }
                        std::vector<std::string> raRangeAsStr( ) const {
                                return ra_range_str;
                        }
                        Vector<double> decRange( ) const {
                                return dec_range;
                        }
                        std::vector<std::string> decRangeAsStr( ) const {
                                return dec_range_str;
                        }
                        size_t nBeams( ) const {
                                return restoring_beams.size( );
                        }
                        std::vector<std::vector<double> > restoringBeams( ) const;
                        std::vector<double> restoringBeam( size_t channel ) const {
                                return beam_as_vector(channel < restoring_beams.size( ) ? restoring_beams[channel] : restoring_beams[0]);
                        }
                        std::vector<std::string> restoringBeamAsStr( size_t channel ) const {
                                return beam_as_string_vector(channel < restoring_beams.size( ) ? restoring_beams[channel] : restoring_beams[0]);
                        }
                        std::vector<double> medianRestoringBeam( ) const;
                        std::vector<std::string> medianRestoringBeamAsStr( ) const;
                        Vector<double> freqRange( const std::string &units="" ) const;
                        const std::string &frequencyUnits( ) const {
                                return freq_units;
                        }

                        const std::string &velocityUnits( ) const {
                                return velo_units;
                        }
                        const std::string &path( ) const {
                                return path_;
                        }

                        const DisplayCoordinateSystem &cs( ) const { return cs_; }

                        bool ok( ) const {
                                return status_ok;
                        }

                        // export required DisplayCoordinateSystem functions instead of returning a DisplayCoordinateSystem reference...
                        int spectralAxisNumber() const {
                                return cs_.spectralAxisNumber( );
                        }

            const std::vector<double> &frequencies( ) const { return frequencies_; }
            const std::vector<double> &velocities( ) const { return velocities_; }

                private:
                        std::vector<double> beam_as_vector( const GaussianBeam &beam ) const;
                        std::vector<std::string> beam_as_string_vector( const GaussianBeam &beam ) const;
                        void clear_state( );
                        void initialize_state( SHARED_PTR<ImageInterface<Float> > image );
                        void reset( SHARED_PTR<ImageInterface<Float> > image );
                        void reset( const std::string &path="" );
                        bool status_ok;
                        std::string path_;
                        Vector<Int> shape_;
                        bool has_direction_axis;
                        std::string direction_type;
                        bool has_spectral_axis;
            std::vector<double> frequencies_;
            std::vector<double> velocities_;
                        std::string freq_units;
                        std::string velo_units;
                        Vector<double> ra_range;
                        std::vector<std::string> ra_range_str;
                        Vector<double> dec_range;
                        std::vector<std::string> dec_range_str;
                        std::vector<GaussianBeam> restoring_beams;
                        DisplayCoordinateSystem cs_;
                };
        }
}

std::ostream &operator<<( std::ostream &os, const casa::DisplayCoordinateSystem &cs );

std::ostream &operator<<( std::ostream &os, const casa::DisplayCoordinateSystem &cs );
namespace casa {
        namespace viewer {
                inline std::ostream &operator<<( std::ostream &os, const casa::DisplayCoordinateSystem &cs ) { return ::operator<<(os,cs); }
        }
}

#endif