GCOSInstDir.cpp

Go to the documentation of this file.

/***************************************************************************
 *            GCOSInstDir.cpp - COSI instrument direction 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 GCOSInstDir.cpp
 * @brief COSI instrument direction class implementation
 * @author Juergen Knoedlseder
 */
 
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <cstring>  // std::memcpy
#include "GTools.hpp"
#include "GCOSInstDir.hpp"
 
/* __ Method name definitions ____________________________________________ */
 
/* __ Macros _____________________________________________________________ */
 
/* __ Coding definitions _________________________________________________ */
 
/* __ Debug definitions __________________________________________________ */
 
/* __ Prototypes _________________________________________________________ */
 
/*==========================================================================
 =                                                                         =
 =                         Constructors/destructors                        =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Void constructor
 *
 * Creates an empty COSI instrument direction.
 ***************************************************************************/
GCOSInstDir::GCOSInstDir(void) : GInstDir()
{
    // Initialise class members
    init_members();
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Copy constructor
 *
 * @param[in] dir COSI instrument direction.
 ***************************************************************************/
GCOSInstDir::GCOSInstDir(const GCOSInstDir& dir) : GInstDir(dir)
{
    // Initialise class members
    init_members();
 
    // Copy members
    copy_members(dir);
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Instrument direction constructor
 *
 * @param[in] dir Sky direction in celestial system.
 * @param[in] dir_local Sky direction in spacecraft system.
 * @param[in] phi Compton scatter angle (deg).
 *
 * Constructs a COSI instrument direction from a sky direction in the
 * celestial and spacecraft systems and a phi value.
 ***************************************************************************/
GCOSInstDir::GCOSInstDir(const GSkyDir& dir,
                         const GSkyDir& dir_local,
                         const double&  phi) : GInstDir()
{
    // Initialise class members
    init_members();
 
    // Set class members
    this->dir(dir);
    this->dir_local(dir_local);
    this->phi(phi);
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Destructor
 ***************************************************************************/
GCOSInstDir::~GCOSInstDir(void)
{
    // Free members
    free_members();
 
    // Return
    return;
}
 
 
/*==========================================================================
 =                                                                         =
 =                                Operators                                =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Assignment operator
 *
 * @param[in] dir COSI instrument direction.
 * @return COSI instrument direction.
 ***************************************************************************/
GCOSInstDir& GCOSInstDir::operator=(const GCOSInstDir& dir)
{
    // Execute only if object is not identical
    if (this != &dir) {
 
        // Copy base class members
        this->GInstDir::operator=(dir);
 
        // Free members
        free_members();
 
        // Initialise private members
        init_members();
 
        // Copy members
        copy_members(dir);
 
    } // endif: object was not identical
 
    // Return this object
    return *this;
}
 
 
/*==========================================================================
 =                                                                         =
 =                              Public methods                             =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Clear COSI instrument direction
 *
 * Clears COSI instrument direction by resetting all class members to
 * an initial state. Any information that was present before will be lost.
 ***************************************************************************/
void GCOSInstDir::clear(void)
{
    // Free members
    free_members();
    this->GInstDir::free_members();
 
    // Initialise private members
    this->GInstDir::init_members();
    init_members();
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Clone COSI instrument direction
 *
 * @return Pointer to deep copy of COSI instrument direction.
 ***************************************************************************/
GCOSInstDir* GCOSInstDir::clone(void) const
{
    return new GCOSInstDir(*this);
}
 
 
/***********************************************************************//**
 * @brief Return COSI instrument direction hash value
 *
 * @return Hash value.
 *
 * Returns a hash value that can be used in the response cache.
 ***************************************************************************/
u_int64_t GCOSInstDir::hash(void) const
{
    // Allocate static array to store the information as floats
    static float buffer[2];
 
    // Store the two sky coordinates as floats
    buffer[0] = float(m_dir.ra());
    buffer[1] = float(m_dir.dec());
 
    // Map the floats to an unsigned 64 Bit integer
    u_int64_t hash;
    std::memcpy(&hash, &buffer, sizeof hash);
 
    // Return hash value
    return hash;
}
 
 
/***********************************************************************//**
 * @brief Print COSI instrument direction information
 *
 * @param[in] chatter Chattiness.
 * @return String containing COSI instrument direction information.
 ***************************************************************************/
std::string GCOSInstDir::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("=== GCOSInstDir ===");
 
        // Append information
        result.append("\n"+gammalib::parformat("Sky direction (Chi,Psi)"));
        result.append(m_dir.print(chatter));
        result.append("\n"+gammalib::parformat("Spacecraft direction (Chi,Psi)"));
        result.append(m_dir_local.print(chatter));
        result.append("\n"+gammalib::parformat("Scatter angle (Phi)"));
        result.append(gammalib::str(m_phi)+" deg");
 
    } // endif: chatter was not silent
 
    // Return result
    return result;
}
 
 
/*==========================================================================
 =                                                                         =
 =                             Private methods                             =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Initialise class members
 ***************************************************************************/
void GCOSInstDir::init_members(void)
{
    // Initialise members
    m_dir.clear();
    m_dir_local.clear();
    m_phi = 0.0;
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Copy class members
 *
 * @param[in] dir COSI instrument direction.
 ***************************************************************************/
void GCOSInstDir::copy_members(const GCOSInstDir& dir)
{
    // Copy members
    m_dir       = dir.m_dir;
    m_dir_local = dir.m_dir_local;
    m_phi       = dir.m_phi;
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Delete class members
 ***************************************************************************/
void GCOSInstDir::free_members(void)
{
    // Return
    return;
}