NAME

Astro::NED::Response::Object - query results for a single object

SYNOPSIS

use Astro::NED::Response::Object;

my $obj = Astro::NED::Response::Object->new( Field => $value, ...  );

print $obj->Field;

DESCRIPTION

An instance of Astro::NED::Response::Object contains information on a single object (astronomical, not computer science) returned by queries generated by Astro::NED::Query::ByName, Astro::NED::Query::NearName, or Astro::NED::Query::NearPosition (actually, any class subclassed from Astro::NED::Query::Objects).

The object (computer science, not astronomical) is usually contained in and created by a Astro::NED::Response::Objects object from the results of the query.

Objects are read-only.

For complete information on the available fields, see http://nedwww.ipac.caltech.edu/help/objresult_help.html.

Currently, the detailed object information is *not* available (just the summary information) although the InfoLink method will return the URL to that information.

Constructor

The constructor, new, takes a list of field, value pairs with which to initialize the object. See Fields for more information.

Non Accessor Methods

dumpstr

$string = $obj->dumpstr();
$string = $obj->dumpstr( $pfx );

Return a string representation of the object. If $pfx is specified, each output line will begin with it. The returned string is useful for printing only.

dump

$obj->dump();
$obj->dump( $fh );
$obj->dump( $fh, $pfx );

Print a representation of the object to the passed filehandle. If no filehandle is specified, it is printed to the standard output stream. Each output line will begin with $pfx if specified.

fields

@fields = $obj->fields;
@fields = Astro::NED::Response::Object->fields;

This is either a class or an object method. As an object method, it returns a list of fields which had values in the object. As a class method, it returns a list of all possible fields.

data

%data = $obj->data;

This returns the object's data as a hash, keyed off of the field names. Use the accessor methods if possible.

Accessing the data

Acesss to the data is via accessor methods named after the fields returned by NED (e.g. $obj->Name). They take no arguments and return the field values. Data can also be extracted into a hash via the data method.

Fields

The following fields are defined.

No

A sequential object number applicable to this list only.

Name

One of NED's names for the object.

Lat

The latitude of the object, if the output coordinate system is in latitude/longitude.

Lon

The longitude of the object, if the output coordinate system is in latitude/longitude.

RA

The Right Ascension of the object, if the output coordinate system is equatorial.

Dec

The Declination of the object, if the output coordinate system is equatorial.

Type

The NED "Preferred Object Type"

Velocity

The heliocentric redshift as cz, in km/s.

Z

The heliocentric redshift.

VZQual

A qualifier on the redshift.

Distance

The distance, in arcminutes, to the search position or named object position.

NRefs

The number of literature references.

NNotes

The number of catalogue notes.

NPhot

The number of photometric determinations

NPosn

The number of positions.

NVel

The number of velocities.

NAssoc

The number of NED associations.

Images

A URL to an image of the object

InfoLink

A URL to the detailed information on this object.

EXPORT

None by default.

AUTHOR

Diab Jerius, <djerius@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (C) 2003 Smithsonian Astrophysical Observatory. All rights are of course reserved.

It is released under the GNU General Public License. You may find a copy at

http://www.fsf.org/copyleft/gpl.html

SEE ALSO

Astro::NED::Response, Astro::NED::Query, perl.