Source code for aiida.tools.data.array.trajectory

###########################################################################
# Copyright (c), The AiiDA team. All rights reserved.                     #
# This file is part of the AiiDA code.                                    #
#                                                                         #
# The code is hosted on GitHub at https://github.com/aiidateam/aiida-core #
# For further information on the license, see the LICENSE.txt file        #
# For further information please visit http://www.aiida.net               #
###########################################################################
"""Tools to operate on `TrajectoryData` nodes."""

from aiida.engine import calcfunction




@calcfunction
def _get_aiida_structure_inline(trajectory, parameters):
    """CalcFunction to extract a :py:class:`aiida.orm.nodes.data.structure.StructureData`
    from a `TrajectoryData`.

    :param parameters: A dictionary whose key-value pairs are passed as
        additional kwargs to the :py:meth:``TrajectoryData.get_step_structure`` method.
    """
    kwargs = {}
    if parameters is not None:
        kwargs = parameters.get_dict()
    if 'index' not in kwargs.keys() or kwargs['index'] is None:
        raise ValueError('Step index is not supplied for TrajectoryData')
    return {'structure': trajectory.get_step_structure(**kwargs)}