modal_expansion.h

Go to the documentation of this file.

/*
Arroyo - software for the simulation of electromagnetic wave propagation
through turbulence and optics.

Copyright (c) 2000-2004 California Institute of Technology.  Written by
Dr. Matthew Britton.  For comments or questions about this software,
please contact the author at mbritton@astro.caltech.edu.

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 provided "as is" and 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.  In no
event shall California Institute of Technology be liable to any party
for direct, indirect, special, incidental or consequential damages,
including lost profits, arising out of the use of this software and its
documentation, even if the California Institute of Technology has been
advised of the possibility of such damage.   The California Institute of
Technology has no obligation to provide maintenance, support, updates,
enhancements or modifications.  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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
*/

#ifndef MODAL_EXPANSION_H
#define MODAL_EXPANSION_H

#include <vector>
#include <iostream>
#include "AO_sim_base.h"

namespace Arroyo {
  class iofits;
  template <typename T> class pixel_array;
}

namespace Arroyo {

  class aperture;


  class modal_expansion {

  public:

    modal_expansion(){};

    virtual ~modal_expansion(){};

    virtual void read(const char * filename) = 0;

    virtual void read(const Arroyo::iofits & iof) = 0;

    virtual void write(const char * filename) const = 0;

    virtual void write(Arroyo::iofits & iof) const = 0;

    virtual void print(std::ostream & os, const char * prefix = "") const = 0;

    virtual Arroyo::pixel_array<double> get_pixel_array(const std::vector<long> & axes, 
                                                        double pixscale,
                                                        const aperture & ap) const = 0;
    
    static modal_expansion * modal_expansion_factory(const char * filename);

    static modal_expansion * modal_expansion_factory(const Arroyo::iofits & iof);

    static int verbose_level;

  };

}

#endif

---