astro C++ API Reference¶
-
class I3AstroConverter : public I3ConverterImplementation<I3Particle>¶
- #include <I3AstroConverters.h>
Public Functions
-
inline I3AstroConverter(const std::string &eventHeaderName = I3DefaultName<I3EventHeader>::value())¶
Private Functions
-
I3TableRowDescriptionPtr CreateDescription(const I3Particle&)¶
-
size_t FillRows(const I3Particle &particle, I3TableRowPtr rows)¶
- SET_LOGGER ("I3AstroConverter")
-
inline I3AstroConverter(const std::string &eventHeaderName = I3DefaultName<I3EventHeader>::value())¶
-
struct I3Ecliptic : public I3FrameObject¶
- #include <I3Astro.h>
Container class for storing ecliptic coordinates.
-
struct I3Equatorial : public I3FrameObject¶
- #include <I3Astro.h>
Container class for storing equatorial (J2000) coordinates.
-
struct I3Galactic : public I3FrameObject¶
- #include <I3Astro.h>
Container class for storing galactic coordinates (IAU 1958)
-
class I3GalacticConverter : public I3ConverterImplementation<I3Particle>¶
- #include <I3AstroConverters.h>
Public Functions
-
inline I3GalacticConverter(const std::string &eventHeaderName = I3DefaultName<I3EventHeader>::value())¶
Private Functions
-
I3TableRowDescriptionPtr CreateDescription(const I3Particle&)¶
-
size_t FillRows(const I3Particle &particle, I3TableRowPtr rows)¶
- SET_LOGGER ("I3GalacticConverter")
-
inline I3GalacticConverter(const std::string &eventHeaderName = I3DefaultName<I3EventHeader>::value())¶
-
class I3SunAndMoonConverter : public I3ConverterImplementation<I3EventHeader>¶
- #include <I3AstroConverters.h>
Public Functions
-
inline I3SunAndMoonConverter()¶
Private Functions
-
I3TableRowDescriptionPtr CreateDescription(const I3EventHeader&)¶
-
size_t FillRows(const I3EventHeader &header, I3TableRowPtr rows)¶
- SET_LOGGER ("I3SunAndMoonConverter")
-
inline I3SunAndMoonConverter()¶
-
struct I3SuperGalactic : public I3FrameObject¶
- #include <I3Astro.h>
Container class for storing supergalactic (de Vaucouleurs) coordinates.
-
class I3SuperGalacticConverter : public I3ConverterImplementation<I3Particle>¶
- #include <I3AstroConverters.h>
Public Functions
-
inline I3SuperGalacticConverter(const std::string &eventHeaderName = I3DefaultName<I3EventHeader>::value())¶
Private Functions
-
I3TableRowDescriptionPtr CreateDescription(const I3Particle&)¶
-
size_t FillRows(const I3Particle &particle, I3TableRowPtr rows)¶
- SET_LOGGER ("I3GalacticConverter")
-
inline I3SuperGalacticConverter(const std::string &eventHeaderName = I3DefaultName<I3EventHeader>::value())¶
-
namespace [anonymous]
-
namespace std
STL namespace.
- file I3Astro.cxx
- #include <star/pal.h>#include “dataclasses/I3Time.h”#include “dataclasses/I3Direction.h”#include “astro/I3Astro.h”
Copyright (C) 2015 The Icecube Collaboration SPDX-License-Identifier: BSD-2-Clause.
$Id$
- Author
Kevin Meagher
- Date
August 2015 $Rev$ $LastChangedBy$ $LastChangedDate$
Functions
-
double I3GetGMST(const I3Time &time)¶
Convert from I3Time to sidereal time (GMST)
- Parameters:
eventTime – - the time of the observation in I3Time
- Returns:
GMST in decimal hours
-
double I3GetGMAST(const I3Time &time)¶
Convert from I3Time to antisidereal time (GMAST)
- Parameters:
eventTime – - the time of the observation in I3Time
- Returns:
GMAST in decimal hours
-
double I3GetGMEST(const I3Time &time)¶
Convert from I3Time to extended-sidereal time (GMEST)
- Parameters:
eventTime – - the time of the observation in I3Time
- Returns:
GMEST in decimal hours
-
I3Direction I3GetMoonDirection(const I3Time &time)¶
Gets the direction of the Moon in local IceCube coordinates at time.
- Parameters:
time – - the time of the observation in I3Time
- Returns:
I3Direction object
-
I3Direction I3GetSunDirection(const I3Time &time)¶
Gets the direction of the Sun in local IceCube coordinates at time.
- Parameters:
time – - I3Time of the astronomical observation
- Returns:
I3Direction object
-
I3Direction I3GetDirectionFromEquatorial(const I3Equatorial &eq, const I3Time &time)¶
Convert an astronomical position in J2000 equatorial coordinates to local IceCube coordnates at a given time.
- Parameters:
equatorial – - I3Equatorial position of astronomical observation in J2000 coordinate system
time – - I3Time of the astronomical observation
- Returns:
I3Direction containing local IceCube direction
-
I3Equatorial I3GetEquatorialFromDirection(const I3Direction &dir, const I3Time &time)¶
Convert an IceCube direction to J2000 equatorial coordinates system at a given time.
- Parameters:
direction – - IceCube local coordinate to convert
time – - I3Time of the astronomical observation
- Returns:
I3Equatorial astronomical position of the event in J2000 coordinate system
-
I3Ecliptic I3GetEclipticFromEquatorial(const I3Equatorial &eq, const I3Time &time)¶
Convert from Equatorial (J2000) to Ecliptic coordinate system.
- Parameters:
equatorial – - I3Equatorial position of astronomical observation in J2000 coordinate system
time – - I3Time of the astronomical observation
- Returns:
I3Ecliptic position in ecliptic coordinate system
-
I3Equatorial I3GetEquatorialFromEcliptic(const I3Ecliptic &ecl, const I3Time &time)¶
Convert from Ecliptic to Equatorial (J2000) coordinate system.
- Parameters:
ecliptic – - I3Ecliptic position in galactic coordinate system
time – - I3Time of the astronomical observation
- Returns:
I3Equatorial position of astronomical observation in J2000 coordinate system
-
I3Galactic I3GetGalacticFromEquatorial(const I3Equatorial &eq)¶
Convert from Equatorial (J2000) to Galactic (IAU 1958) coordinate system.
- Parameters:
equatorial – - I3Equatorial position of astronomical observation in J2000 coordinate system
- Returns:
I3Galactic position in galactic coordinate system
-
I3Equatorial I3GetEquatorialFromGalactic(const I3Galactic &gal)¶
Convert from Galactic (IAU 1958) to Equatorial (J2000) coordinate system.
- Parameters:
galactic – - I3Galactic position in galactic coordinate system
- Returns:
I3Equatorial position of astronomical observation in J2000 coordinate system
-
I3SuperGalactic I3GetSuperGalacticFromGalactic(const I3Galactic &gal)¶
Convert from Galactic (IAU 1958) to SuperGalactic (de Vaucouleurs) coordinate system.
- Parameters:
galactic – - I3Galactic position in galactic coordinate system
- Returns:
I3SuperGalactic position of astronomical observation
-
I3Galactic I3GetGalacticFromSuperGalactic(const I3SuperGalactic &SG)¶
Convert from SuperGalactic (de Vaucouleurs) to Galactic (IAU 1958) coordinate system.
- Parameters:
supergalactic – - I3SuperGalactic position in SuperGalactic coordinate system
- Returns:
I3Galactic position of astronomical observation in IAU 1958 coordinate system
-
I3SuperGalactic I3GetSuperGalacticFromEquatorial(const I3Equatorial &eq)¶
Convert from Equatorial (J2000) to SuperGalactic (de Vaucouleurs) coordinate system.
- Parameters:
equatorial – - I3Equatorial position in Equatorial (J200) coordinate system
- Returns:
I3SuperGalactic position of astronomical observation in de Vaucouleurs coordinate system
-
I3Equatorial I3GetEquatorialFromSuperGalactic(const I3SuperGalactic &SG)¶
Convert from SuperGalactic (de Vaucouleurs) to Equatorial (J2000) coordinate system.
- Parameters:
supergalactic – - I3SuperGalactic position in Supergalactic (de Vaucouleurs) coordinate system
- Returns:
I3Equatorial position of astronomical observation in J2000 coordinate system
- file I3Astro.h
- #include “icetray/I3FrameObject.h”#include “icetray/I3Units.h”
High-level functions for astronomical conversions for IceCube datatypes.
Copyright (C) 2015 The IceCube Collaboration SPDX-License-Identifier: BSD-2-Clause
$Id$
- Author
Kevin Meagher
- Date
August 2015 $Rev$ $LastChangedBy$ $LastChangedDate$
Functions
-
double I3GetGMST(const I3Time &eventTime)
Convert from I3Time to sidereal time (GMST)
- Parameters:
eventTime – - the time of the observation in I3Time
- Returns:
GMST in decimal hours
-
double I3GetGMAST(const I3Time &eventTime)
Convert from I3Time to antisidereal time (GMAST)
- Parameters:
eventTime – - the time of the observation in I3Time
- Returns:
GMAST in decimal hours
-
double I3GetGMEST(const I3Time &eventTime)
Convert from I3Time to extended-sidereal time (GMEST)
- Parameters:
eventTime – - the time of the observation in I3Time
- Returns:
GMEST in decimal hours
-
I3Direction I3GetMoonDirection(const I3Time &time)
Gets the direction of the Moon in local IceCube coordinates at time.
- Parameters:
time – - the time of the observation in I3Time
- Returns:
I3Direction object
-
I3Direction I3GetSunDirection(const I3Time &time)
Gets the direction of the Sun in local IceCube coordinates at time.
- Parameters:
time – - I3Time of the astronomical observation
- Returns:
I3Direction object
-
I3Direction I3GetDirectionFromEquatorial(const I3Equatorial &equatorial, const I3Time &time)
Convert an astronomical position in J2000 equatorial coordinates to local IceCube coordnates at a given time.
- Parameters:
equatorial – - I3Equatorial position of astronomical observation in J2000 coordinate system
time – - I3Time of the astronomical observation
- Returns:
I3Direction containing local IceCube direction
-
I3Equatorial I3GetEquatorialFromDirection(const I3Direction &direction, const I3Time &time)
Convert an IceCube direction to J2000 equatorial coordinates system at a given time.
- Parameters:
direction – - IceCube local coordinate to convert
time – - I3Time of the astronomical observation
- Returns:
I3Equatorial astronomical position of the event in J2000 coordinate system
-
I3Ecliptic I3GetEclipticFromEquatorial(const I3Equatorial &equatorial, const I3Time &time)
Convert from Equatorial (J2000) to Ecliptic coordinate system.
- Parameters:
equatorial – - I3Equatorial position of astronomical observation in J2000 coordinate system
time – - I3Time of the astronomical observation
- Returns:
I3Ecliptic position in ecliptic coordinate system
-
I3Equatorial I3GetEquatorialFromEcliptic(const I3Ecliptic &ecliptic, const I3Time &time)
Convert from Ecliptic to Equatorial (J2000) coordinate system.
- Parameters:
ecliptic – - I3Ecliptic position in galactic coordinate system
time – - I3Time of the astronomical observation
- Returns:
I3Equatorial position of astronomical observation in J2000 coordinate system
-
I3Galactic I3GetGalacticFromEquatorial(const I3Equatorial &equatorial)
Convert from Equatorial (J2000) to Galactic (IAU 1958) coordinate system.
- Parameters:
equatorial – - I3Equatorial position of astronomical observation in J2000 coordinate system
- Returns:
I3Galactic position in galactic coordinate system
-
I3Equatorial I3GetEquatorialFromGalactic(const I3Galactic &galactic)
Convert from Galactic (IAU 1958) to Equatorial (J2000) coordinate system.
- Parameters:
galactic – - I3Galactic position in galactic coordinate system
- Returns:
I3Equatorial position of astronomical observation in J2000 coordinate system
-
I3SuperGalactic I3GetSuperGalacticFromGalactic(const I3Galactic &galactic)
Convert from Galactic (IAU 1958) to SuperGalactic (de Vaucouleurs) coordinate system.
- Parameters:
galactic – - I3Galactic position in galactic coordinate system
- Returns:
I3SuperGalactic position of astronomical observation
-
I3Galactic I3GetGalacticFromSuperGalactic(const I3SuperGalactic &supergalactic)
Convert from SuperGalactic (de Vaucouleurs) to Galactic (IAU 1958) coordinate system.
- Parameters:
supergalactic – - I3SuperGalactic position in SuperGalactic coordinate system
- Returns:
I3Galactic position of astronomical observation in IAU 1958 coordinate system
-
I3SuperGalactic I3GetSuperGalacticFromEquatorial(const I3Equatorial &equatorial)
Convert from Equatorial (J2000) to SuperGalactic (de Vaucouleurs) coordinate system.
- Parameters:
equatorial – - I3Equatorial position in Equatorial (J200) coordinate system
- Returns:
I3SuperGalactic position of astronomical observation in de Vaucouleurs coordinate system
-
I3Equatorial I3GetEquatorialFromSuperGalactic(const I3SuperGalactic &supergalactic)
Convert from SuperGalactic (de Vaucouleurs) to Equatorial (J2000) coordinate system.
- Parameters:
supergalactic – - I3SuperGalactic position in Supergalactic (de Vaucouleurs) coordinate system
- Returns:
I3Equatorial position of astronomical observation in J2000 coordinate system
- file I3AstroConverter.cxx
- #include “icetray/I3Frame.h”#include “icetray/I3Units.h”#include “dataclasses/physics/I3Particle.h”#include “astro/I3Astro.h”#include “I3AstroConverters.h”
Tableio Converter for I3Particle to store astronomical data.
Copyright (C) 2015 The Icecube Collaboration SPDX-License-Identifier: BSD-2-Clause
$Id$
Copyright (C) 2015 The IceCube Collaboration SPDX-License-Identifier: BSD-2-Clause
- Author
Kevin Meagher
- Date
August 2015 $Rev$ $LastChangedBy$ $LastChangedDate$
$Id$
- Author
Kevin Meagher
- Date
August 2015 $Rev$ $LastChangedBy$ $LastChangedDate$
- file I3AstroConverters.h
- #include “tableio/I3Converter.h”#include “dataclasses/physics/I3EventHeader.h”
- dir astro
- dir astro
- dir astro
- dir icetray
- dir private
- dir public