.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. | will give a .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' .\" expand to `' in nroff, nothing in troff, for use with C<>. .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "DSS 3" .TH DSS 3 "2003-07-16" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" Astro::DSS \- An Object Orientated interface to the Digital Sky Survey .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 8 \& $dss = new Astro::DSS( RA => $ra, \& Dec => $dec, \& Target => $object_name, \& Equinox => $equinox, \& Xsize => $x_arcmin, \& Ysize => $y_arcmin, \& Survey => $dss_survey, \& Format => $type ); .Ve .PP .Vb 1 \& my $file_name = $dss->querydb(); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Stores information about an prospective \s-1DSS\s0 query and allows the query to be made, returning a filename pointing to the file returned. .PP The object will by default pick up the proxy information from the \s-1HTTP_PROXY\s0 and \s-1NO_PROXY\s0 environment variables, see the LWP::UserAgent documentation for details. .PP It will save returned files into the \s-1ESTAR_DATA\s0 directory or to \s-1TMP\s0 if the \s-1ESTAR_DATA\s0 environment variable is not defined. .SH "REVISION" .IX Header "REVISION" $Id: \s-1DSS\s0.pm,v 1.7 2003/02/21 18:52:15 aa Exp $ .SH "METHODS" .IX Header "METHODS" .Sh "Constructor" .IX Subsection "Constructor" .IP "\fBnew\fR" 4 .IX Item "new" Create a new instance from a hash of options .Sp .Vb 8 \& $dss = new Astro::DSS( RA => $ra, \& Dec => $dec, \& Target => $object_name, \& Equinox => $equinox, \& Xsize => $x_arcmin, \& Ysize => $y_arcmin, \& Survey => $dss_survey, \& Format => $image_type ); .Ve .Sp returns a reference to an \s-1DSS\s0 query object. .Sh "Accessor Methods" .IX Subsection "Accessor Methods" .IP "\fBquerydb\fR" 4 .IX Item "querydb" Returns a filename of the image returned from a \s-1DSS\s0 query. .Sp .Vb 1 \& $filename = $dss->querydb(); .Ve .IP "\fBproxy\fR" 4 .IX Item "proxy" Return (or set) the current proxy for the \s-1ADS\s0 request. .Sp .Vb 2 \& $query->proxy( 'http://wwwcache.ex.ac.uk:8080/' ); \& $proxy_url = $query->proxy(); .Ve .IP "\fBtimeout\fR" 4 .IX Item "timeout" Return (or set) the current timeout in seconds for the \s-1DSS\s0 request. .Sp .Vb 2 \& $dss->timeout( 30 ); \& $proxy_timeout = $dss->timeout(); .Ve .IP "\fBurl\fR" 4 .IX Item "url" Return (or set) the current base \s-1URL\s0 for the \s-1DSS\s0 query. .Sp .Vb 2 \& $url = $dss->url(); \& $query->url( "archive.eso.org" ); .Ve .Sp if not defined the default \s-1URL\s0 is archive.eso.org .IP "\fBagent\fR" 4 .IX Item "agent" Returns the user agent tag sent by the module to the \s-1ADS\s0 server. .Sp .Vb 1 \& $agent_tag = $dss->agent(); .Ve .IP "\fB\s-1RA\s0\fR" 4 .IX Item "RA" Return (or set) the current target R.A. defined for the \s-1DSS\s0 query .Sp .Vb 2 \& $ra = $dss->ra(); \& $dss->ra( $ra ); .Ve .Sp where \f(CW$ra\fR should be a string of the form \*(L"\s-1HH\s0 \s-1MM\s0 \s-1SS\s0.SS\*(R", e.g. 21 42 42.66 .IP "\fBDec\fR" 4 .IX Item "Dec" Return (or set) the current target Declination defined for the \s-1DSS\s0 query .Sp .Vb 2 \& $dec = $dss->dec(); \& $dss->dec( $dec ); .Ve .Sp where \f(CW$dec\fR should be a string of the form \*(L"+\-HH \s-1MM\s0 \s-1SS\s0.SS\*(R", e.g. +43 35 09.5 or \-40 25 67.89 .IP "\fBEquinox\fR" 4 .IX Item "Equinox" The equinox for the R.A. and Dec co-ordinates .Sp .Vb 2 \& $equinox = $dss->equinox(); \& $dss->equinox( "2000" ); .Ve .Sp defaults to 2000. .IP "\fBTarget\fR" 4 .IX Item "Target" Instead of querying \s-1DSS\s0 by R.A. and Dec., you may also query it by object name. Return (or set) the current target object defined for the \s-1DSS\s0 query, will query \s-1SIMBAD\s0 for object name resolution. .Sp .Vb 2 \& $ident = $dss->target(); \& $dss->target( "HT Cas" ); .Ve .Sp using an object name will override the current R.A. and Dec settings for the Query object (if currently set) and the next \fIquerydb()\fR method call will query \&\s-1DSS\s0 using this identifier rather than any currently set co\-ordinates. .IP "\fBXsize\fR" 4 .IX Item "Xsize" The x extent of the \s-1DSS\s0 image to be retrieved in arcmin. .Sp .Vb 2 \& $xsize = $dss->xsize(); \& $dss->xsize( 20 ); .Ve .Sp Image sizes for \s-1FITS\s0, gzipped \s-1FITS\s0 and \s-1GIF\s0 are 260kB, 110kB and 70 kB respectively for a field of 10*10 arc minutes. There's a limit of around 4 \s-1MB\s0 for the largest image to be delivered. Images from the \s-1DSS2\s0 are bigger, because the pixel size is smaller. .IP "\fBYsize\fR" 4 .IX Item "Ysize" The y extent of the \s-1DSS\s0 image to be retrieved in arcmin. .Sp .Vb 2 \& $xsize = $dss->ysize(); \& $dss->ysize( 20 ); .Ve .Sp Image sizes for \s-1FITS\s0, gzipped \s-1FITS\s0 and \s-1GIF\s0 are 260kB, 110kB and 70 kB respectively for a field of 10*10 arc minutes. There's a limit of around 4 \s-1MB\s0 for the largest image to be delivered. Images from the \s-1DSS2\s0 are bigger, because the pixel size is smaller. .IP "\fBSurvey\fR" 4 .IX Item "Survey" The survey to return .Sp .Vb 2 \& $survey = $dss->survey(); \& $dss->survey( "DSS1" ); .Ve .Sp valid choices are \s-1DSS1\s0, DSS2\-red, DSS2\-blue, DSS2\-infrared. The entire \s-1DSS1\s0 data is stored on magnetic disks at the ESO-ECF Archive. \s-1DSS2\s0 is stored on DVD-ROM in a juke box. Retrieval time takes about less than 5 seconds for a \s-1DSS1\s0 field and less than 20 seconds for a random \s-1DSS2\s0 field in the juke box. .Sp The \s-1DSS1\s0 survey is 100% complete, while the DSS2\-red now covers 98% of the sky; DSS2\-blue 45% of the sky and DSS2\-infrared 27% of the sky. .IP "\fBFormat\fR" 4 .IX Item "Format" The image format required .Sp .Vb 2 \& $format = $dss->format(); \& $dss->format( "FITS" ); .Ve .Sp valid format types are \s-1FITS\s0 and \s-1GIF\s0 and \s-1FITS\s0.gz. The default is to return a \s-1GIF\s0 Image. .Sh "General Methods" .IX Subsection "General Methods" .IP "\fBconfigure\fR" 4 .IX Item "configure" Configures the object, takes an options hash as an argument .Sp .Vb 1 \& $dss->configure( %options ); .Ve .Sp Does nothing if the array is not supplied. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2001 University of Exeter. All Rights Reserved. .PP 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 \s-1GNU\s0 Public License. .SH "AUTHORS" .IX Header "AUTHORS" Alasdair Allan ,