Method to take a general target name and clean it up
so that it is suitable for writing in a JCMT source catalog.
This routine is used by the catalog writing code but can also
be used publically in order to make sure that a target name
to be written to the catalogue is guaranteed to match that used
in another location (e.g. when writing an a document to accompany
the catalogue which refers to targets within it).
The source name can be truncated.
Will return undef if the argument is not defined.
Punctuation such as , and ; are replaced with underscores. ., () and +- are allowed.
Returns the location of the default JCMT pointing catalogue at the
JCMT itself. This is purely for convenience of the caller when they
are at the JCMT and wish to use the default catalogue without having
to know explicitly where it is.
Returns empty list/undef if the file is not available.
If the environment variable ASTRO_CATALOG_JCMT is defined (and exists) this will be used as the default.
Parses the catalogue lines and returns a new Astro::Catalog
object containing the catalog entries.
Supported options (with defaults) are:
Write the catalog to an array and return it. Returning a reference to
an array provides more flexibility to the caller.
Spaces are removed from source names. The contents of the catalog are sanity checked.
Parse a line from a JCMT format catalogue and return a corresponding
Astro::Catalog::Star object. Returns empty list if the line can not
be parsed or refers to a comment line (so that map can be used in the
where $line is the line to be parsed and (optional) $tel is an Astro::Telescope object to be associated with the coordinate objects.
The line is parsed using a pattern match.
Coordinates are stored as Astro::Coords objects inside Astro::Catalog::Star objects.
The following global variables can be modified to control the state of the module:
$DEBUG Controls debugging messages. Default state is false.
The following constants are available for querying:
MAX_SRC_LENGTH The maximum length of sourcenames writable to a JCMT source catalogue.
Copyright (C) 1999-2003 Particle Physics and Astronomy Research Council. All Rights Reserved.
Tim Jenness <email@example.com>
|perl v5.20.3||ASTRO::CATALOG::IO::JCMT (3)||2016-04-03|