AlignmentData
=============

.. currentmodule:: tools.alignments.media

.. autoclass:: AlignmentData
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~AlignmentData.data
      ~AlignmentData.faces_count
      ~AlignmentData.file
      ~AlignmentData.frames_count
      ~AlignmentData.have_alignments_file
      ~AlignmentData.mask_summary
      ~AlignmentData.thumbnails
      ~AlignmentData.version
      ~AlignmentData.video_meta_data

   .. rubric:: Methods Summary

   .. autosummary::

      ~AlignmentData.add_face
      ~AlignmentData.backup
      ~AlignmentData.check_file_exists
      ~AlignmentData.count_faces_in_frame
      ~AlignmentData.delete_face_at_index
      ~AlignmentData.filter_faces
      ~AlignmentData.frame_exists
      ~AlignmentData.frame_has_faces
      ~AlignmentData.frame_has_multiple_faces
      ~AlignmentData.get_faces_in_frame
      ~AlignmentData.mask_is_valid
      ~AlignmentData.save
      ~AlignmentData.save_video_meta_data
      ~AlignmentData.update_face
      ~AlignmentData.update_from_dict
      ~AlignmentData.update_legacy_has_source
      ~AlignmentData.yield_faces

   .. rubric:: Attributes Documentation

   .. autoattribute:: data
   .. autoattribute:: faces_count
   .. autoattribute:: file
   .. autoattribute:: frames_count
   .. autoattribute:: have_alignments_file
   .. autoattribute:: mask_summary
   .. autoattribute:: thumbnails
   .. autoattribute:: version
   .. autoattribute:: video_meta_data

   .. rubric:: Methods Documentation

   .. automethod:: add_face
   .. automethod:: backup
   .. automethod:: check_file_exists
   .. automethod:: count_faces_in_frame
   .. automethod:: delete_face_at_index
   .. automethod:: filter_faces
   .. automethod:: frame_exists
   .. automethod:: frame_has_faces
   .. automethod:: frame_has_multiple_faces
   .. automethod:: get_faces_in_frame
   .. automethod:: mask_is_valid
   .. automethod:: save
   .. automethod:: save_video_meta_data
   .. automethod:: update_face
   .. automethod:: update_from_dict
   .. automethod:: update_legacy_has_source
   .. automethod:: yield_faces