Package gaiasky.util.gaia.utils

Class CircleArea

java.lang.Object
gaiasky.util.gaia.utils.CircleArea
All Implemented Interfaces:
Area
public class CircleArea
extends java.lang.Object
implements Area
A circular area about a centre c (which is defined by a Place object), and radius r.

  • Constructor Summary

    Constructors
    Constructor Description
    CircleArea​(Place c, double r)
    Creates an instance of a CircleArea about a given centre and radius.

  • Method Summary

    Modifier and Type Method Description
    double altitude​(Place pole)
    Determine the minimum angle between a great circle and the Area boundary
    boolean contains​(Place p)
    Determine whether a given Place is within the Area
    Place getCentre()  
    Place getMidPoint()
    Determine the weighted mid-point of the Area
    double getRadius()  
    double getSquareDegrees()  
    double getWeight()
    Determine the weight of the Area

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • CircleArea

      public CircleArea​(Place c, double r)
      Creates an instance of a CircleArea about a given centre and radius.
      Parameters:
      c - the centre
      r - the radius [rad]

  • Method Details

    • altitude

      public double altitude​(Place pole)
      Description copied from interface: Area
      Determine the minimum angle between a great circle and the Area boundary
      Specified by:
      altitude in interface Area
      Parameters:
      pole - great circle pole given as a Place
      Returns:
      minimum angle [rad]

    • contains

      public boolean contains​(Place p)
      Description copied from interface: Area
      Determine whether a given Place is within the Area
      Specified by:
      contains in interface Area
      Parameters:
      p - the Place
      Returns:
      true if p is within the Area

    • getMidPoint

      public Place getMidPoint()
      Description copied from interface: Area
      Determine the weighted mid-point of the Area
      Specified by:
      getMidPoint in interface Area
      Returns:
      the centre

    • getWeight

      public double getWeight()
      Description copied from interface: Area
      Determine the weight of the Area
      Specified by:
      getWeight in interface Area
      Returns:
      the weight

    • getCentre

      public Place getCentre()
      Returns:
      the centre

    • getRadius

      public double getRadius()
      Returns:
      the radius

    • getSquareDegrees

      public double getSquareDegrees()
      Returns:
      the solid angle [deg^2]