Alasdair Allan > Astro-SIMBAD > Astro::SIMBAD::Result::Object

Download:
Astro-SIMBAD-2.0.0.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 1.3   Source  

NAME ^

Astro::SIMBAD::Result::Object - A individual astronomical object

SYNOPSIS ^

  $object = new Astro::SIMBAD::Result::Object( Name   => $object_name,
                                               Type   => $object_type,
                                               Long   => $long_type,
                                               Frame => \@coord_frame,
                                               RA     => $ra,
                                               Dec    => $declination,
                                               Spec   => $spectral_type,
                                               URL    => $url );

DESCRIPTION ^

Stores meta-data about an individual astronomical object in the Astro::SIMBAD::Result object returned by an Astro::SIMBAD::Query object.

REVISION ^

$Id: Object.pm,v 1.3 2005/06/08 01:38:17 aa Exp $

METHODS ^

Constructor

new

Create a new instance from a hash of options

  $paper = new Astro::SIMBAD::Result::Object(  );

returns a reference to an SIMBAD astronomical object.

Accessor Methods

name

Return (or set) the name of the object

   $name = $object->name();
   $object->name( $name );

Query types: list, object

target

Return (or set) the target name of the object. Available whenever a target is specified in the query. The returned value is identical to the query parameter, except that it is normalized (spaces replaced with '+' characters). This is useful because name() may return a different designation than the target that is supplied as a query parameter.

   $target = $object->target();
   $object->target( $target );

Query types: list, object

type

Return (or set) the (short) type of the object

   $type = $object->type();
   $object->type( $type );

Query types: list

long

Return (or set) the (long) type of the object

   $long_type = $object->long();
   $object->long( $long_type );

Query types: list, object

frame

Return (or set) the system the R.A. and DEC stored in the object are defined in, e.g. Co-ordinate Frame FK5, Epoch 1950 and Equinox 2000

   @system = $object->frame();
   $object->frame( \@system );

where @system would be [ "FK5", 1950.0, 2000.0 ]. If called in a scalar context will return a string of the form "FK5 1950/2000" to

Query types: list, object

ra

Return (or set) the R.A. of the object

   $ra = $object->ra();
   $object->ra( $ra );

Query types: list, object

dec

Return (or set) the Declination of the object

   $dec = $object->dec();
   $object->dec( $dec );

Query types: list, object

spec

Return (or set) the Spectral Type of the object

   $spec_type = $object->spec();
   $object->spec( $spec_type );

Query types: list, object

url

Return (or set) the followup URL for the object where more information can be found via SIMBAD, including pointers to reduced data.

   $url = $object->url();
   $object->url( $url );
bmag

Return (or set) the B-magnitude of the object

   $bmag = $object->bmag();
   $object->bmag( $bmag );

Query types: list, object

vmag

Return (or set) the V-magnitude of the object

   $vmag = $object->vmag();
   $object->vmag( $vmag );

Query types: list, object

ident

Return (or append) the array of object identifiers

   @ident = $object->ident();
   $object->ident( @ident );

Query types: object

pm

Return (or set) the proper motion of the object in mas/year

   @pm = $object->pm();
   $object->pm( @pm );

Query types: object

plx

Return (or set) the parallax of the object

   $plx = $object->plx();
   $object->plx( $plx );

Query types: object

radial

Return (or set) the radial velocity (km/s) of the object

   $radial = $object->radial();
   $object->radial( $radial );

Query types: object

redshift

Return (or set) the redshift of the object

   $redshift = $object->redshift();
   $object->redshift( $redshift );

Query types: object

General Methods

configure

Configures the object from multiple pieces of information.

  $object->configure( %options );

Takes a hash as argument with the following keywords:

COPYRIGHT ^

Copyright (C) 2001 University of Exeter. All Rights Reserved.

This program was written as part of the eSTAR project and is free software; you can redistribute it and/or modify it under the terms of the GNU Public License.

AUTHORS ^

Alasdair Allan <aa@astro.ex.ac.uk>,

syntax highlighting: