########################################################################
#
#                   NASA/IPAC EXTRAGALACTIC DATABASE             
#         Batch Job Request Help File for Search by Parameters 
#                      Form date: 9 March 2005 
#
# This is a detailed description of the input data format for NED's 
#    Batch Search-by-Parameters functions.
#
#             >>>>>   Please send us your comments.   <<<<<
#
########################################################################
#
#                            General comments
#
# There is another batch form that you may use for data searches 
#    constrained by object name or reference code.  The present form 
#    should be used for searches constrained by various parameters 
#    (equatorial or Galactic coordinates, redshift, object type, or 
#    name prefix).
#
# The abbreviated template batch request forms can be filled in by you 
#    and submitted by e-mail to the NED batch processor.  Those forms 
#    are shorter than these fully-commented forms, though these longer 
#    forms are also accepted by the batch processor.
#
# If you retype any of the UPPER_CASE commands listed in the template 
#    request form, be aware that they must be correctly reproduced in 
#    their upper case format.  If these commands are not in UPPER_CASE 
#    letters, the batch processor will reject your request.
# 
# Blank lines and lines beginning with the `#' symbol are ignored.
#
# Please make sure that your files contain only flat (7-bit) ASCII 
#    characters, i.e. no special control characters.  In particular, 
#    line-feed/carriage-return characters from MS-DOS and MS-Windows 
#    formatted files will confuse the batch processor.
#
# Please also note that batch request files must have lines shorter
#    than 72 characters, and that they may NOT have email "attachments"
#    of any kind.
#
# Any given batch request file may contain several types of searches,
#    but the present processor supports a MAXIMUM OF 3000 REQUESTS PER 
#    INPUT FILE.  A single request (e.g. for all B3 radio sources) may 
#    give an output of many thousands of objects, however.  
#
# If a request yields more than 10,000 objects, NED will send you a 
#    message asking you to resubmit the job in smaller batches.
#
# To formulate a request, edit the Batch Job Template For Search by
#    Parameters Request Form by either accepting or changing the 
#    suggested defaults, and by supplying the information needed for 
#    the individual searches.
# 
# Once your request file is filled in, e-mail it to 
# 
#      >>>>>>>>    nedbatch@ipac.caltech.edu    <<<<<<<<
# 
# Batch jobs are normally run every fifteen minutes.  Thus, you may 
# usually retrieve your results via FTP within half an hour of 
# submitting your job.  During times of heavy usage, large batch jobs 
# may take longer to run.  In any case, NED will send you a notice via 
# email when your job has run and is ready to be retrieved.
 
########################################################################
#
# There are three distinct sections that you will need to fill in.
# 
# 1) OUTPUT FILE NAME, FORMAT, and COMPRESSION SCHEME.
#
#    a) OUTPUT_FILENAME
#
#       Here you need to specify a filename into which the search 
#       results will be written by the NED batch processor.  This file 
#       will be written on our local machine, and you may retrieve it 
#       via FTP.
#
#       The filename may be any reasonable number of characters in 
#       length.  If it duplicates a filename already in use, the batch 
#       processor will add a suffix to it.  If you don't specify a 
#       filename, the processor will assign one for you.  The return 
#       e-mail message will tell you the file name and file size.
#
#    b) OUTPUT_OPTION
#
#       NED has three output formats:  `standard', `compact', or 
#       `compact_2'.  The standard form is longer with more information 
#       on each object.  The two compact forms include only some 
#       essential information for each object.  The default is standard,
#       but either of the compact forms may give you the information 
#       you need.  We suggest you try short jobs with different output 
#       formats to see which one will suit your needs.
#
#    c) COMPRESS_OPTION
#
#       If you wish to compress your output file, NED can use two 
#       compression formats:  UNIX `compress' or GNU `gzip'.  The 
#       respective output files will have a suffix `.Z' or `.gz' 
#       appended. You will need to use the UNIX `uncompress' command to
#       uncompress `.Z' files, or the GNU `gunzip' command to uncompress
#       `.gz' files.  If you do not want to compress your output, choose
#       the default option `none'.
#
# 2) ENVIRONMENT PARAMETERS.  
#
#    These are Global Flags, adopted by default or specified by you, 
#       which remain unchanged during processing of a single batch job. 
#
# 3) REQUESTS. 
#
#    Using this form, you may only set up a search by parameters:  
#       Equatorial and/or Galactic coordinates, heliocentric redshift, 
#       object type, or name prefix.
#
#    The other NED batch form allows the following searches:
#
#       a) Find objects by their name:        FIND_OBJECTS_BY_NAME
#       b) Find objects near a name:          FIND_OBJECTS_NEAR_NAME
#       c) Find objects near a position:      FIND_OBJECTS_NEAR_POSITION
#       d) Find objects by IAU-style name:    FIND_OBJECTS_BY_IAU_NAME
#       e) Find objects by reference code:    FIND_OBJECTS_BY_REFCODE
#       f) Find details for a refcode:        FIND_REFCODE_DETAIL
#       g) Find references for an object:     FIND_REFERENCES
#       h) Find photometry for an object:     FIND_PHOTOMETRIC_DATA
#       i) Find position data for an object:  FIND_POSITION_DATA
#       j) Find redshift data for an object:  FIND_REDSHIFT_DATA

########################################################################
#
#                       DETAILED INSTRUCTIONS
#
# Here is an example batch job form with notes on filling it out.
#
########################################################################
# 
#           SET OUTPUT FILE NAME, FORMAT AND COMPRESSION SCHEME
#
# Replace the x's on the next line with an OUTPUT FILENAME of your 
#    choosing.

OUTPUT_FILENAME   xxxxxx

# Choose an output format:  `standard' (default), `compact', 
#    or `compact_2'

OUTPUT_OPTION    standard

# Choose a compression method:  `compress', `gzip', `none' (default)

COMPRESS_OPTION    none

########################################################################
#
#                    SET GLOBAL ENVIRONMENT PARAMETERS
#
# Change (or adopt the given defaults for) the ENVIRONMENT PARAMETERS:
#
#    Choose from among the following coordinate systems:  
#
#    `equatorial', `galactic', `ecliptic', `super_galactic' 
#
#    One for the INPUT coordinate system:

INPUT_COORDINATE_SYSTEM       equatorial

#    and another for the OUTPUT coordinate system

OUTPUT_COORDINATE_SYSTEM      equatorial

# If your INPUT coordinate system is EQUATORIAL or ECLIPTIC, choose an 
#    equinox between 1500 and 2500, with J or B prefix

INPUT_EQUINOX                 J2000.0

# If your OUTPUT coordinate system is EQUATORIAL or ECLIPTIC, choose an 
#    equinox between 1500 and 2500, with J or B prefix

OUTPUT_EQUINOX                J2000.0

# Here, you may change the field used to sort the output by choosing one
#    of the following two options:
#
#       `RA_or_Longitude', `DEC_or_Latitude'
#
# If you choose `RA_or_Longitude', NED will sort the object list in 
#    increasing RA or Longitude order.
#
# If you choose `DEC_or_Latitude', NED will sort the object list in 
#    decreasing DEC or Latitude order.

OUTPUT_SORTED_BY      RA_or_Longitude

# Supply the velocity (km/s) value above which dimensionless z is 
#    displayed.

REDSHIFT_VELOCITY     10000.0

########################################################################
#
#                          SEARCH BY PARAMETERS
#
# This form allows you to search for objects in NED by various 
#    parameters.
#
# Specify any combination of constraints on the following parameters:
#   (1)  Position in Equatorial Coordinates in the J2000 system,
#   (2)  Position in Galactic Coordinates,
#   (3)  Redshift in a Heliocentric frame of reference,
#   (4)  Type of Object (QSO, galaxy, radio source, etc),
#   (5)  Name Prefix.
# Any of the parameters above may be constrained or bypassed.
# Constraints may be combined with AND operators.
#
# Copy this entire PARAMETER block for multiple searches.

FIND_OBJECTS_BY_PARAMETERS

#-----------------------------------------------------------------------
#              Constrain by J2000.0 Equatorial Coordinates
#
# Remove the leading `#' and spaces, and replace `ra1,2' and `dec1,2' 
#    with your desired values.  Use either `DEC_between' OR 
#    `DEC_not_between', not both.  You may use any of the coordinate 
#    formats (e.g. decimal degrees, sexagesimal notation) recognized by
#    NED.  If you use sexagesimal notation, we recommend specifying the
#    units explicitly, as in
#
#                00h00m00.0s      and       +00d00m00s
#    or
#                00h00.0m         and       +00d00m
#    and so forth.
#
#    In this example, a search is set up to return nearby radio 
#    sources, infrared sources, and QSOs in the Virgo Cluster area.

     RA_between            12h,  13h
     DEC_between           +6d,  +18d
#    DEC_not_between       dec1, dec2

#-----------------------------------------------------------------------
#                   Constrain by Galactic Coordinates
#
# Remove the leading `#' and spaces and replace `glon1,2' and `glat1,2'
#    with your desired values.  Use either `GLAT_between' OR 
#    `GLAT_not_between', not both.

#    GLON_between          glon1, glon2
#    GLAT_between          glat1, glat2
#    GLAT_not_between      glat1, glat2
 
#-----------------------------------------------------------------------
#                         Constrain by Redshift
# Choices:      
#    REDSHIFT   Unconstrained
#    REDSHIFT   Available
#    REDSHIFT   Unavailable
#    REDSHIFT   Larger_than  x
#    REDSHIFT   Less_than    x
#    REDSHIFT   Between      x, y
#    REDSHIFT   Not_between  x, y

REDSHIFT   Between -500, +3000

# Now select a UNIT for the lower and upper limits x and y:
#    UNIT    z
#    UNIT    km/s

UNIT    km/s

#-----------------------------------------------------------------------
#                        Constrain by Object Type
# Choices:      
#    INCLUDE: INCLUDE objects with ANY object types marked by `X'
#             or 
#    INCLUDE ALL: INCLUDE objects with ALL object types marked by `X' 
#             and
#    EXCLUDE: EXCLUDE objects with ANY object types marked by `X'
#
#    Replace `_' by `X' or `x' to mark the object types to be included 
#    or excluded.  If none is marked, there is no constraint on object 
#    type.

INCLUDE
# INCLUDE ALL
 Galaxies x  Clusters _   Supernovae _  QSO _  AbsLineSys _  GravLens _
 Radio _     Infrared X   EmissnLine _  UVExcess _   Xray _  GammaRay _
END_INCLUDE

EXCLUDE
 Galaxies _  Clusters _   Supernovae _  QSO _  AbsLineSys _  GravLens _
 Radio _     Infrared _   EmissnLine _  UVExcess _   Xray _  GammaRay _
END_EXCLUDE

#-----------------------------------------------------------------------
#                        Constrain by Name Prefix
# Choices:
#    Put name prefixes (e.g. `UGC', `IRAS', `87GB') between the PREFIX 
#    or PREFIX ALL and END_PREFIX lines. One prefix per line please.
#
#    PREFIX: Objects with ANY of the prefixes provided.
#    PREFIX ALL: Objects with ALL of the prefixes provided.
#    You can see the current list of available name prefixes during 
#    an interactive NED session.

PREFIX
#PREFIX ALL

END_PREFIX

#-----------------------------------------------------------------------

END_OF_DATA

# END_OF_DATA signals the end of a single search request.  For another
#    search, copy the entire `Search by Parameters' section above, add
#    it to the form just after the END_OF_DATA line, and replace the 
#    parameters with others as needed.

########################################################################

END_OF_REQUESTS

# END_OF_REQUESTS signals the end of all data input in this batch 
#    session.