Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removed stray : from ctapipe.io page #2448

Merged
merged 3 commits into from
Nov 17, 2023
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/api-reference/io/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ for new data:
column of an output table.


Serialization of Containers:
Serialization of Containers
============================
Tobychev marked this conversation as resolved.
Show resolved Hide resolved

The `~ctapipe.io.TableWriter` and `~ctapipe.io.TableReader` base classes provide
Expand All @@ -127,7 +127,7 @@ using the `~ctapipe.io.HDF5TableReader`, or more generically using the
array values in a column cannot be read into a ``pandas.DataFrame``, since it
only supports scalar values).

Writing Output Files:
Writing Output Files
=====================

The `DataWriter` Component allows one to write a series of events (stored in
Expand All @@ -144,12 +144,12 @@ information. It can be used in an event loop like:
calibrate(event)
write_data(event)

Reading Output Tables:
Reading Output Tables
======================
In addition to using an `EventSource` to read R0-DL1 data files, one can also access full *tables* for files that are in HDF5 format (e.g. DL1 and higher files).


`~ctapipe.io.TableLoader`: is a a convenient way to load and join together the
`~ctapipe.io.TableLoader` is a a convenient way to load and join together the
tables in a ctapipe output file into one or more high-level tables useful for analysis.
Which information is read and joined is controlled by the TableLoader's configuration
options.
Expand All @@ -169,6 +169,7 @@ into one big table, joining the simulation information if available:


You can also load telescope events for specific selections of telescopes:

.. code-block:: python

# by str representation of the type
Expand Down