# CASA Next Generation Infrastructure
# Copyright (C) 2021 AUI, Inc. Washington DC, USA
# Copyright (C) 2021 European Southern Observatory, ALMA partnership
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
"""
this module will be included in the api
"""
import pandas as pd
from ._flagging_utils._flag_attributes import _ensure_flags_attr
[docs]def manager_list(vis_dataset):
"""
Add a new flag variable to the dataset. All flags in the new variable are
set to false, unless a source variable is given in which case the values of
the source are copied.
Parameters
----------
vis_dataset : xarray.core.dataset.Dataset
Input dataset
Returns:
-------
pandas.core.frame.DataFrame
Information on flag variables from the input dataset
"""
flags_attr = _ensure_flags_attr(vis_dataset)
res = {'Flag variable name':
[key for key in vis_dataset.attrs[flags_attr]],
'Description':
[val for _key, val in vis_dataset.attrs[flags_attr].items()]}
return pd.DataFrame.from_dict(res)