JASTRONOMY Namespace Reference

Classes
struct	angle_type
	Auxiliary data structure for pair of angles. More...
struct	angle_type_deg
	Auxiliary data structure for pair of angles. More...
struct	angle_type_rad
	Auxiliary data structure for pair of angles. More...
struct	J2000
	Conversion of source location. More...
struct	JAspera
	Auxiliary data structure to fit signal strength using likelihood ratio. More...
class	JAstronomy
	Auxiliary class to make coordinate transformations for a specific geographical location of the detector. More...
struct	JDiscovery
	Auxiliary data structure for discovery calculations. More...
struct	JEllipsoid
	Ellipsoid. More...
struct	JExperiment
	Auxiliary base class for experiment. More...
struct	JGalacticCoordinates
	Location of astrophysical source in Galactic coordinates. More...
struct	JGarage
	Auxiliary container for statistical analysis of a large number of positive (or zero) values. More...
struct	JGen2
	Auxiliary data structure to fit signal strength using likelihood ratio for multiple pseudo experiments. More...
struct	JGeographicalLocation
	Location of detector. More...
struct	JMorphology
	Interface for source morphology simulation. More...
struct	JMorphologyBinary
	Implementation of binary source morphology. More...
struct	JMorphologyGauss
	Implementation of Gaussian source morphology. More...
struct	JMorphologyGauss2D
	Implementation of 2D-Gaussian source morphology. More...
struct	JMorphologyHelper
	Helper data structure for source morphology I/O. More...
struct	JMorphologyHistogram
	Implementation of histogram source morphology. More...
struct	JMorphologyPoint
	Implementation of point source morphology. More...
struct	JNeutrinoDirection
	Direction of incident neutrino. More...
struct	JNuisance
	Interface for nuisance parameter. More...
struct	JNuisanceFixed
	Implementation of fixed nuisance. More...
struct	JNuisanceGauss
	Implementation of Gaussian nuisance. More...
struct	JNuisanceHelper
	Helper data structure for nuisance I/O. More...
struct	JNuisanceTF1
	Implementation of nuisance based on a formula. More...
struct	JNuisanceTH1
	Implementation of nuisance based on histogram. More...
struct	JPseudoExperiment
	Pseudo experiment using CDF for combined generation and likelihood evaluation. More...
struct	JPseudoExperiment_t
	Auxiliary interface for pseudo experiment. More...
struct	JRealExperiment
	Real experiment using PDF of signal and background. More...
struct	JResolution
	Interface for detector resolution simulation. More...
struct	JResolutionGauss
	Implementation of Gaussian detector resolution. More...
struct	JResolutionHelper
	Helper data structure for detector resolution I/O. More...
struct	JResolutionLog
	Implementation of detector resolution based on histogram filled according log10(alpha). More...
struct	JResolutionTF1
	Implementation of detector resolution based on a formula. More...
struct	JResolutionTH1
	Implementation of detector resolution based on histogram. More...
struct	JSourceLocation
	Location of astrophysical source. More...
struct	JSourceLocationJ2000
	Location of astrophysical source. More...
struct	JStarTrek
	Auxiliary class for source tracking. More...

Typedefs
typedef std::shared_ptr< JMorphology >	morphology_type
	Type definition of generic morphology.
typedef std::shared_ptr< JNuisance >	nuisance_type
	Type definition of generic nuisance.
typedef std::shared_ptr< JResolution >	resolution_type
	Type definition of generic resolution.

Functions
double	getTimeMJD (time_t t1_s)
	Get MJD time given UTC time.
double	getTimeUTC (time_t t1_s)
	Get UTC time given MJD time.
double	getRadians (const double angle)
	Convert angle to radians.
double	getDegrees (const double angle)
	Convert angle to degrees.
double	getRadians (const int angle, const int amin, const double asec)
	Convert angle to radians.
double	getHourAngle (const int hour, const int min, const double sec)
	Convert hour angle to radians.
double	getMeridianConvergenceAngle (const JGeographicalLocation &location)
	Get Meridian convergence angle.
double	getMeridianConvergenceAngle (const JGeographicalLocation &location, const JEllipsoid &ellipsoid)
	Get Meridian convergence angle.
template<class T , const size_t factor>
double	discovery (JPseudoExperiment_t &px, const double Q, const double P, const size_t numberOfTests, const double precision=1.0e-3)
	Run pseudo experiments to determine signal strength for which given likelihood is exceeded with given probability.
std::istream &	operator>> (std::istream &in, morphology_type &object)
	Read morphology from input stream.
std::ostream &	operator<< (std::ostream &out, const morphology_type &object)
	Write morphology to output stream.
std::istream &	operator>> (std::istream &in, nuisance_type &object)
	Read nuisance from input stream.
std::ostream &	operator<< (std::ostream &out, const nuisance_type &object)
	Write nuisance to output stream.
std::istream &	operator>> (std::istream &in, resolution_type &object)
	Read resolution from input stream.
std::ostream &	operator<< (std::ostream &out, const resolution_type &object)
	Write resolution to output stream.

Variables
static const double	NUMBER_OF_SECONDS_PER_HOUR = 60.0 * 60.0
static const double	NUMBER_OF_SECONDS_PER_DAY = NUMBER_OF_SECONDS_PER_HOUR * 24.0
static const double	NUMBER_OF_SECONDS_PER_YEAR = NUMBER_OF_SECONDS_PER_DAY * 365.0
static const double	NUMBER_OF_SECONDS_PER_SEDERIAL_DAY = NUMBER_OF_SECONDS_PER_HOUR * 23.9344696
static const double	LATITUDE_MIN_DEG = -80.0
	Minimal latitude angle [deg] of UTM for meridian convergence angle calculation.
static const double	LATITUDE_MAX_DEG = 84.0
	Maximal latitude angle [deg] of UTM for meridian convergence angle calculation.
static const double	MJD_EPOCH = 40587.0
	MJD of the Unix Epoch, i.e. 00:00 Jan 1 1970 (UTC) [d].
static const double	MJD_EPOCH_S = MJD_EPOCH * NUMBER_OF_SECONDS_PER_DAY
	MJD of the Unix Epoch, i.e. 00:00 Jan 1 1970 (UTC) [s].
static const JEllipsoid	EARTH_WGS84 = { 6378137.0, 0.00669438 }
	Earth ellipsoid according WGS84.
static const JGeographicalLocation	ANTARES (42, 48, 06, 10)
static const JGeographicalLocation	SICILY (36, 16, 16, 06)
static const JGeographicalLocation	PYLOS (36, 33, 16, 06)
static const JGeographicalLocation	ARCA (0.63342, 0.27883)
static const JGeographicalLocation	ORCA (0.74702, 0.10511)
static const JSourceLocation	GALACTIC_CENTER (-0.5062816, -1.633335)
static const JSourceLocation	RXJ1713 (getRadians(-39, -46, 0.0), getHourAngle(17, 13, 7))
static const JSourceLocation	VELAX (getRadians(-45, -10, -35.2), getHourAngle(8, 35, 20.66))
static const JMorphologyHelper	morphology_helper
	Helper object for morphology I/O.
static const JNuisanceHelper	nuisance_helper
	Helper object for nuisance I/O.
static const JResolutionHelper	resolution_helper
	Helper object for resolution I/O.

Detailed Description

Author

mdejong

Typedef Documentation

morphology_type

typedef std::shared_ptr<JMorphology> JASTRONOMY::morphology_type

Type definition of generic morphology.

Definition at line 489 of file JMorphology.hh.

nuisance_type

typedef std::shared_ptr<JNuisance> JASTRONOMY::nuisance_type

Type definition of generic nuisance.

Definition at line 347 of file JNuisance.hh.

resolution_type

typedef std::shared_ptr<JResolution> JASTRONOMY::resolution_type

Type definition of generic resolution.

Definition at line 359 of file JResolution.hh.

Function Documentation

getTimeMJD()

double JASTRONOMY::getTimeMJD ( time_t t1_s )

inline

Get MJD time given UTC time.

Parameters

t1_s	UTC time [s]

Returns

MJD time [s]

Definition at line 86 of file JAstronomy.hh.

  {
    return t1_s + MJD_EPOCH_S;
  }

getTimeUTC()

double JASTRONOMY::getTimeUTC ( time_t t1_s )

inline

Get UTC time given MJD time.

Parameters

t1_s	MJD time [s]

Returns

UTC time [s]

Definition at line 98 of file JAstronomy.hh.

  {
    return t1_s - MJD_EPOCH_S;
  }

getRadians() [1/2]

double JASTRONOMY::getRadians ( const double angle )

inline

Convert angle to radians.

Parameters

angle

angle [deg]

Returns

angle [rad]

Definition at line 110 of file JAstronomy.hh.

  {
    return PI * angle / 180.0;
  }

getDegrees()

double JASTRONOMY::getDegrees ( const double angle )

inline

Convert angle to degrees.

Parameters

angle

angle [rad]

Returns

angle [deg]

Definition at line 122 of file JAstronomy.hh.

  {
    return 180.0 * angle / PI;
  }

getRadians() [2/2]

double JASTRONOMY::getRadians ( const int angle, const int amin, const double asec )

inline

Convert angle to radians.

Parameters

angle	angle [deg]
amin	arcminutes
asec	arcseconds

Returns

angle [rad]

Definition at line 136 of file JAstronomy.hh.

  {
    return PI * ((double) angle          +
                 (double) amin  /   60.0 + 
                 (double) asec  / 3600.0)  /  180.0;
  }

getHourAngle()

double JASTRONOMY::getHourAngle ( const int hour, const int min, const double sec )

inline

Convert hour angle to radians.

Parameters

hour	hour
min	minutes
sec	seconds

Returns

angle [rad]

Definition at line 154 of file JAstronomy.hh.

  {
    double ha = PI * ((double) hour /    12.0 + 
                      (double) min  /   720.0 + 
                      (double) sec  / 43200.0);
 
    if (ha > PI) {
      ha -= 2*PI;
    }
 
    return ha;
  }

getMeridianConvergenceAngle() [1/2]

double JASTRONOMY::getMeridianConvergenceAngle ( const JGeographicalLocation & location )

inline

Get Meridian convergence angle.

The meridian convergence angle is the angle between the true meridian of a point on the surface of the earth's ellipsoid and the Prime Meridian of the projection zone where the point is located, that is, the angle between the coordinate north and the true north of the Gaussian plane rectangular coordinate system. see https://gis.stackexchange.com/questions/115531/calculating-grid-convergence-true-north-to-grid-north

Parameters

location

geographical location

Returns

meridian convergence angle [rad]

Definition at line 928 of file JAstronomy.hh.

  {
    const double omega = location.getLongitude() - getUTMLongitude(getUTMZone(location.getLongitude()));
    const double gamma = atan(tan(omega) * sin(location.getLatitude()));
 
    return gamma;
  }

getMeridianConvergenceAngle() [2/2]

double JASTRONOMY::getMeridianConvergenceAngle ( const JGeographicalLocation & location, const JEllipsoid & ellipsoid )

inline

Get Meridian convergence angle.

Angular difference of the UTM Northing direction to the geodetic North. It is positive to the East. For example, for ANTARES, convergence angle = -1.93 deg E, i.e. UTM North pointing a bit towards the geographical West. Code from aanet/evt/Det.cc.

Parameters

location	geographical location
ellipsoid	Earth ellipsoid

Returns

meridian convergence angle [rad]

Definition at line 948 of file JAstronomy.hh.

  {
    const double latitude_deg = getDegrees(location.getLatitude());
 
    if (latitude_deg > LATITUDE_MAX_DEG ||
        latitude_deg < LATITUDE_MIN_DEG) {
      THROW(JValueOutOfRange,
            "UTM coordinate system not defined for given Latitude: "
            << latitude_deg << " [deg] <> [" << FIXED(5,2) << LATITUDE_MAX_DEG << "," << FIXED(5,2) << LATITUDE_MIN_DEG << "]");
    }
 
    // detector position, longitude and latitude in rad
    const double lambda  = location.getLongitude();
    const double phi     = location.getLatitude();
 
    // find UTM zone and central meridian
    // longitude of the central meridian of UTM zone in rad
    const double omega   = lambda - getUTMLongitude(getUTMZone(location.getLongitude()));
 
    const double rho = ellipsoid.radius_m*(1.-ellipsoid.eccentricity)/pow(1.-ellipsoid.eccentricity*pow(sin(phi),2),3./2.);
    const double nu  = ellipsoid.radius_m/sqrt(1-ellipsoid.eccentricity*pow(sin(phi),2.));
    const double psi = nu/rho;
    const double t   = tan(phi);
 
    // power series for convergence angle 
    const double gamma = sin(phi) * omega
      - sin(phi) * pow(omega,3.)/3.  * pow(cos(phi),2.) * (2.*pow(psi,2.)-psi)
      - sin(phi) * pow(omega,5.)/15. * pow(cos(phi),4.) * (pow(psi,4.)*(11.-24.*pow(t,2.))-
                                                           pow(psi,3.)*(11.-36.*pow(t,2.))+
                                                           2.*pow(psi,2.)*(1.-7.*pow(t,2.))+
                                                           psi*pow(t,2.)
                                                           )
      - sin(phi) * pow(omega,7.)/315. * pow(cos(phi),6.) * (17.-26.*pow(t,2.)+2.*pow(t,4.));
 
    return gamma;
  }

discovery()

template<class T , const size_t factor>

double JASTRONOMY::discovery ( JPseudoExperiment_t & px, const double Q, const double P, const size_t numberOfTests, const double precision = 1.0e-3 )

inline

Run pseudo experiments to determine signal strength for which given likelihood is exceeded with given probability.

Parameters

px	pseudo experiment
Q	likelihood
P	probability [0,1>
numberOfTests	number of tests
precision	precision of signal strength

Returns

signal strength

Definition at line 116 of file JAstronomyToolkit.hh.

  {
    JDiscovery<T, factor> discovery(px);
 
    return discovery(Q, P, numberOfTests, precision);
  }

operator>>() [1/3]

std::istream & JASTRONOMY::operator>> ( std::istream & in, morphology_type & object )

inline

Read morphology from input stream.

Parameters

in	input stream
object	morphology

Returns

input stream

Definition at line 557 of file JMorphology.hh.

  {
    return morphology_helper(in, object);
  }

operator<<() [1/3]

std::ostream & JASTRONOMY::operator<< ( std::ostream & out, const morphology_type & object )

inline

Write morphology to output stream.

Parameters

out	output stream
object	morphology

Returns

output stream

Definition at line 570 of file JMorphology.hh.

  {
    if (object) {
      out << object->getTitle() << ' ';
      object->write(out);
    }
 
    return out;
  }

operator>>() [2/3]

std::istream & JASTRONOMY::operator>> ( std::istream & in, nuisance_type & object )

inline

Read nuisance from input stream.

Parameters

in	input stream
object	nuisance

Returns

input stream

Definition at line 414 of file JNuisance.hh.

  {
    return nuisance_helper(in, object);
  }

operator<<() [2/3]

std::ostream & JASTRONOMY::operator<< ( std::ostream & out, const nuisance_type & object )

inline

Write nuisance to output stream.

Parameters

out	output stream
object	nuisance

Returns

output stream

Definition at line 427 of file JNuisance.hh.

  {
    if (object) {
      out << object->getTitle() << ' ' << *object.get();
    }
 
    return out;
  }

operator>>() [3/3]

std::istream & JASTRONOMY::operator>> ( std::istream & in, resolution_type & object )

inline

Read resolution from input stream.

Parameters

in	input stream
object	resolution

Returns

input stream

Definition at line 426 of file JResolution.hh.

  {
    return resolution_helper(in, object);
  }

operator<<() [3/3]

std::ostream & JASTRONOMY::operator<< ( std::ostream & out, const resolution_type & object )

inline

Write resolution to output stream.

Parameters

out	output stream
object	resolution

Returns

output stream

Definition at line 439 of file JResolution.hh.

  {
    if (object) {
      out << object->getTitle() << ' ';
      object->write(out);
    }
 
    return out;
  }

Variable Documentation

NUMBER_OF_SECONDS_PER_HOUR

const double JASTRONOMY::NUMBER_OF_SECONDS_PER_HOUR = 60.0 * 60.0

static

Definition at line 43 of file JAstronomy.hh.

NUMBER_OF_SECONDS_PER_DAY

const double JASTRONOMY::NUMBER_OF_SECONDS_PER_DAY = NUMBER_OF_SECONDS_PER_HOUR * 24.0

static

Definition at line 44 of file JAstronomy.hh.

NUMBER_OF_SECONDS_PER_YEAR

const double JASTRONOMY::NUMBER_OF_SECONDS_PER_YEAR = NUMBER_OF_SECONDS_PER_DAY * 365.0

static

Definition at line 45 of file JAstronomy.hh.

NUMBER_OF_SECONDS_PER_SEDERIAL_DAY

const double JASTRONOMY::NUMBER_OF_SECONDS_PER_SEDERIAL_DAY = NUMBER_OF_SECONDS_PER_HOUR * 23.9344696

static

Definition at line 46 of file JAstronomy.hh.

LATITUDE_MIN_DEG

const double JASTRONOMY::LATITUDE_MIN_DEG = -80.0

static

Minimal latitude angle [deg] of UTM for meridian convergence angle calculation.

Definition at line 48 of file JAstronomy.hh.

LATITUDE_MAX_DEG

const double JASTRONOMY::LATITUDE_MAX_DEG = 84.0

static

Maximal latitude angle [deg] of UTM for meridian convergence angle calculation.

Definition at line 49 of file JAstronomy.hh.

MJD_EPOCH

const double JASTRONOMY::MJD_EPOCH = 40587.0

static

MJD of the Unix Epoch, i.e. 00:00 Jan 1 1970 (UTC) [d].

Definition at line 51 of file JAstronomy.hh.

MJD_EPOCH_S

const double JASTRONOMY::MJD_EPOCH_S = MJD_EPOCH * NUMBER_OF_SECONDS_PER_DAY

static

MJD of the Unix Epoch, i.e. 00:00 Jan 1 1970 (UTC) [s].

Definition at line 52 of file JAstronomy.hh.

EARTH_WGS84

const JEllipsoid JASTRONOMY::EARTH_WGS84 = { 6378137.0, 0.00669438 }

static

Earth ellipsoid according WGS84.

Definition at line 77 of file JAstronomy.hh.

{ 6378137.0, 0.00669438 };

ANTARES

const JGeographicalLocation JASTRONOMY::ANTARES(42, 48, 06, 10) ( 42 , 48 , 06 , 10  )

static

SICILY

const JGeographicalLocation JASTRONOMY::SICILY(36, 16, 16, 06) ( 36 , 16 , 16 , 06  )

static

PYLOS

const JGeographicalLocation JASTRONOMY::PYLOS(36, 33, 16, 06) ( 36 , 33 , 16 , 06  )

static

ARCA

const JGeographicalLocation JASTRONOMY::ARCA(0.63342, 0.27883) ( 0. 63342, 0. 27883 )

static

ORCA

const JGeographicalLocation JASTRONOMY::ORCA(0.74702, 0.10511) ( 0. 74702, 0. 10511 )

static

GALACTIC_CENTER

const JSourceLocation JASTRONOMY::GALACTIC_CENTER(-0.5062816, -1.633335) ( -0. 5062816, -1. 633335 )

static

RXJ1713

const JSourceLocation JASTRONOMY::RXJ1713(getRadians(-39, -46, 0.0), getHourAngle(17, 13, 7)) ( getRadians(-39, -46, 0.0) , getHourAngle(17, 13, 7)  )

static

VELAX

const JSourceLocation JASTRONOMY::VELAX(getRadians(-45, -10, -35.2), getHourAngle(8, 35, 20.66)) ( getRadians(-45, -10, -35.2) , getHourAngle(8, 35, 20.66)  )

static

morphology_helper

const JMorphologyHelper JASTRONOMY::morphology_helper

static

Helper object for morphology I/O.

Definition at line 547 of file JMorphology.hh.

nuisance_helper

const JNuisanceHelper JASTRONOMY::nuisance_helper

static

Helper object for nuisance I/O.

Definition at line 404 of file JNuisance.hh.

resolution_helper

const JResolutionHelper JASTRONOMY::resolution_helper

static

Helper object for resolution I/O.

Definition at line 416 of file JResolution.hh.