Generator

generate(input_object, photometric_system, output_path='.', output_file='output_synthetic_photometry', output_format=None, save_file=True, error_correction=False, username=None, password=None)

Synthetic photometry utility: generates synthetic photometry in a set of available systems from the input internally-calibrated continuously-represented mean spectra.

Some standardised photometric systems include a colour-correction to the U bands which will be applied automatically when generating the corresponding synthetic photometry.

Parameters

• input_object (object) – Path to the file containing the mean spectra as downloaded from the archive in their continuous representation, a list of sources ids (string or long), or a pandas DataFrame.

• photometric_system (obj) – Desired photometric system or list of photometric systems.

• output_path (str) – Path where to save the output data.

• output_file (str) – Name of the output file.

• output_format (str) – Format to be used for the output file. If no format is given, then the output file will be in the same format as the input file.

• save_file (bool) – Whether to save the output in a file. If false, output_format and output_file_name are ignored.

• error_correction (bool) – Whether to apply to the photometric errors the tabulated factors to mitigate underestimated errors (see Montegriffo et al., 2022, for more details).

• username (str) – Cosmos username, only required when the input_object is a list or ADQL query.

• password (str) – Cosmos password, only required when the input_object is a list or ADQL query.

Returns

A DataFrame of all synthetic photometry results.

Return type

DataFrame

internal_photometric_system.py

Module for the parent class of the standardised and regular photometric systems.

class InternalPhotometricSystem(name)

Bases: object

get_bands()

Get the bands of the photometric system.

Returns

List of bands.

Return type

list of str

get_offsets()

get_system_label()

Get the label of the photometric system.

Returns

A short description of the photometric system.

Return type

str

get_zero_points()

Get the zero-points of the photometric system.

Returns

1D array containing the zero-points for all bands in this photometric system.

Return type

ndarray

set_bands(bands)

Set the bands of the photometric system.

Parameters

bands (list) – List of bands in this photometric system.

set_offsets(offsets)

set_zero_points(zero_points)

Set the zero-points needed to convert the Gaia fluxes in the bands defining this photometric system to magnitudes.

Parameters

zero_points (nparray) – 1D array containing the zero-point for each of the bands in this photometric system.

class MultiSyntheticPhotometryGenerator(photometric_system, bp_model, rp_model)

Bases: SyntheticPhotometryGenerator

photometric_system.py

Module for the management of photometric systems.

class AutoName(value)

Bases: Enum

An enumeration.

get_bands()

get_offsets()

get_system_label()

get_system_name()

get_zero_points()

class PhotometricSystem(value)

Bases: AutoName

An enumeration.

Els_Custom_W09_S2 = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

Euclid_VIS = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

Gaia_2 = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

Gaia_DR3_Vega = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

HST_ACSWFC = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

HST_HUGS_Std = <gaiaxpy.generator.standardised_photometric_system.StandardisedPhotometricSystem object>

HST_WFC3UVIS = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

HST_WFPC2 = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

H_Custom = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

Halpha_Custom_AB = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

Hipparcos_Tycho = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

IPHAS = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

JKC = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

JKC_Std = <gaiaxpy.generator.standardised_photometric_system.StandardisedPhotometricSystem object>

JPAS = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

JPLUS = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

JWST_NIRCAM = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

PanSTARRS1 = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

PanSTARRS1_Std = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

Pristine = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

SDSS = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

SDSS_Std = <gaiaxpy.generator.standardised_photometric_system.StandardisedPhotometricSystem object>

Sky_Mapper = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

Stromgren = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

Stromgren_Std = <gaiaxpy.generator.standardised_photometric_system.StandardisedPhotometricSystem object>

WFIRST = <gaiaxpy.generator.regular_photometric_system.RegularPhotometricSystem object>

get_available_systems()

get_available_systems()

regular_photometric_system.py

Module to represent a regular photometric system.

class RegularPhotometricSystem(name)

Bases: InternalPhotometricSystem

standardised_photometric_system.py

Module to represent a standardised photometric system.

class StandardisedPhotometricSystem(name)

Bases: InternalPhotometricSystem

synthetic_photometry_generator.py

Module for the generation of synthetic photometry.

class SyntheticPhotometryGenerator

Bases: object