GCOSObservation.cpp

Go to the documentation of this file.

/***************************************************************************
 *               GCOSObservation.cpp - COSI observation class              *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2026 by Juergen Knoedlseder                              *
 * ----------------------------------------------------------------------- *
 *                                                                         *
 *  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 GCOSObservation.cpp
 * @brief COSI observation class implementation
 * @author Juergen Knoedlseder
 */
 
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <typeinfo> 
#include "GException.hpp"
#include "GObservationRegistry.hpp"
#include "GCOSObservation.hpp"
 
/* __ Globals ____________________________________________________________ */
const GCOSObservation      g_obs_cos_seed;
const GObservationRegistry g_obs_cos_registry(&g_obs_cos_seed);
 
/* __ Method name definitions ____________________________________________ */
#define G_RESPONSE                    "GCOSObservation::response(GResponse&)"
#define G_READ                          "GCOSObservation::read(GXmlElement&)"
#define G_WRITE                        "GCOSObservation::write(GXmlElement&)"
#define G_LOAD  "GCOSObservation::load(std::vector<GFilename>&, GFilename&, "\
                                                                "GFilename&)"
 
/* __ Macros _____________________________________________________________ */
 
/* __ Coding definitions _________________________________________________ */
 
/* __ Debug definitions __________________________________________________ */
 
 
/*==========================================================================
 =                                                                         =
 =                        Constructors/destructors                         =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Void constructor
 *
 * Creates an empty COSI observation.
 ***************************************************************************/
GCOSObservation::GCOSObservation(void) : GObservation()
{
    // Initialise members
    init_members();
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief XML constructor
 *
 * @param[in] xml XML element.
 *
 * Constructs a COSI observation from the information that is found in an
 * XML element. See the read() method for more information.
 ***************************************************************************/
GCOSObservation::GCOSObservation(const GXmlElement& xml) : GObservation()
{
    // Initialise members
    init_members();
 
    // Read XML
    read(xml);
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Load constructor
 *
 * @param[in] eventname Event list FITS file name.
 * @param[in] spacename Space craft file name.
 * @param[in] rspname Response file name.
 *
 * Creates an unbinned COSI observation by loading an event list, a space
 * craft file and a response file.
 ***************************************************************************/
GCOSObservation::GCOSObservation(const GFilename& eventname,
                                 const GFilename& spacename,
                                 const GFilename& rspname) : GObservation()
{
    // Initialise members
    init_members();
 
    // Load observation
    load(eventname, spacename, rspname);
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Load constructor
 *
 * @param[in] eventnames Vector of event list FITS file names.
 * @param[in] spacename Space craft file name.
 * @param[in] rspname Response file name.
 *
 * Creates an unbinned COSI observation by loading event lists, a space
 * craft file and a response file. Multiple event lists are appended to
 * each other and events are sorted by increasing time.
 ***************************************************************************/
GCOSObservation::GCOSObservation(const std::vector<GFilename>& eventnames,
                                 const GFilename&              spacename,
                                 const GFilename&              rspname) : GObservation()
{
    // Initialise members
    init_members();
 
    // Load observation
    load(eventnames, spacename, rspname);
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Copy constructor
 *
 * @param[in] obs COSI observation.
 *
 * Creates COSI observation by copying from an existing COSI
 * observation.
 ***************************************************************************/
GCOSObservation::GCOSObservation(const GCOSObservation& obs) : GObservation(obs)
{
    // Initialise members
    init_members();
 
    // Copy members
    copy_members(obs);
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Destructor
 ***************************************************************************/
GCOSObservation::~GCOSObservation(void)
{
    // Free members
    free_members();
 
    // Return
    return;
}
 
 
/*==========================================================================
 =                                                                         =
 =                               Operators                                 =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Assignment operator
 *
 * @param[in] obs COSI observation.
 * @return COSI observation.
 *
 * Assign COSI observation to this object. The assignment performs
 * a deep copy of all information, hence the original object from which the
 * assignment was made can be destroyed after this operation without any loss
 * of information.
 ***************************************************************************/
GCOSObservation& GCOSObservation::operator=(const GCOSObservation& obs)
{
    // Execute only if object is not identical
    if (this != &obs) {
 
        // Copy base class members
        this->GObservation::operator=(obs);
 
        // Free members
        free_members();
 
        // Initialise members
        init_members();
 
        // Copy members
        copy_members(obs);
 
    } // endif: object was not identical
 
    // Return this object
    return *this;
}
 
 
/*==========================================================================
 =                                                                         =
 =                              Public methods                             =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Clear COSI observation
 *
 * Clears COSI observation by resetting all class members to an
 * initial state. Any information that was present before will be lost.
 ***************************************************************************/
void GCOSObservation::clear(void)
{
    // Free members
    free_members();
    this->GObservation::free_members();
 
    // Initialise members
    this->GObservation::init_members();
    init_members();
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Clone COSI observation
 *
 * @return Pointer to deep copy of COSI observation.
 ***************************************************************************/
GCOSObservation* GCOSObservation::clone(void) const
{
    return new GCOSObservation(*this);
}
 
 
/***********************************************************************//**
 * @brief Set COSI response function
 *
 * @param[in] rsp COSI response function.
 *
 * @exception GException::invalid_argument
 *            Specified response is not a COSI response.
 *
 * Sets the response function for the observation.
 ***************************************************************************/
void GCOSObservation::response(const GResponse& rsp)
{
    // Get pointer on COSI response
    const GCOSResponse* cosrsp = dynamic_cast<const GCOSResponse*>(&rsp);
    if (cosrsp == NULL) {
        std::string cls = std::string(typeid(&rsp).name());
        std::string msg = "Response of type \""+cls+"\" is "
                          "not a COSI response. Please specify a "
                          "COSI response as argument.";
        throw GException::invalid_argument(G_RESPONSE, msg);
    }
 
    // Clone response function
    m_response = *cosrsp;
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Read COSI observation from XML element
 *
 * @param[in] xml XML element.
 *
 * Reads information for a COSI observation from an XML element. The
 * method supports both an unbinned and a binned observation.
 *
 * For an unbinned observation the XML format is
 *
 *     <observation name="Crab" id="00001" instrument="COS">
 *       <parameter name="EventList"      file="cosi_event_list.fits"/>
 *       <parameter name="SpaceCraftFile" file="cosi_orientation.ori"/>
 *       <parameter name="Response"       file="cosi_response.h5"/>
 *     </observation>
 *
 * The method supports the presence of multiple "EventList" entries which
 * will load all specified event lists and merge them into a single event
 * list. The events will be ordered by increasing time.
 *
 * For a binned observation the XML format is
 *
 *     <observation name="Crab" id="00001" instrument="COS">
 *     </observation>
 *
 ***************************************************************************/
void GCOSObservation::read(const GXmlElement& xml)
{
    // Clear observation
    clear();
 
    // If the XML elements has an "EventList" attribute we have an unbinned
    // observation
    if (gammalib::xml_has_par(xml, "EventList")) {
 
        // Get event list file names
        std::vector<GFilename> eventnames;
        for (int i = 0; i < xml.elements("parameter"); ++i) {
            const GXmlElement* element = xml.element("parameter", i);
            if (element->attribute("name") == "EventList") {
                std::string eventname = element->attribute("file");
                eventname             = gammalib::xml_file_expand(xml, eventname);
                eventnames.push_back(GFilename(eventname));
           }
        }
 
        // Get space craft and response file names
        std::string spacename = gammalib::xml_get_attr(G_READ, xml, "SpaceCraftFile", "file");
        std::string rspname   = gammalib::xml_get_attr(G_READ, xml, "Response", "file");
 
        // Expand names
        spacename = gammalib::xml_file_expand(xml, spacename);
        rspname   = gammalib::xml_file_expand(xml, rspname);
 
        // Load observation
        load(eventnames, spacename, rspname);
 
    } // endif: unbinned observation
 
    // ... otherwise we have a binned observation
    else {
 
    } // endelse: binned observation
 
    // Extract attributes
    m_name       = xml.attribute("name");
    m_id         = xml.attribute("id");
    m_instrument = xml.attribute("instrument");
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Write COSI observation into XML element
 *
 * @param[in] xml XML element.
 *
 * Writes information for a COSI observation into an XML element. The
 * method supports both an unbinned and a binned observation.
 *
 * For an unbinned observation the XML format is
 *
 *     <observation name="Crab" id="00001" instrument="COS">
 *       <parameter name="EventList"      file="cosi_event_list.fits"/>
 *       <parameter name="SpaceCraftFile" file="cosi_orientation.ori"/>
 *       <parameter name="Response"       file="cosi_response.h5"/>
 *     </observation>
 *
 * If multiple event lists were read by the read() method, the method will
 * write back the file names of all the event lists.
 *
 * For a binned observation the XML format is
 *
 *     <observation name="Crab" id="00001" instrument="COS">
 *     </observation>
 *
 ***************************************************************************/
void GCOSObservation::write(GXmlElement& xml) const
{
    // Allocate XML element pointer
    GXmlElement* par;
 
    // Handle unbinned observation
    if (is_unbinned()) {
 
        // Set event list parameters
        for (int i = 0; i < m_eventnames.size(); ++i) {
            par = static_cast<GXmlElement*>(xml.append(GXmlElement("parameter name=\"EventList\"")));
            par->attribute("file", gammalib::xml_file_reduce(xml, m_eventnames[i]));
        }
 
        // Set space craft parameter
        par = gammalib::xml_need_par(G_WRITE, xml, "SpaceCraftFile");
        par->attribute("file", gammalib::xml_file_reduce(xml, m_spacename));
 
        // Set response parameter
        par = gammalib::xml_need_par(G_WRITE, xml, "Response");
        par->attribute("file", gammalib::xml_file_reduce(xml, m_rspname));
 
    } // endif: observation was unbinned
 
    // ... otherwise handle a binned observation
    else if (is_binned()) {
 
    } // endif: observation was binned
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Load data for an unbinned observation
 *
 * @param[in] eventname Event list FITS file name.
 * @param[in] spacename Space craft file name.
 * @param[in] rspname Response file name.
 *
 * Loads the event list, space craft file and the response for an unbinned
 * observation.
 ***************************************************************************/
void GCOSObservation::load(const GFilename& eventname,
                           const GFilename& spacename,
                           const GFilename& rspname)
{
    // Clear object
    clear();
 
    // Setup event list vector with single element
    std::vector<GFilename> eventnames;
    eventnames.push_back(eventname);
 
    // Load data
    load(eventnames, spacename, rspname);
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Load data for an unbinned observation
 *
 * @param[in] eventnames Vector of event list FITS file names.
 * @param[in] spacename Space craft file name.
 * @param[in] rspname Response file name.
 *
 * @exception GException::invalid_argument
 *            Empty event list name vector provided.
 *
 * Loads the event lists, space craft file and the response for an unbinned
 * observation. Multiple event lists are appended to each other and events
 * are sorted by increasing time.
 *
 * The method uses the Good Time Intervals provided in the space craft file
 * and attaches them to the event list. The method also sets the m_ontime,
 * m_livetime and m_deadc members from the information provided by the
 * space craft file.
 *
 * The specified file names are stored in the m_eventnames, m_spacename and
 * m_rspname class members which are used when writing the observation
 * information into an XML element.
 ***************************************************************************/
void GCOSObservation::load(const std::vector<GFilename>& eventnames,
                           const GFilename&              spacename,
                           const GFilename&              rspname)
{
    // Clear object
    clear();
 
    // Check that at least one event list is provided
    if (eventnames.size() == 0) {
        std::string msg = "The eventnames vector is empty but the method "
                          "needs at least one event list name. Please "
                          "specify at least one event list name.";
        throw GException::invalid_argument(G_LOAD, msg);
    }
 
    // Load all event lists
    for (int i = 0; i < eventnames.size(); ++i) {
 
        // If this is the first event list then allocate event list
        if (i == 0) {
            m_events = new GCOSEventList(eventnames[0]);
        }
 
        // ... otherwise extend existing event list
        else {
            GCOSEventList events(eventnames[i]);
            static_cast<GCOSEventList*>(m_events)->extend(events);
        }
 
    } // endfor: looped over event lists
 
    // Sort events by increasing time
    static_cast<GCOSEventList*>(m_events)->sort();
 
    // Load space craft file
    m_spacecraft.load(spacename);
 
    // Load response
    m_response.load(rspname);
 
    // Set event list Good Time Intervals from the space craft file Good
    // Time Intervals
    m_events->gti(m_spacecraft.gti());
 
    // Set observation attributes
    m_ontime   = m_spacecraft.ontime();
    m_livetime = m_spacecraft.livetime();
    m_deadc    = m_spacecraft.deadc();
 
    // Store filenames
    m_eventnames = eventnames;
    m_spacename  = spacename;
    m_rspname    = rspname;
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Print observation information
 *
 * @param[in] chatter Chattiness.
 * @return String containing COSI observation information.
 ***************************************************************************/
std::string GCOSObservation::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("=== GCOSObservation ===");
 
        // Append standard information for observation
        result.append("\n"+gammalib::parformat("Name")+name());
        result.append("\n"+gammalib::parformat("Identifier")+id());
        result.append("\n"+gammalib::parformat("Instrument")+instrument());
        result.append("\n"+gammalib::parformat("Statistic")+statistic());
        result.append("\n"+gammalib::parformat("Ontime"));
        result.append(gammalib::str(ontime())+" sec");
        result.append("\n"+gammalib::parformat("Livetime"));
        result.append(gammalib::str(livetime())+" sec");
        result.append("\n"+gammalib::parformat("Deadtime correction"));
        result.append(gammalib::str(m_deadc));
 
        // Append events
        if (m_events != NULL) {
            result.append("\n"+m_events->print(gammalib::reduce(chatter)));
        }
        else {
            result.append("\n"+gammalib::parformat("Events")+"undefined");
        }
 
    } // endif: chatter was not silent
 
    // Return result
    return result;
}
 
 
/*==========================================================================
 =                                                                         =
 =                            Private methods                              =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Initialise class members
 ***************************************************************************/
void GCOSObservation::init_members(void)
{
    // Initialise members
    m_instrument = "COS";
    m_response.clear();
    m_spacecraft.clear();
    m_ontime   = 0.0;
    m_livetime = 0.0;
    m_deadc    = 0.0;
 
    // Initialise members for unbinned observation
    m_eventnames.clear();
    m_spacename.clear();
    m_rspname.clear();
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Copy class members
 *
 * @param[in] obs COSI observation.
 ***************************************************************************/
void GCOSObservation::copy_members(const GCOSObservation& obs)
{
    // Copy members
    m_instrument = obs.m_instrument;
    m_response   = obs.m_response;
    m_spacecraft = obs.m_spacecraft;
    m_ontime     = obs.m_ontime;
    m_livetime   = obs.m_livetime;
    m_deadc      = obs.m_deadc;
 
    // Copy members for unbinned observation
    m_eventnames = obs.m_eventnames;
    m_spacename  = obs.m_spacename;
    m_rspname    = obs.m_rspname;
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Delete class members
 ***************************************************************************/
void GCOSObservation::free_members(void)
{
    // Return
    return;
}