Alignments
==========

.. currentmodule:: scripts.fs_media

.. autoclass:: Alignments
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Alignments.data
      ~Alignments.faces_count
      ~Alignments.file
      ~Alignments.frames_count
      ~Alignments.have_alignments_file
      ~Alignments.mask_summary
      ~Alignments.save_alignments
      ~Alignments.thumbnails
      ~Alignments.version
      ~Alignments.video_meta_data

   .. rubric:: Methods Summary

   .. autosummary::

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

   .. rubric:: Attributes Documentation

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

   .. rubric:: Methods Documentation

   .. automethod:: add_face
   .. automethod:: backup
   .. 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