Skip to content

Commit

Permalink
Document the new correlat parameter of the FitsIDItoMS1 class
Browse files Browse the repository at this point in the history
And fix a typo elsewhere in the documentation while I'm there.
  • Loading branch information
kettenis committed Jun 20, 2017
1 parent e4f7da2 commit baa9ea6
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions msfits/MSFits/FitsIDItoMS.h
Expand Up @@ -118,7 +118,14 @@ class FITSIDItoMS1 : public BinaryTableExtension
public:

//
// The only constructor is from a FitsInput.
// The only constructor is from a FitsInput. The correlat string
// should be set to the correlator name/type as contained in the
// CORRELAT keyword from the FITS-IDI primary header. If it is set
// to "DIFX" (case-sensitive) additional digital corrections
// appropriate for the DiFX software correlator will be applied.
// Other valid values include "VLBA" (for the original VLBA hardware
// correlator; currently unsupported) and "SFXC" (for the SFXC
// software correlator used by the EVN).
//

FITSIDItoMS1(FitsInput& in, const String& correlat, const Int& obsType=0, const Bool& initFirstMain=True);
Expand All @@ -128,7 +135,7 @@ class FITSIDItoMS1 : public BinaryTableExtension
//
// Get the full table, using the supplied arguments to construct
// the table. The table will contain all data from the current
// row to the end of the BinarTableExtension.
// row to the end of the BinaryTableExtension.
//

Table oldfullTable(const String& tabName);
Expand Down

0 comments on commit baa9ea6

Please sign in to comment.