######################################################################## # # NASA/IPAC EXTRAGALACTIC DATABASE # Batch Job Request Help File # Form date: 5 September 2008 # # Blank lines or those beginning with a pound sign (#) are ignored. # # PLEASE BE SURE THAT YOUR FILE CONTAINS ONLY FLAT (7-BIT) ASCII # CHARACTERS, HAS NO MORE THAN 72 CHARACTERS PER LINE, HAS NO # EMAIL ATTACHMENTS, IS NOT AN HTML-FORMATTED FILE, AND HAS NO # MORE THAN 3000 INPUT REQUESTS. ALSO, BE SURE YOUR EMAIL # SUBMISSION INCLUDES A SUBJECT LINE "NED Batch Form". # # Here is a description of the input data format for NED's batch search # functions. # # >>>>> Please send us your comments. <<<<< # ######################################################################## # # General comments # # There is another batch form that you may use for searches constrained # by various parameters (equatorial or Galactic coordinates, # redshift, object type, or name prefix). You may use the present # form to obtain data for specific objects, or for literature and # data for those objects. # # 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. HTML-formatted files will also be rejected by the # batch processor. # # 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 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 Request Form by # either accepting or changing the suggested defaults, and by # supplying the names, positions, search radii and/or dates, as # 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 four distinct sections that you need to fill in: # # 1) OUTPUT FILE NAME AND FORMAT. # # 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) DEFAULT SEARCH PARAMETERS. # # These are the values used by NED when you do not explicitly put the # corresponding parameters into an individual batch request. # # 4) REQUESTS. # # Ten different searches are possible: # # 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 AND FORMAT # # 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 # # Choose 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 # You may change the Extended Name Search default here. If the # EXTENDED_NAME_SEARCH flag is `no', name searches return only exact # matches to object names as entered. If the EXTENDED_NAME_SEARCH # flag is `yes' (the default), then searches also return names # derived from the name as entered, including those names with # additional suffixes. EXTENDED_NAME_SEARCH yes # You may sort your output in one of the following ways: # # `Distance_to_search_center', `RA_or_Longitude', `DEC_or_Latitude' # # If you choose `Distance_to_search_center', NED will sort the object # list according to the radial distance between the object found and # the search center, in increasing order. This is the default. # # 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 Distance_to_search_center # Supply the velocity (km/s) value above which dimensionless z is # displayed. The default is 10000.0 km/s. REDSHIFT_VELOCITY 10000.0 ######################################################################## # # DEFAULT VALUES # # Change or accept DEFAULT SEARCH PARAMETERS: # # For repeated calls to the same search option, the NED batch processor # will, by default, adopt the latest input value in your list of # objects. If you do not explicitly input any values, NED adopts # the following defaults: # # The search radius is set to 2 arcminutes, and must be less than 300 # arcminutes. SEARCH_RADIUS 2 # The years which NED searches for literature references must be between # 1900 and the current year. BEGIN_YEAR 1900 END_YEAR 2005 # IAU-style name interpretation: `S' for strict interpretation or `L' # for liberal interpretation. The strict interpretation adopts a # smaller search radius than the liberal interpretation; both # depend on the number of significant figures given in the IAU-style # name. IAU_STYLE S ######################################################################## # # SEARCH REQUESTS # # This form allows you to do ten different types of searches. You may # use any or all of the following types of searches within a single # email message. # # Search by Object Name FIND_OBJECTS_BY_NAME # Search Near Object Name FIND_OBJECTS_NEAR_NAME # Search Near Position FIND_OBJECTS_NEAR_POSITION # Search by IAU Designation FIND_OBJECTS_BY_IAU_NAME # Search for Objects by Reference Code FIND_OBJECTS_BY_REFCODE # Search for Full Reference by Refcode FIND_REFCODE_DETAIL # Search for References by Object Name FIND_REFERENCES # Search for Photometry by Object Name FIND_PHOTOMETRIC_DATA # Search for Position data for an object FIND_POSITION_DATA # Search for Redshift data for an object FIND_REDSHIFT_DATA # #----------------------------------------------------------------------- # SEARCH BY OBJECT NAME # # The only input expected is a name. Multiple name searches should be # entered one per line. Input will be checked by NED's Name # Interpreter, as in the interface; `legal' input on the interactive # NED interface is `legal' here as well. # # The following example searches for two objects. Replace the names # with those of your objects of interest. FIND_OBJECTS_BY_NAME ngc 1 ugc 10143 END_OF_DATA # The END_OF_DATA flag signals the end of input data for your # FIND_OBJECTS_BY_NAME Request. #----------------------------------------------------------------------- #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # # For object searches NEAR_NAME, NEAR_POSITION, BY_IAU_NAME, you may put # constraints on redshift and/or object types. # # Redshift constraints: # # REDSHIFT Unconstrained # REDSHIFT Available # REDSHIFT Unavailable # REDSHIFT Larger_than x # REDSHIFT Less_than x # REDSHIFT Between x, y # REDSHIFT Not_between x, y # Then select a UNIT for the lower and upper limits x and y: # UNIT z # UNIT km/s # # Object type constraints: # # 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. # #----------------------------------------------------------------------- # # SEARCH NEAR OBJECT NAME # # The expected input is an object name and a search radius (in arcmin). # These should be separated by a semicolon `;' or comma `,'. Input # only one pair of elements (name; radius) per line. If no search # radius is given for an object, the radius for the previous object # will be used. If the first object does not have a search radius # specified, the default value which you set above (2 arcmin in this # example file) will be used. This example will return all objects # within 15 arcmin of UGC 10143. FIND_OBJECTS_NEAR_NAME ugc 10143; 15 # Constrain your search by redshift or object type, if you wish. REDSHIFT Unconstrained UNIT z INCLUDE # INCLUDE ALL Galaxies _ GClusters _ Supernovae _ QSO _ AbsLineSys _ GravLens _ Radio _ Infrared _ EmissnLine _ UVExcess _ Xray _ GammaRay _ GPairs _ GTriples _ GGroups _ END_INCLUDE EXCLUDE Galaxies _ GClusters _ Supernovae _ QSO _ AbsLineSys _ GravLens _ Radio _ Infrared _ EmissnLine _ UVExcess _ Xray _ GammaRay _ GPairs _ GTriples _ GGroups _ END_EXCLUDE END_OF_DATA # The END_OF_DATA flag signals the end of the input data for your # FIND_OBJECTS_NEAR_NAME request. #----------------------------------------------------------------------- # # SEARCH NEAR POSITION # # The input expected here is RA (or longitude), DEC (or latitude), and # search radius (in arcmin). There should only be one entry per # line, with the values separated by semicolons `;' or commas `,'. # If any of the three values is not given, the corresponding value # from the previous entry will be used. The coordinates entered # here are taken to be in the system specified in the Global # Environment Parameters Section above. # # The following example will return all objects which are both # `Galaxies' and `Infrared' sources within 34 arcmin of the position # 03h 04m 55s; 46d 35m. FIND_OBJECTS_NEAR_POSITION 3h4m55s; 46d35m; 34 REDSHIFT Unconstrained UNIT z # INCLUDE INCLUDE ALL Galaxies X GClusters _ Supernovae _ QSO _ AbsLineSys _ GravLens _ Radio _ Infrared X EmissnLine _ UVExcess _ Xray _ GammaRay _ GPairs _ GTriples _ GGroups _ END_INCLUDE EXCLUDE Galaxies _ GClusters _ Supernovae _ QSO _ AbsLineSys _ GravLens _ Radio _ Infrared _ EmissnLine _ UVExcess _ Xray _ GammaRay _ GPairs _ GTriples _ GGroups _ END_EXCLUDE END_OF_DATA # The END_OF_DATA flag signals the end of the input data for your # FIND_OBJECTS_NEAR_POSITION request. #----------------------------------------------------------------------- # # SEARCH BY IAU DESIGNATION # # The input expected here is an IAU-type name and style (Strict or # Liberal). NED automatically calculates the appropriate search # window and center. The `Strict' interpretation of the name # searches a smaller area than does the `Liberal' interpretation. # Only one entry per line is allowed, with values separated by a # semicolon `;' or comma `,'. If either of the two values is not # given, the value from the previous entry will be used. # # The following example is a search request at given IAU name # 15588+1553 with the strict IAU name interpretation. This will # search for NED objects within 1.0 arcmin of 15h58m51s, +15d53.5m. # A liberal interpretation request would lead to a search for # objects within 2.0 arcmin of 15h58m49.5s +15d53m15s. FIND_OBJECTS_BY_IAU_NAME 15588+1553; S REDSHIFT Unconstrained UNIT z INCLUDE # INCLUDE ALL Galaxies _ GClusters _ Supernovae _ QSO _ AbsLineSys _ GravLens _ Radio _ Infrared _ EmissnLine _ UVExcess _ Xray _ GammaRay _ GPairs _ GTriples _ GGroups _ END_INCLUDE EXCLUDE Galaxies _ GClusters _ Supernovae _ QSO _ AbsLineSys _ GravLens _ Radio _ Infrared _ EmissnLine _ UVExcess _ Xray _ GammaRay _ GPairs _ GTriples _ GGroups _ END_EXCLUDE END_OF_DATA # END_OF_DATA signals the end of input for the FIND_OBJECTS_BY_IAU_NAME # request. #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #----------------------------------------------------------------------- # # SEARCH FOR OBJECTS BY REFERENCE CODE # # The input expected for this search is a 19-digit reference code. The # following example search request will return all the objects in NED # that are related to the reference code `1994A&A...281..681S'. FIND_OBJECTS_BY_REFCODE 1994A&A...281..681S END_OF_DATA # END_OF_DATA signals the end of input for the FIND_OBJECTS_BY_REFCODE # request. #----------------------------------------------------------------------- # # SEARCH FOR FULL REFERENCE BY REFERENCE CODE # # The only input expected here is the NED 19-digit reference code. # The following example search request will return the detailed # information (title, author(s), full reference) for the reference # code `1994A&A...281..681S'. FIND_REFCODE_DETAIL 1994A&A...281..681S END_OF_DATA # END_OF_DATA signals the end of input for the FIND_REFCODE_DETAIL # request. #----------------------------------------------------------------------- # # SEARCH FOR REFERENCES BY OBJECT NAME # # The input expected is object_name; begin_year; end_year. There is one # entry per line, with the values separated by a semicolon `;' or # comma `,'. If you do not provide either begin_year or end_year, # the value of the previous entry will be used. If you do not # specify a range of years in the first entry, the DEFAULT values # will be used. The following example search request will return # all references to UGC 10143 for the years 1950 to 1980, inclusive. FIND_REFERENCES ugc 10143; 1950; 1980 END_OF_DATA # END_OF_DATA signals the end of input for the FIND_REFERENCES Request. #----------------------------------------------------------------------- # # SEARCH FOR PHOTOMETRY BY OBJECT NAME # # The only input expected is the object_name. One entry is allowed per # line. The following example search request will return all the # photometric data in NED for NGC 0001. FIND_PHOTOMETRIC_DATA ngc 1 END_OF_DATA # END_OF_DATA signals the end of input for the FIND_PHOTOMETRIC_DATA # Request. #----------------------------------------------------------------------- # # SEARCH FOR POSITION DATA BY OBJECT NAME # # The only input expected is the object_name. One entry is allowed per # line. The following example search request will return all the # position data in NED for NGC 0001. FIND_POSITION_DATA ngc 1 END_OF_DATA # END_OF_DATA signals the end of input for the FIND_POSITION_DATA # Request. #----------------------------------------------------------------------- # # SEARCH FOR REDSHIFT DATA BY OBJECT NAME # # The only input expected is the object_name. One entry is allowed per # line. The following example search request will return all the # redshift data in NED for NGC 0001. FIND_REDSHIFT_DATA ngc 1 END_OF_DATA # END_OF_DATA signals the end of input for the FIND_REDSHIFT_DATA # Request. #----------------------------------------------------------------------- ######################################################################## END_OF_REQUESTS # END_OF_REQUESTS signals the end of all data input in this batch # session.