Colour equation

apply_colour_equation(input_synthetic_photometry, photometric_system=None, output_path='.', output_file='corrected_photometry', output_format=None, save_file=True)[source]

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

Parameters

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

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

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

  • output_file (str) – The name of the output file.

  • output_format (str) – The format of the output file (csv, fits, xml).

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

Returns

The input photometry with colour equations applied if it corresponds.

Return type

DataFrame