sorcha.readers.OrbitAuxReader

Classes

OrbitAuxReader

A class to read in the auxiliary orbit data files.

Module Contents

class OrbitAuxReader(filename, sep='csv', header=-1, **kwargs)[source]

Bases: sorcha.readers.CSVReader.CSVDataReader

A class to read in the auxiliary orbit data files.

get_reader_info()[source]

Return a string identifying the current reader name and input information (for logging and output).

Returns:: The reader information.
Return type:: string

_process_and_validate_input_table(input_table, **kwargs)[source]

Perform any input-specific processing and validation on the input table. Modifies the input dataframe in place.

Parameters:

input_table (pandas dataframe) -- A loaded table.
**kwargs (dictionary, optional)

Returns:

res_df -- Returns the input dataframe modified in-place.

Return type:

pandas dataframe

Notes

The base implementation includes filtering that is common to most input types. Subclasses should call super.process_and_validate() to ensure that the ancestor’s validation is also applied.