Tim Jenness > Astro-Coords > Astro::Coords::Planet

Download:
Astro-Coords-0.18.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.06   Source  

NAME ^

Astro::Coords::Planet - coordinates relating to planetary motion

SYNOPSIS ^

  $c = new Astro::Coords::Planet( 'uranus' );

DESCRIPTION ^

This class is used by Astro::Coords for handling coordinates for planets..

METHODS ^

Constructor

new

Instantiate a new object using the supplied options.

  $c = new Astro::Coords::Planet( 'mars' );

Returns undef on error.

Class Methods

planets

Retuns a list of supported planet names.

 @planets = Astro::Coords::Planet->planets();

Accessor Methods

planet

Returns the name of the planet.

name

For planets, the name is always just the planet name.

General Methods ^

array

Return back 11 element array with first element containing the planet name.

This method returns a standardised set of elements across all types of coordinates.

type

Returns the generic type associated with the coordinate system. For this class the answer is always "RADEC".

This is used to aid construction of summary tables when using mixed coordinates.

It could be done using isa relationships.

stringify

Stringify overload. Simple returns the name of the planet in capitals.

summary

Return a one line summary of the coordinates. In the future will accept arguments to control output.

  $summary = $c->summary();
diam

Returns the apparent angular planet diameter from the most recent calculation of the apparent RA/Dec.

 $diam = $c->diam();

Returns the answer as a Astro::Coords::Angle object. Note that this number is not updated automatically. (so don't change the time and expect to get the correct answer without first asking for a ra/dec calculation).

apparent

Return the apparent RA and Dec as two Astro::Coords::Angle objects for the current coordinates and time.

 ($ra_app, $dec_app) = $self->apparent();
rv

Radial velocity of the planet relative to the Earth geocentre.

vdefn

Velocity definition. Always 'RADIO'.

vframe

Velocity reference frame. Always 'GEO'.

apply_offset

Overrided method to warn if Astro::Coords::apply_offset is called on this subclass.

NOTES ^

Usually called via Astro::Coords.

REQUIREMENTS ^

Astro::PAL is used for all internal astrometric calculations.

AUTHOR ^

Tim Jenness <t.jenness@cpan.org>

COPYRIGHT ^

Copyright (C) 2001-2005 Particle Physics and Astronomy Research Council. All Rights Reserved.

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, write to the Free Software Foundation, Inc., 59 Temple Place,Suite 330, Boston, MA 02111-1307, USA

syntax highlighting: