Colour equation

xp_filter_system_colour_equation.py

Module that implements the colour equation functionality.

apply_colour_equation(input_synthetic_photometry: DataFrame, photometric_system: list | PhotometricSystem | None = None, output_path: str = '.', output_file: str = 'corrected_photometry', output_format: str | None = None, save_file: bool = True)[source]

Apply the available colour correction to the input photometric system(s).

Parameters:

  • input_synthetic_photometry (DataFrame) – Input photometry as returned by GaiaXPy generator.

  • photometric_system (PhotometricSystem, list of PhotometricSystem) – The photometric systems over which to apply

  • equations. (the)

  • output_path (str) – The path of the output file.

  • output_file (str) – Name of the output file without extension (e.g. ‘my_file’).

  • output_format (str) – Desired output format. If no format is given, the output file format will be the same as the input file (e.g. ‘csv’).

  • save_file (bool) – Whether to save the output file.

Returns:

The input photometry with colour equations applied if it corresponds.

Return type:

DataFrame