edu.nrao.sss.model.source.parser
Class VlbaSourceCatalogReader

java.lang.Object
  edu.nrao.sss.model.source.parser.AbstractSourceCatalogReader
      edu.nrao.sss.model.source.parser.VlbaSourceCatalogReader

All Implemented Interfaces:

SourceCatalogReader

public class VlbaSourceCatalogReader
extends AbstractSourceCatalogReader

A reader of source catalog text files in VLBA format.

Format (starting 2007-11-24 & tweaked 2008-06-19)

  Field    1:10   A10   IAU name (J2000)
  Field   13:20   A8    IVS name (B1950)
  Field   23:24   I2    Right ascension (hr)
  Field   26:27   I2    Right ascension (min)
  Field   29:37   F9.6  Right ascension (sec)
  Field   40:42   I3    Declination (deg)
  Field   44:45   I3    Declination (min)
  Field   47:54   F8.5  Declination (sec)
  Field   57:61   F5.2  Inflated E/W position error (mas) 
  Field   63-67   F5.2  Inflated N/S position error (mas) 
  Field   69-73   F5.2  X-band total flux density integrated over entire map (Jy) or -1.00 if no data are available
  Field   75-79   F5.2  X-band unresolved flux density at long VLBA baselines (Jy) or -1.00 if no data are available
  Field   81-85   F5.2  S-band total flux density integrated over entire map (Jy) or -1.00 if no data are available
  Field   87:91   F5.2  S-band unresolved flux density at long VLBA baselines (Jy) or -1.00 if no data are available

  Missing value: -1.0 (often below detection level)

  Field   94:94   A1    Category: C (calibrator), N (non-calibrator), U (unreliable coordinates)
                        C=acceptable calibrator to be used for most VLBA observations;
                        N=Non-calibrator that may be too weak or resolved and should be tested before use;
                        U=Non-calibrator with poor position determination.
                        K=Acceptable at 23 GHz.
  Field   96:99   A4    Original catalogue name: 
                        VCS1,2,3,4,5:  Original VCS surveys
                        ICRF: ICRF observers
                        2007: Contains VCS6, polar cap survey
                        2008: Latest additions, mostly in south
                        VERA: Sources from VERA/VLBA galactic plane surveys
 

Example

  J0000+8141  2355+814  00h00m17.266431s +81d41'36.52552" 57.33 19.57 -1.00 -1.00 -1.00 -1.00  U-2007
  J0000-3221  2357-326  00h00m20.399946s -32d21'01.23315"  0.52  1.14  0.21  0.09  0.50  0.34  C-VCS2
  J0000+4054  2358+406  00h00m53.081556s +40d54'01.79452"  1.80  2.19  0.25  0.05  1.00  0.12  C-VCS1
  J0001-1551  2358-161  00h01m05.328768s -15d51'07.07599"  0.51  0.96  0.28  0.12  0.43  0.25  C-VCS1
 

Format (prior to 2007-11-24)

  Field    1:1    A1    Category: C (calibrator), N (non-calibrator), U (unreliable coordinates)
                                  K (possible VERA 22 GHz calibrator)
  Field    4:11   A8    IVS name (B1950)
  Field   13:22   A10   IAU name (J2000.0)
  Field   25:26   I2    Right ascension: hours
  Field   28:29   I2    Right ascension: minutes
  Field   31:39   F9.6  Right ascension: seconds
  Field   41:43   I3    Declination: degrees
  Field   45:46   I3    Declination: minutes
  Field   48:57   F8.5  Declination: seconds
  Field   58:63   F6.2  Inflated error in right ascension in mas
  Field   65:70   F6.2  Inflated error in declination in mas
  Field   73:78   F6.3  Correlation between right ascension and declination
  Field   80:85   I6    Number of observations used
  Field   88:88   A1    Blank or < or - for X-band total flux density integrated over entire map
  Field   89:92   F4.2  X-band total flux density integrated over entire map, Jy or n/a if no data are available
  Field   94:94   A1    Blank or < or - for X-band unresolved flux density at VLBA baselines, Jy
  Field   95:98   F4.2  X-band unresolved flux density at long VLBA baselines, Jy or n/a if no data are available
  Field  101:101  A1    Blank or < or - for S-band total flux density integrated over entire map
  Field  102:105  F4.2  S-band total flux density integrated over entire map, Jy or n/a if no data are available
  Field  107:107  A1    Blank or < or - for S-band unresolved flux density at VLBA baselines
  Field  108:111  F4.2  S-band unresolved flux density at long VLBA baselines, Jy or n/a if no data are available
  Field  114:116  A3    Used Band (type_: X, S, X/S. K
  Field  119:122  A4    Catalogue name
  Field  124:124  A1    Modification code: a=added in this version
                                           r=remove from this version
                                           m=modified in this version
  Field  125:134  A8    Date of change (YYYY.MM.DD)

Example

  C  2357-326 J0000-3221  00 00 20.399949 -32 21 01.23320    0.60   1.11   0.028     40   0.14  0.08   0.48  0.35  X/S  VCS2          
  C  2358+406 J0000+4054  00 00 53.081537 +40 54 01.79341    2.36   2.13  -0.162     22   0.25  0.05   1.00  0.12  X/S  VCS1          
  C  2358-161 J0001-1551  00 01 05.328763 -15 51 07.07576    0.51   0.92  -0.757     58   0.28  0.12   0.43  0.25  X/S  VCS1          
  C  1038+52B J1041+523B  10 41 48.897635 +52 33 55.60815    0.79   0.57  -0.355     84  -1.00 -1.00  -1.00 -1.00  X/S  ICRF r2007.06.14
 

Version Info:

$Revision: 1552 $

$Date: 2008-09-15 16:16:57 -0600 (Mon, 15 Sep 2008) $

$Author: dharland $ (last person to modify)

Since:

2007-06-15

Author:

David M. Harland

Field Summary

Fields inherited from class edu.nrao.sss.model.source.parser.AbstractSourceCatalogReader

catalog, errors, histRecPrefix, readWasSuccessful, sourceInfoOrigin

Constructor Summary

VlbaSourceCatalogReader()
Creates a new instance.

Method Summary

List<Source>	getAddedSources() Returns a list of sources that were marked with the "add" modification code and whose effective dates were on or after that sent to the read method.
List<Source>	getModifiedSources() Returns a list of sources that were marked with the "modified" modification code and whose effective dates were on or after that sent to the read method.
List<Source>	getRemovedSources() Returns a list of sources that were marked with the "removed" modification code and whose effective dates were on or after that sent to the read method.
boolean	read(Reader in, SourceCatalog destination) NOTE: This method closes the incoming Reader!
boolean	read(Reader in, SourceCatalog destination, String earliestDate) Reads data from in and uses it to add sources to destination.

Methods inherited from class edu.nrao.sss.model.source.parser.AbstractSourceCatalogReader

getCatalog, getError, getErrorCount, getErrors, getOriginOfSourceInformation, getPrefixForHistoricalRecords, getSuccess, putError, read, read, read, read, read, read, read, setOriginOfSourceInformation, setPrefixForHistoricalRecords

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VlbaSourceCatalogReader

public VlbaSourceCatalogReader()

Creates a new instance.

Method Detail

read

public boolean read(Reader in,
                    SourceCatalog destination)

NOTE: This method closes the incoming Reader!

Specified by:

read in interface SourceCatalogReader

Specified by:

read in class AbstractSourceCatalogReader

Parameters:

in - the source of text that can be read and turned into Source objects.

destination - the catalog to which the sources should be added. If this parameter is null, a new catalog will be created.

Returns:

true if nothing unexpected occurred while reading data.

See Also:

AbstractSourceCatalogReader.read(java.io.Reader, edu.nrao.sss.model.source.SourceCatalog)

read

public boolean read(Reader in,
                    SourceCatalog destination,
                    String earliestDate)

Reads data from in and uses it to add sources to destination.

Note that all sources in the reader are placed in the destination catalog, no matter what the modification code and date of change values are. Some clients may want to work only with those sources with modification codes. In that situation the following list methods may be used: getAddedSources(), getModifiedSources(), and getRemovedSources().

Parameters:

in - the source of text that can be read and turned into Source objects. This method closes this reader when it has finished with it.

destination - the catalog to which the sources should be added. If this parameter is null, a new catalog will be created.

earliestDate - text representation of a date in form yyyymmdd. A source with a modification code and an effective date on or after this date will be remembered and can be accessed via the getAddedSources(), getModifiedSources(), and getRemovedSources() methods.

Returns:

true if nothing unexpected occurred while reading data.

getAddedSources

public List<Source> getAddedSources()

Returns a list of sources that were marked with the "add" modification code and whose effective dates were on or after that sent to the read method. The returned list is guaranteed not to be null, but it may be empty.

getModifiedSources

public List<Source> getModifiedSources()

Returns a list of sources that were marked with the "modified" modification code and whose effective dates were on or after that sent to the read method. The returned list is guaranteed not to be null, but it may be empty.

getRemovedSources

public List<Source> getRemovedSources()

Returns a list of sources that were marked with the "removed" modification code and whose effective dates were on or after that sent to the read method. The returned list is guaranteed not to be null, but it may be empty.