help() [1/2]

void datrw::iasciistream::help ( std::ostream &  os = std::cout )

static

Definition at line 578 of file iasciistream.cc.

References DATRW_IASCIISTREAM_CC_VERSION, datrw::ascii::anonymous_namespace{iasciistream.cc}::explainmodifier(), datrw::ascii::anonymous_namespace{iasciistream.cc}::explainmodifierflag(), datrw::ascii::keyauxid, datrw::ascii::keycalib, datrw::ascii::keycalper, datrw::ascii::keychannel, datrw::ascii::keydata, datrw::ascii::keydate, datrw::ascii::keydouble, datrw::ascii::keydt, datrw::ascii::keyfloat, datrw::ascii::keyhang, datrw::ascii::keyinstype, datrw::ascii::keyint, datrw::ascii::keynonfatal, datrw::ascii::keynsamples, datrw::ascii::keynstacks, datrw::ascii::keyRECVCS, datrw::ascii::keyRECVX, datrw::ascii::keyRECVY, datrw::ascii::keyRECVZ, datrw::ascii::keySRCECS, datrw::ascii::keySRCEdate, datrw::ascii::keySRCEtype, datrw::ascii::keySRCEX, datrw::ascii::keySRCEY, datrw::ascii::keySRCEZ, datrw::ascii::keystation, and datrw::ascii::keyvang.

Referenced by main(), and datrw::online_help().

  { 
    os <<
      std::endl <<
      "ASCII reading functions" << std::endl <<
      "-----------------------" << std::endl <<
      DATRW_IASCIISTREAM_CC_VERSION << std::endl <<
      std::endl;
    os << 
      "This module reads seismic time series data in the raw\n"
      "single column ASCII format. No header values are required\n"
      "but all SFF header data can be provided. Header data not\n"
      "present in the file can be set through format modifiers.\n"
      "Header data neither given in the file nor in the format are\n"
      "set to default values. The number of samples is determined from\n"
      "actual numer of samples present in the file. If a number of samples\n"
      "is defined in the header it is used as a maximum number of samples\n"
      "to be read until the next trace begins.\n"
      "Each line with a hash (#) in the first column is treated\n"
      "as a header line. Each line with a double hash (##) in the\n"
      "first two columns is treated as a free format comment. All\n"
      "other lines are treated as ASCII data.\n" 
      << std::endl;
    os << 
      "Parameter values for header fields can be set in lines which\n"
      "have a single hash (#) in the first column. The hash is expected\n"
      "to be followed by a key ID, which can be either one of the\n"
      "modifier keys listed below or can be \"" << ascii::keydata << "\".\n"
      "The key has to be separated from the value by a single colon (:).\n"
      "If you feel unsure, simply write a data file using the ASCII\n"
      "output functions and have a look at the result.\n"
      << std::endl;
    os <<
      "The data type can be selected by the key \"" 
      << ascii::keydata << "\" and one of the values:\n";
      os << "  "; os.width(7);
      os << std::left
      << ascii::keydouble << ": for double precision data\n";
      os << "  "; os.width(7);
      os << std::left
      << ascii::keyfloat << ": for single precision data\n";
      os << "  "; os.width(7);
      os << std::left
      << ascii::keyint << ": for integer data\n"
      "If no type is specified, the default will be " 
      << ascii::keydouble << "\n"
      << std::endl;
    os << 
      "The ascii input stream can be controlled by format modifiers:\n";
      ascii::explainmodifier(os, ascii::keynsamples,
        "(WID2) set number of samples");
      ascii::explainmodifier(os, ascii::keydt,
        "(WID2) set sampling interval (seconds)");
      ascii::explainmodifier(os, ascii::keydate,
        "(WID2) set time of first sample; YYYY/MM/DD/hh/mm/ss.ssssss");
      ascii::explainmodifier(os, ascii::keychannel,
        "(WID2) set channel ID");
      ascii::explainmodifier(os, ascii::keystation,
        "(WID2) set station ID");
      ascii::explainmodifier(os, ascii::keyauxid,
        "(WID2) set auxiliary ID");
      ascii::explainmodifier(os, ascii::keyinstype,
        "(WID2) set instrument type ID");
      ascii::explainmodifier(os, ascii::keycalib,
        "(WID2) set calib value");
      ascii::explainmodifier(os, ascii::keycalper,
        "(WID2) set calper value");
      ascii::explainmodifier(os, ascii::keyhang,
        "(WID2) set hang value");
      ascii::explainmodifier(os, ascii::keyvang,
        "(WID2) set vang value");
      ascii::explainmodifier(os, ascii::keySRCEdate,
        "(SRCE) set date and time of source; YYYY/MM/DD/hh/mm/ss.ssssss");
      ascii::explainmodifier(os, ascii::keySRCEtype,
        "(SRCE) set type of source");
      ascii::explainmodifier(os, ascii::keySRCEX,
        "(SRCE) set x coordinate of source");
      ascii::explainmodifier(os, ascii::keySRCEY,
        "(SRCE) set y coordinate of source");
      ascii::explainmodifier(os, ascii::keySRCEZ,
        "(SRCE) set z coordinate of source");
      ascii::explainmodifier(os, ascii::keySRCECS,
        "(SRCE) set coordinate system of source");
      ascii::explainmodifier(os, ascii::keynstacks,
        "(INFO) set number of stacks");
      ascii::explainmodifier(os, ascii::keyRECVX,
        "(INFO) set x coordinate of receiver");
      ascii::explainmodifier(os, ascii::keyRECVY,
        "(INFO) set y coordinate of receiver");
      ascii::explainmodifier(os, ascii::keyRECVZ,
        "(INFO) set z coordinate of receiver");
      ascii::explainmodifier(os, ascii::keyRECVCS,
        "(INFO) set coordinate system of receiver");
    os << "Further modifiers:\n";
      ascii::explainmodifierflag(os, ascii::keynonfatal,
        "make errors non-fatal is possible (only a warning will be issued)");
  } // void iasciistream::help(std::ostream& os)

Here is the call graph for this function:

Here is the caller graph for this function: