redback.get_data.get_fink_data

redback.get_data.get_fink_data(transient: str, transient_type: str, source: str = 'ztf', **kwargs: None) → DataFrame[source]

Catch all data getting function for Fink data. Creates a directory structure and saves the data. Returns the data, though no further action needs to be taken by the user.

Parameters:

  • transient (str) – The name of the transient, e.g. ‘ZTF19aagqkrq’ for ZTF or ‘170019717277810735’ for LSST.

  • transient_type (str) – Type of the transient. Must be from redback.get_data.fink.FinkDataGetter.VALID_TRANSIENT_TYPES.

  • source (str) – The source of the data. Must be either ‘ztf’ or ‘lsst’. Default is ‘ztf’.

  • kwargs (None) – Placeholder to prevent TypeErrors.

Returns:

The processed data.

Return type:

pandas.DataFrame