sigmf.sigmffile.SigMFFile
=========================

.. currentmodule:: sigmf.sigmffile

.. autoclass:: SigMFFile
   :members:
   :show-inheritance:
   :inherited-members:
   :special-members: __call__, __add__, __mul__

   
   
   .. rubric:: Methods

   .. autosummary::
      :nosignatures:
   
      ~SigMFFile.add_annotation
      ~SigMFFile.add_capture
      ~SigMFFile.archive
      ~SigMFFile.calculate_hash
      ~SigMFFile.dump
      ~SigMFFile.dumps
      ~SigMFFile.get_annotations
      ~SigMFFile.get_capture_byte_boundaries
      ~SigMFFile.get_capture_byte_boundarys
      ~SigMFFile.get_capture_info
      ~SigMFFile.get_capture_start
      ~SigMFFile.get_captures
      ~SigMFFile.get_global_field
      ~SigMFFile.get_global_info
      ~SigMFFile.get_num_channels
      ~SigMFFile.get_sample_size
      ~SigMFFile.get_schema
      ~SigMFFile.ordered_metadata
      ~SigMFFile.read_samples
      ~SigMFFile.read_samples_in_capture
      ~SigMFFile.set_data_file
      ~SigMFFile.set_global_field
      ~SigMFFile.set_global_info
      ~SigMFFile.set_metadata
      ~SigMFFile.tofile
      ~SigMFFile.validate
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~SigMFFile.ANNOTATION_KEY
      ~SigMFFile.AUTHOR_KEY
      ~SigMFFile.CAPTURE_KEY
      ~SigMFFile.COLLECTION_KEY
      ~SigMFFile.COMMENT_KEY
      ~SigMFFile.DATASET_KEY
      ~SigMFFile.DATATYPE_KEY
      ~SigMFFile.DATA_DOI_KEY
      ~SigMFFile.DATETIME_KEY
      ~SigMFFile.DESCRIPTION_KEY
      ~SigMFFile.EXTENSIONS_KEY
      ~SigMFFile.FREQUENCY_KEY
      ~SigMFFile.FREQ_LOWER_EDGE_KEY
      ~SigMFFile.FREQ_UPPER_EDGE_KEY
      ~SigMFFile.GENERATOR_KEY
      ~SigMFFile.GEOLOCATION_KEY
      ~SigMFFile.GLOBAL_INDEX_KEY
      ~SigMFFile.GLOBAL_KEY
      ~SigMFFile.HEADER_BYTES_KEY
      ~SigMFFile.HW_KEY
      ~SigMFFile.LABEL_KEY
      ~SigMFFile.LATITUDE_KEY
      ~SigMFFile.LICENSE_KEY
      ~SigMFFile.LONGITUDE_KEY
      ~SigMFFile.METADATA_ONLY_KEY
      ~SigMFFile.META_DOI_KEY
      ~SigMFFile.NUM_CHANNELS_KEY
      ~SigMFFile.OFFSET_KEY
      ~SigMFFile.RECORDER_KEY
      ~SigMFFile.SAMPLE_COUNT_KEY
      ~SigMFFile.SAMPLE_RATE_KEY
      ~SigMFFile.SAMPLE_START_KEY
      ~SigMFFile.SHA512_KEY
      ~SigMFFile.TRAILING_BYTES_KEY
      ~SigMFFile.UUID_KEY
      ~SigMFFile.VALID_ANNOTATION_KEYS
      ~SigMFFile.VALID_CAPTURE_KEYS
      ~SigMFFile.VALID_GLOBAL_KEYS
      ~SigMFFile.VALID_KEYS
      ~SigMFFile.VERSION_KEY