astro py:docs

- Index
- Modules

### Navigation

- next »
- « previous |
- Astropy v5.2.1 »
- ASCII Tables (`astropy.io.ascii`) »
- FixedWidthHeader

# FixedWidthHeader

class astropy.io.ascii.FixedWidthHeader

  Bases: `BasicHeader`

  Fixed width table header reader.

  Attributes Summary

  `position_line` | row index of line that specifies position (default = 1)
  `set_of_position_line_characters` |

  Methods Summary

  `get_cols`(lines) | Initialize the header Column objects from the table `lines`.
  `get_fixedwidth_params`(line) | Split `line` on the delimiter and determine column values and column start and end positions.
  `get_line`(lines, index) |
  `write`(lines) |

  Attributes Documentation

  position_line = None

    row index of line that specifies position (default = 1)

  set_of_position_line_characters = {'!', '"', '#', '$', '%', '&', "'", '*', '+', '-', ':', '=', '\\', '^', '_', '`', '|', '~'}

  Methods Documentation

  get_cols(lines)

    Initialize the header Column objects from the table `lines`.

    Based on the previously set Header attributes find or create the column names. Sets `self.cols` with the list of Columns.

    Parameters:
      lines `python:list`

        List of table lines

  get_fixedwidth_params(line)

    Split `line` on the delimiter and determine column values and column start and end positions. This might include null columns with zero length (e.g. for `header row = "| col1 || col2 | col3 |"` or `header2_row = "----- ------- -----"`). The null columns are stripped out. Returns the values between delimiters and the corresponding start and end positions.

    Parameters:
      line `python:str`

        Input line

    Returns:
      vals `python:list`

        List of values.

      starts `python:list`

        List of starting indices.

      ends `python:list`

        List of ending indices.

  get_line(lines, index)
  write(lines)