Package gaiasky.util.gaia.utils

Class ComplexArea

java.lang.Object
gaiasky.util.gaia.utils.ComplexArea
All Implemented Interfaces:
Area
public class ComplexArea
extends java.lang.Object
implements Area
Specifies a combination of Areas.

  • Constructor Summary

    Constructors
    Constructor Description
    ComplexArea()  

  • Method Summary

    Modifier and Type Method Description
    void add​(Area a)  
    double altitude​(Place spinAxisPlace)
    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
    java.util.Collection<Area> getListOfAreas()  
    Place getMidPoint()
    Determine the weighted mid-point of the Area
    java.lang.String getName()
    Get the name of the area
    Place getRandomPlace​(java.util.Random rnd)
    Get a random Place within the ComplexArea
    double getSquareDegrees()  
    double getWeight()
    Determine the weight of the Area
    void setName​(java.lang.String str)
    Set the name of the area

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ComplexArea

      public ComplexArea()

  • Method Details

    • add

      public void add​(Area a)

    • altitude

      public double altitude​(Place spinAxisPlace)
      Description copied from interface: Area
      Determine the minimum angle between a great circle and the Area boundary
      Specified by:
      altitude in interface Area
      Parameters:
      spinAxisPlace - 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

    • getRandomPlace

      public Place getRandomPlace​(java.util.Random rnd)
      Get a random Place within the ComplexArea
      Parameters:
      rnd - Random number generator
      Returns:
      random Place

    • getSquareDegrees

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

    • getListOfAreas

      public java.util.Collection<Area> getListOfAreas()
      Returns:
      the listOfAreas

    • setName

      public void setName​(java.lang.String str)
      Set the name of the area
      Parameters:
      str - The string

    • getName

      public java.lang.String getName()
      Get the name of the area
      Returns:
      The name