NAME

Astro::NED::Query::NearPosition - query NED for objects near a specified position

SYNOPSIS

  use Astro::NED::Query::NearPosition;

  $req = Astro::NED::Query::NearPosition->new( Field => value, ... );

  $req->Field( $value );

  # for fields which take multiple values
  $req->Field( $value1 => $state );
  $req->Field( $value2 => $state );

  $objs = $req->query;

DESCRIPTION

This class queries NED using the "Objects Near Position" interface. It is a subclass of Astro::NED::Query, and thus shares all of its methods.

Class specific details are provided here. See Astro::NED::Query for general information on the class methods (including those not documented here) and how to set or get the search parameters.

Methods

new

  $req = Astro::NED::Query::NearPosition->new( keyword1 => $value1,
                                   keyword2 => $value2, ... );

Queries are constructed using the new method, which is passed a list of keyword and value pairs. The keywords may be the names of single valued query parameters.

Fields which may have mutiple concurrent values (such as IncObjType) cannot be specified in the call to new; use the field accessor method, and specify the value and whether it should be selected or not:

  $req->IncObjType( 'Galaxies' => 1 )
  $req->IncObjType( 'XRay' => 1 )

Search parameters may also be set or queried using the accessor methods; see Astro::NED::Query.

query

  $res = $req->query;

The query method returns an instance of the Astro::NED::Response::Objects class, which contains the results of the query. At present it returns only the summary table, not the detailed information on each object. See Astro::NED::Response::Object for more info.

If an error ocurred an exception is thrown via croak.

Search Parameters

Please note that for fields which take specific enumerated values, the values are often not those which are displayed by a web browser. It's best to initially use the possible_values method to determine acceptable values. Usually it's pretty obvious what they correspond to.

InCoordSys

The input coordinate system. Use the possible_values method to determine which ones are available.

InEquinox

The input coordinate system equinox.

Longitude

The longitude of the search position, if applicable. (Internally this is the same as the RA field.)

Latitude

The latitude of the search position, if applicable. (Internally this is the same as the Dec field.)

RA

The Right Ascension of the search position, if applicable. (Internally this is the same as the Longitude field.)

Dec

The Declination of the search position, if applicable. (Internally this is the same as the Latitude field.)

Radius

The search radius in arcminutes

OutCoordSys

The output coordinate system. Use the possible_values method to determine which ones are available.

OutEquinox

The output coordinate system equinox.

Sort

The output sort order. Use the possible_values method to determine which ones are available.

Format

Whether the output is formatted as an HTML table or plain text. This will always be forced to HTML.

ListLimit

The upper limit to the number of objects with detailed information. This is always set to force no detailed information

ZVBreaker

The maximum redshift velocity which will be displayed as km/s.

ImageStamp

Whether or not to return an image preview. Always forced off.

ZConstraint

Constraints on the redshifts of the objects. Used in conjunction with the ZValue1 and ZValue2 fields.

Use the possible_values method to determine which constraints are available.

ZValue1, ZValue2

Values for the redshift constraints.

ZUnit

Either km/s or z.

ObjTypeInclude

Whether to objects must have ANY or ALL of the types in the IncObjType field. Takes the values ANY or ALL.

IncObjType

This specifies the types of objects to include. This is a multi-valued field, meaning that it can hold more than one type of object concurrently. As such, it cannot be initialized in the object constructor. The accessor method must be used instead:

  $obj->IncObjType( Galaxies => 1 );
  $obj->IncObjType( GPairs => 1 );

Use the possible_values method to determine which object types are available.

ExcObjType

This specifies the types of objects to exclude. This is a multi-valued field, meaning that it can hold more than one type of object concurrently. As such, it cannot be initialized in the object constructor. The accessor method must be used instead:

  $obj->ExcObjType( Galaxies => 1 );
  $obj->ExcObjType( GPairs => 1 );

Use the possible_values method to determine which object types are available.

NamePrefixOp

This specifies how to handle objects with name prefixes specified with the NamePrefix field. This is so complicated there's an extra documentation link on the NED site, so I suggest you look there: http://nedwww.ipac.caltech.edu/help/object_help.html#exclcat.

Use the possible_values method to determine which object types are available.

NamePrefix

This specifies the types of name prefix used with NamePrefixOp. This is a multi-valued field, meaning that it can hold more than one type of object concurrently. As such, it cannot be initialized in the object constructor. The accessor method must be used instead:

  $obj->NamePrefix( ABELL => 1 );
  $obj->NamePrefix( 'ABELL S' => 1 );

Use the possible_values method to determine which prefixes are available.

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::Query, Astro::NED::Response::Objects, Astro::NED::Response::Object, perl.