help() [1/2]

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

static

Definition at line 79 of file osffstream.cc.

References DATRW_OSFF_CC_VERSION.

Referenced by datrw::online_help().

  {
    os <<
      std::endl <<
      "SFF writing functions" << std::endl <<
      "---------------------" << std::endl <<
      DATRW_OSFF_CC_VERSION << std::endl <<
      std::endl;
    os << 
      "This module writes SFF data. SFF (Stuttgart File Format) is\n"
      "based on GSE subformat CM6. GSE is an integer format with\n"
      "a dynamic range of little more than 27 bits. Second differences\n"
      "are saved such that in the worst case two bits are consumed by the\n"
      "second differences and one additional bit for the sign. The\n"
      "underlying libgsexx aborts if numbers larger than 2**26-1 are\n"
      "to be written. For this reason floating point data must be\n"
      "scaled appropriately before being written to SFF data. The\n"
      "default is to scale to maximum dynamic range (i.e. 2**26-1).\n"
      "Two other scaling options are available through format modifiers:"
      << std::endl;
    os <<
      "dontscale        Write data as is. This is appropriate for integer\n"
      "                 data in particlular.\n"
      "scaleifneeded    Scale only if largest value in time series is\n"
      "                 larger than 2**26-1. Sample values smaller than\n"
      "                 will be truncated to zero silently."
      << std::endl;
  } // void osffstream::help(std::ostream& os=std::cout)

Here is the caller graph for this function: