Jürgen Knödlseder / gammalib

/***************************************************************************
 *             GXXXEventList.cpp - [INSTRUMENT] event list class           *
 * ----------------------------------------------------------------------- *
 *  copyright (C) [YEAR] by [AUTHOR]                                       *
 * ----------------------------------------------------------------------- *
 *                                                                         *
 *  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 3 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, see <http://www.gnu.org/licenses/>.  *
 *                                                                         *
 ***************************************************************************/
/**
 * @file GXXXEventList.hpp
 * @brief [INSTRUMENT] event list class implementation
 * @author [AUTHOR]
 */

/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <typeinfo>
#include "GFits.hpp"
#include "GException.hpp"
#include "GXXXEventList.hpp"

/* __ Method name definitions ____________________________________________ */
#define G_OPERATOR                          "GXXXEventList::operator[](int&)"
#define G_ROI                                     "GXXXEventList::roi(GRoi&)"

/* __ Macros _____________________________________________________________ */

/* __ Coding definitions _________________________________________________ */

/* __ Debug definitions __________________________________________________ */


/*==========================================================================
 =                                                                         =
 =                         Constructors/destructors                        =
 =                                                                         =
 ==========================================================================*/

/***********************************************************************//**
 * @brief Void constructor
 *
 * Creates an empty [INSTRUMENT] event list.
 ***************************************************************************/
GXXXEventList::GXXXEventList(void) : GEventList()
{
    // Initialise class members for clean destruction
    init_members();

    // Return
    return;
}


/***********************************************************************//**
 * @brief File name constructor
 *
 * @param[in] filename [INSTRUMENT] event list filename.
 *
 * Construct [INSTRUMENT] event list object by loading the events from a
 * FITS file.
 ***************************************************************************/
GXXXEventList::GXXXEventList(const GFilename& filename) : GEventList()
{
    // Initialise members
    init_members();

    // Load event list
    load(filename);

    // Return
    return;
}


/***********************************************************************//**
 * @brief Copy constructor
 *
 * @param[in] list [INSTRUMENT] event list.
 ***************************************************************************/
GXXXEventList::GXXXEventList(const GXXXEventList& list) : GEventList(list)
{
    // Initialise members
    init_members();

    // Copy members
    copy_members(list);

    // Return
    return;
}


/***********************************************************************//**
 * @brief Destructor
 ***************************************************************************/
GXXXEventList::~GXXXEventList(void)
{
    // Free members
    free_members();

    // Return
    return;
}


/*==========================================================================
 =                                                                         =
 =                               Operators                                 =
 =                                                                         =
 ==========================================================================*/

/***********************************************************************//**
 * @brief Assignment operator
 *
 * @param[in] list [INSTRUMENT] event list.
 * @return [INSTRUMENT] event list.
 ***************************************************************************/
GXXXEventList& GXXXEventList::operator=(const GXXXEventList& list)
{
    // Execute only if object is not identical
    if (this != &list) {

        // Copy base class members
        this->GEventList::operator=(list);

        // Free members
        free_members();

        // Initialise members
        init_members();

        // Copy members
        copy_members(list);

    } // endif: object was not identical

    // Return this object
    return *this;
}


/***********************************************************************//**
 * @brief [INSTRUMENT] event atom access operator
 *
 * @param[in] index Event index [0,...,size()-1].
 * @return Pointer to [INSTRUMENT] event atom.
 *
 * @exception GException::out_of_range
 *            Event index outside valid range.
 *
 * Returns pointer to a [INSTRUMENT] event atom.
 ***************************************************************************/
GXXXEventAtom* GXXXEventList::operator[](const int& index)
{
    // Optionally check if the index is valid
    #if defined(G_RANGE_CHECK)
    if (index < 0 || index >= size()) {
        throw GException::out_of_range(G_OPERATOR, "Event index", index, size());
    }
    #endif

    // Return pointer
    return (&(m_events[index]));
}


/***********************************************************************//**
 * @brief [INSTRUMENT] event atom access operator
 *
 * @param[in] index Event index [0,...,size()-1].
 * @return Pointer to [INSTRUMENT] event atom.
 *
 * @exception GException::out_of_range
 *            Event index outside valid range.
 *
 * Returns pointer to a [INSTRUMENT] event atom.
 ***************************************************************************/
const GXXXEventAtom* GXXXEventList::operator[](const int& index) const
{
    // Optionally check if the index is valid
    #if defined(G_RANGE_CHECK)
    if (index < 0 || index >= size()) {
        throw GException::out_of_range(G_OPERATOR, "Event index", index, size());
    }
    #endif

    // Return pointer
    return (&(m_events[index]));
}


/*==========================================================================
 =                                                                         =
 =                             Public methods                              =
 =                                                                         =
 ==========================================================================*/

/***********************************************************************//**
 * @brief Clear [INSTRUMENT] event list
 *
 * Clears [INSTRUMENT] event list by resetting all class members to an
 * initial state. Any information that was present before will be lost.
 ***************************************************************************/
void GXXXEventList::clear(void)
{
    // Free class members (base and derived classes, derived class first)
    free_members();
    this->GEventList::free_members();
    this->GEvents::free_members();

    // Initialise members
    this->GEvents::init_members();
    this->GEventList::init_members();
    init_members();

    // Return
    return;
}


/***********************************************************************//**
 * @brief Clone event list
 *
 * @return Pointer to deep copy of [INSTRUMENT] event list.
 ***************************************************************************/
GXXXEventList* GXXXEventList::clone(void) const
{
    return new GXXXEventList(*this);
}


/***********************************************************************//**
 * @brief Load [INSTRUMENT] events from FITS file
 *
 * @param[in] filename [INSTRUMENT] event list FITS file name.
 *
 * Loads [INSTRUMENT] events from a FITS file into the event list.
 ***************************************************************************/
void GXXXEventList::load(const GFilename& filename)
{
    // Open FITS file
    GFits fits(filename);

    // Read event list from FITS file
    read(fits);

    // Close FITS file
    fits.close();

    // Return
    return;
}


/***********************************************************************//**
 * @brief Save [INSTRUMENT] events
 *
 * @param[in] filename [INSTRUMENT] event list FITS file name.
 * @param[in] clobber Overwrite existing FITS file?
 *
 * Save [INSTRUMENT] events from a FITS file into the event list.
 ***************************************************************************/
void GXXXEventList::save(const GFilename& filename,
                         const bool&      clobber) const
{
    // Open FITS file
    GFits fits;

    // Write events
    write(fits);

    // Save events
    fits.saveto(filename, clobber);

    // Close FITS file
    fits.close();

    // Return
    return;
}


/***********************************************************************//**
 * @brief Read [INSTRUMENT] events from FITS file.
 *
 * @param[in] file FITS file.
 *
 * Read the [INSTRUMENT] event list from a FITS file object.
 *
 * @todo Implement method.
 ***************************************************************************/
void GXXXEventList::read(const GFits& file)
{
    // Clear object
    clear();

    // TODO: You need to implement an interface to the FITS file that stores
    // your events. Make sure that you read all relevant information.

    // Return
    return;
}


/***********************************************************************//**
 * @brief Write [INSTRUMENT] event list into FITS file.
 *
 * @param[in] file FITS file.
 *
 * Write the L[INSTRUMENT]AT event list into FITS file.
 *
 * @todo Implement method.
 ***************************************************************************/
void GXXXEventList::write(GFits& file) const
{
    // TODO: You need to implement an interface to the FITS file that so
    // that you can save your events.

    // Return
    return;
}


/***********************************************************************//**
 * @brief Set region of interest
 *
 * @param[in] roi Region of interest.
 *
 * @exception GException::invalid_argument
 *            Specified RoI is not a [INSTRUMENT] RoI.
 *
 * Sets the region of interest for the observation.
 ***************************************************************************/
void GXXXEventList::roi(const GRoi& roi)
{
    // Get pointer on [INSTRUMENT] region of interest
    const GXXXRoi* xxxroi = dynamic_cast<const GXXXRoi*>(&roi);
    if (xxxroi == NULL) {
        std::string cls = std::string(typeid(&roi).name());
        std::string msg = "Region of interest of type \""+cls+"\" is "
                          "not a [INSTRUMENT] RoI. Please specify a "
                          "[INSTRUMENT] RoI as argument.";
        throw GException::invalid_argument(G_ROI, msg);
    }

    // Set RoI
    m_roi = *xxxroi;

    // Return
    return;
}


/***********************************************************************//**
 * @brief Append event to event list
 *
 * @param[in] event Event.
 *
 * Appends an event to the end of the event list.
 ***************************************************************************/
void GXXXEventList::append(const GXXXEventAtom& event)
{
    // Append event
    m_events.push_back(event);

    // Return
    return;
}


/***********************************************************************//**
 * @brief Remove events from event list
 *
 * @param[in] index Index from which on events should be removed.
 * @param[in] number Number of event to remove (default: 1).
 *
 * Removes events from the event list. This method does nothing if @p index
 * points beyond the event list. The method does also gently accept
 * @p number arguments where @p index + @p number reach beyond the event
 * list. In that case, all events from event @p index on will be removed.
 ***************************************************************************/
void GXXXEventList::remove(const int& index, const int& number)
{
    // Continue only if index is valid
    if (index < size()) {

        // Determine number of elements to remove
        int n_remove = (index + number > size()) ? size() - index : number;

        // Remove events
        m_events.erase(m_events.begin() + index,
                       m_events.begin() + index + n_remove);

    } // endif: index was valid

    // Return
    return;
}


/***********************************************************************//**
 * @brief Print [INSTRUMENT] event list information
 *
 * @param[in] chatter Chattiness.
 * @return String containing [INSTRUMENT] event list information.
 ***************************************************************************/
std::string GXXXEventList::print(const GChatter& chatter) const
{
    // Initialise result string
    std::string result;

    // Continue only if chatter is not silent
    if (chatter != SILENT) {

        // Append header
        result.append("=== GXXXEventList ===");

        // Append information
        result.append("\n"+gammalib::parformat("Number of events") +
                      gammalib::str(number()));

        // Append additional information
        // TODO: Add code to append any additional information that might
        // be relevant.

    } // endif: chatter was not silent

    // Return result
    return result;
}


/*==========================================================================
 =                                                                         =
 =                            Private methods                              =
 =                                                                         =
 ==========================================================================*/

/***********************************************************************//**
 * @brief Initialise class members
 ***************************************************************************/
void GXXXEventList::init_members(void)
{
    // Initialise members
    m_roi.clear();
    m_events.clear();

    // Return
    return;
}


/***********************************************************************//**
 * @brief Copy class members
 *
 * @param[in] list [INSTRUMENT] event list.
 ***************************************************************************/
void GXXXEventList::copy_members(const GXXXEventList& list)
{
    // Copy members
    m_roi    = list.m_roi;
    m_events = list.m_events;

    // Return
    return;
}


/***********************************************************************//**
 * @brief Delete class members
 ***************************************************************************/
void GXXXEventList::free_members(void)
{
    // Return
    return;
}