Tim Jenness > Astro-Coords > Astro::Coords::Calibration

Download:
Astro-Coords-0.18.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.03   Source  

NAME ^

Astro::Coords::Calibration - calibrations that do not have coordinates

SYNOPSIS ^

  $c = new Astro::Coords::Calibration();

DESCRIPTION ^

Occasionally observations do not have any associated coordinates. In particular calibration observations such as DARKs and ARRAY TESTS do not require the telescope to be in any particular location. This class exists in order that these types of observation can be processed in similar ways to other observations (from a scheduling viewpoint calibration observations always are an available target).

METHODS ^

This class inherits from Astro::Coords::Fixed.

Constructor

new

Simply instantiates an object with an Azimuth of 0.0 degrees and an elevation of 90 degrees. The exact values do not matter.

A label can be associated with the calibration (for example, to include the type).

  $c = new Astro::Coords::Calibration( name => 'DARK' );

General Methods

type

Return the coordinate type. In this case always return "CAL".

array

Returns a summary of the object in an 11 element array. All elements are undefined except the first. This contains "CAL".

status

Return a status string describing the current coordinates. For calibration objects this is very simple.

isObservable

Determines whether the observation is observable. Since a calibration observation (defined as an observation that does not move the telescope) is always observable this methods always returns true.

stringify

Returns stringified summary of the object. Always returns the type().

summary

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

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

Overrided method to prevent Astro::Coords::apply_offset being called on this subclass.

NOTES ^

Usually called via Astro::Coords.

REQUIREMENTS ^

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

AUTHOR ^

Tim Jenness <tjenness@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: