ketos API

• Data Handling
  • Overview
    • Annotation and Selection Tables
    • Database Interface
    • Data Feeding
  • Data handling
    • rel_path_unix
      • rel_path_unix()
    • parse_datetime
      • parse_datetime()
    • find_files
      • find_files()
    • find_wave_files
      • find_wave_files()
    • read_wave
      • read_wave()
    • create_dir
      • create_dir()
    • to1hot
      • to1hot()
    • from1hot
      • from1hot()
    • check_data_sanity
      • check_data_sanity()
  • Data feeding
    • BatchGenerator
      • BatchGenerator
        • BatchGenerator.get_indices()
        • BatchGenerator.get_samples()
        • BatchGenerator.reset()
        • BatchGenerator.set_return_batch_ids()
        • BatchGenerator.set_shuffle()
    • JointBatchGen
      • JointBatchGen
        • JointBatchGen.get_indices()
        • JointBatchGen.reset()
        • JointBatchGen.set_return_batch_ids()
        • JointBatchGen.set_shuffle()
  • Database Interface
    • AudioWriter
      • AudioWriter
        • AudioWriter.close()
        • AudioWriter.set_table()
        • AudioWriter.write()
        • AudioWriter.write_attr()
    • create_database
      • create_database()
    • create_table
      • create_table()
    • create_table_col
      • create_table_col()
    • filter_by_label
      • filter_by_label()
    • load_audio
      • load_audio()
    • open_file
      • open_file()
    • open_table
      • open_table()
    • table_description
      • table_description()
    • table_description_annot
      • table_description_annot()
    • write
      • write()
    • write_annot
      • write_annot()
    • write_audio
      • write_audio()
    • write_repres_attrs
      • write_repres_attrs()
  • Parsing
    • encode_audio_representation
      • encode_audio_representation()
    • encode_parameter
      • encode_parameter()
    • load_audio_representation
      • load_audio_representation()
    • parse_audio_representation
      • parse_audio_representation()
    • parse_parameter
      • parse_parameter()
    • str2bool
      • str2bool()
    • ureg
      • ureg
  • Selection Table
    • unfold
      • unfold()
    • rename_columns
      • rename_columns()
    • empty_annot_table
      • empty_annot_table()
    • standardize
      • standardize()
    • use_multi_indexing
      • use_multi_indexing()
    • trim
      • trim()
    • is_standardized
      • is_standardized()
    • label_occurrence
      • label_occurrence()
    • cast_to_str
      • cast_to_str()
    • select
      • select()
    • time_shift
      • time_shift()
    • file_duration_table
      • file_duration_table()
    • create_rndm_selections
      • create_rndm_selections()
    • random_choice
      • random_choice()
    • select_by_segmenting
      • select_by_segmenting()
    • segment_files
      • segment_files()
    • segment_annotations
      • segment_annotations()
    • query
      • query()
    • query_labeled
      • query_labeled()
    • query_annotated
      • query_annotated()
    • aggregate_duration
      • aggregate_duration()
• Audio Processing
  • Overview
    • Waveforms
    • Spectrograms
    • Loading multiple audio segments
    • Custom audio representations
    • Configuration files
  • Base Audio
    • BaseAudio
      • BaseAudio
        • BaseAudio.adjust_range()
        • BaseAudio.annotate()
        • BaseAudio.apply_transforms()
        • BaseAudio.average()
        • BaseAudio.deepcopy()
        • BaseAudio.duration()
        • BaseAudio.get()
        • BaseAudio.get_annotations()
        • BaseAudio.get_data()
        • BaseAudio.get_filename()
        • BaseAudio.get_instance_attrs()
        • BaseAudio.get_kwargs()
        • BaseAudio.get_label()
        • BaseAudio.get_offset()
        • BaseAudio.get_repres_attrs()
        • BaseAudio.infer_shape()
        • BaseAudio.max()
        • BaseAudio.median()
        • BaseAudio.min()
        • BaseAudio.normalize()
        • BaseAudio.std()
        • BaseAudio.view_allowed_transforms()
    • BaseAudioTime
      • BaseAudioTime
        • BaseAudioTime.crop()
        • BaseAudioTime.duration()
        • BaseAudioTime.get_instance_attrs()
        • BaseAudioTime.get_repres_attrs()
        • BaseAudioTime.label_array()
        • BaseAudioTime.plot()
        • BaseAudioTime.segment()
        • BaseAudioTime.time_res()
    • segment_data
      • segment_data()
  • Waveform
    • Waveform
      • Waveform
        • Waveform.add()
        • Waveform.add_gaussian_noise()
        • Waveform.append()
        • Waveform.bandpass_filter()
        • Waveform.cosine()
        • Waveform.from_wav()
        • Waveform.gaussian_noise()
        • Waveform.get_repres_attrs()
        • Waveform.morlet()
        • Waveform.plot()
        • Waveform.resample()
        • Waveform.to_wav()
  • Spectrogram
    • CQTSpectrogram
      • CQTSpectrogram
        • CQTSpectrogram.bins_per_octave()
        • CQTSpectrogram.empty()
        • CQTSpectrogram.from_wav()
        • CQTSpectrogram.from_waveform()
        • CQTSpectrogram.get_kwargs()
        • CQTSpectrogram.get_repres_attrs()
        • CQTSpectrogram.plot()
    • MagSpectrogram
      • MagSpectrogram
        • MagSpectrogram.empty()
        • MagSpectrogram.freq_res()
        • MagSpectrogram.from_wav()
        • MagSpectrogram.from_waveform()
        • MagSpectrogram.get_data()
        • MagSpectrogram.get_kwargs()
        • MagSpectrogram.get_phase_angle()
        • MagSpectrogram.get_repres_attrs()
        • MagSpectrogram.plot_phase_angle()
        • MagSpectrogram.recover_waveform()
    • MelSpectrogram
      • MelSpectrogram
        • MelSpectrogram.empty()
        • MelSpectrogram.from_wav()
        • MelSpectrogram.from_waveform()
        • MelSpectrogram.get_kwargs()
        • MelSpectrogram.get_repres_attrs()
        • MelSpectrogram.plot()
    • PowerSpectrogram
      • PowerSpectrogram
        • PowerSpectrogram.empty()
        • PowerSpectrogram.freq_res()
        • PowerSpectrogram.from_wav()
        • PowerSpectrogram.from_waveform()
        • PowerSpectrogram.get_kwargs()
        • PowerSpectrogram.get_repres_attrs()
    • Spectrogram
      • Spectrogram
        • Spectrogram.add()
        • Spectrogram.blur()
        • Spectrogram.crop()
        • Spectrogram.enhance_signal()
        • Spectrogram.freq_max()
        • Spectrogram.freq_min()
        • Spectrogram.get_kwargs()
        • Spectrogram.get_repres_attrs()
        • Spectrogram.infer_shape()
        • Spectrogram.plot()
        • Spectrogram.reduce_tonal_noise()
        • Spectrogram.resize()
    • add_specs
      • add_specs()
    • load_audio_for_spec
      • load_audio_for_spec()
  • Audio Loader
    • AudioFrameLoader
      • AudioFrameLoader
        • AudioFrameLoader.get_file_durations()
        • AudioFrameLoader.get_file_paths()
    • AudioLoader
      • AudioLoader
        • AudioLoader.load()
        • AudioLoader.num()
        • AudioLoader.reset()
        • AudioLoader.skip()
    • FrameStepper
      • FrameStepper
        • FrameStepper.get_file_durations()
        • FrameStepper.get_file_paths()
        • FrameStepper.num()
        • FrameStepper.reset()
    • SelectionGenerator
      • SelectionGenerator
        • SelectionGenerator.num()
        • SelectionGenerator.reset()
    • SelectionTableIterator
      • SelectionTableIterator
        • SelectionTableIterator.get_selection()
        • SelectionTableIterator.num()
        • SelectionTableIterator.reset()
  • Annotation
    • AnnotationHandler
      • AnnotationHandler
        • AnnotationHandler.add()
        • AnnotationHandler.copy()
        • AnnotationHandler.crop()
        • AnnotationHandler.get()
        • AnnotationHandler.num_annotations()
        • AnnotationHandler.num_sets()
        • AnnotationHandler.segment()
        • AnnotationHandler.set_ids()
        • AnnotationHandler.shift()
    • add_index_level
      • add_index_level()
    • convert
      • convert()
    • convert_to_Hz
      • convert_to_Hz()
    • convert_to_sec
      • convert_to_sec()
    • stack_annotations
      • stack_annotations()
  • Gammatone
    • AuralFeatures
      • AuralFeatures
        • AuralFeatures.from_wav()
        • AuralFeatures.from_waveform()
        • AuralFeatures.get_repres_attrs()
    • GammatoneFilterBank
      • GammatoneFilterBank
        • GammatoneFilterBank.empty()
        • GammatoneFilterBank.from_wav()
        • GammatoneFilterBank.from_waveform()
        • GammatoneFilterBank.get_repres_attrs()
        • GammatoneFilterBank.plot()
    • apply_weight_func
      • apply_weight_func()
    • compute_center_freqs
      • compute_center_freqs()
    • compute_filter_coeffs
      • compute_filter_coeffs()
    • filter_signal
      • filter_signal()
    • get_filter_coeffs
      • get_filter_coeffs()
  • Utilities
    • Miscellaneous
      • cqt
        • cqt()
      • from_decibel
        • from_decibel()
      • hz_to_mel
        • hz_to_mel()
      • mag2mel
        • mag2mel()
      • mag2mfcc
        • mag2mfcc()
      • mag2pow
        • mag2pow()
      • mel_filter_bank
        • mel_filter_bank()
      • mel_to_hz
        • mel_to_hz()
      • num_samples
        • num_samples()
      • pad_reflect
        • pad_reflect()
      • pad_zero
        • pad_zero()
      • segment
        • segment()
      • segment_args
        • segment_args()
      • spec2wave
        • spec2wave()
      • stft
        • stft()
      • to_decibel
        • to_decibel()
    • Axis
      • Axis
        • Axis
          • Axis.bin()
          • Axis.bin_width()
          • Axis.cut()
          • Axis.low_edge()
          • Axis.max()
          • Axis.min()
          • Axis.resize()
          • Axis.ticks_and_labels()
          • Axis.up_edge()
      • LinearAxis
        • LinearAxis
          • LinearAxis.bin()
          • LinearAxis.low_edge()
          • LinearAxis.resize()
          • LinearAxis.zero_offset()
      • Log2Axis
        • Log2Axis
          • Log2Axis.bin()
          • Log2Axis.low_edge()
          • Log2Axis.resize()
          • Log2Axis.ticks_and_labels()
      • MelAxis
        • MelAxis
          • MelAxis.bin()
          • MelAxis.cut()
          • MelAxis.low_edge()
          • MelAxis.resize()
      • bin_number
        • bin_number()
    • Filter
      • apply_median_filter
        • apply_median_filter()
      • apply_preemphasis
        • apply_preemphasis()
      • blur_image
        • blur_image()
      • enhance_signal
        • enhance_signal()
      • filter_isolated_spots
        • filter_isolated_spots()
      • plot_image
        • plot_image()
      • reduce_tonal_noise
        • reduce_tonal_noise()
      • reduce_tonal_noise_running_mean
        • reduce_tonal_noise_running_mean()
• Neural networks
  • Overview
    • Loading a pre-trained model
    • Creating a fresh model from a recipe
    • More on Ketos recipes
    • Training a model
    • Adding the ketos Neural Network interface to your own architectures.
  • CNN
    • CNN1DArch
      • CNN1DArch
        • CNN1DArch.call()
        • CNN1DArch.clone_with_new_top()
        • CNN1DArch.freeze_conv_block()
        • CNN1DArch.freeze_top()
        • CNN1DArch.get_feature_extraction_base()
        • CNN1DArch.unfreeze_conv_block()
        • CNN1DArch.unfreeze_top()
    • CNN1DInterface
      • CNN1DInterface
        • CNN1DInterface.transform_batch()
    • CNNArch
      • CNNArch
        • CNNArch.call()
        • CNNArch.clone_with_new_top()
        • CNNArch.freeze_conv_block()
        • CNNArch.freeze_top()
        • CNNArch.get_feature_extraction_base()
        • CNNArch.unfreeze_conv_block()
        • CNNArch.unfreeze_top()
    • CNNInterface
      • CNNInterface
  • ResNet
    • ResNet1DArch
      • ResNet1DArch
        • ResNet1DArch.call()
        • ResNet1DArch.clone_with_new_top()
        • ResNet1DArch.freeze_block()
        • ResNet1DArch.freeze_init_layer()
        • ResNet1DArch.freeze_top()
        • ResNet1DArch.get_feature_extraction_base()
        • ResNet1DArch.set_batch_norm_momentum()
        • ResNet1DArch.set_dropout_rate()
        • ResNet1DArch.unfreeze_block()
        • ResNet1DArch.unfreeze_init_layer()
        • ResNet1DArch.unfreeze_top()
    • ResNet1DBlock
      • ResNet1DBlock
        • ResNet1DBlock.call()
        • ResNet1DBlock.set_batch_norm_momentum()
        • ResNet1DBlock.set_dropout_rate()
    • ResNet1DInterface
      • ResNet1DInterface
        • ResNet1DInterface.transform_batch()
    • ResNetArch
      • ResNetArch
        • ResNetArch.call()
        • ResNetArch.clone_with_new_top()
        • ResNetArch.freeze_block()
        • ResNetArch.freeze_init_layer()
        • ResNetArch.freeze_top()
        • ResNetArch.get_feature_extraction_base()
        • ResNetArch.set_batch_norm_momentum()
        • ResNetArch.set_dropout_rate()
        • ResNetArch.unfreeze_block()
        • ResNetArch.unfreeze_init_layer()
        • ResNetArch.unfreeze_top()
    • ResNetBlock
      • ResNetBlock
        • ResNetBlock.call()
        • ResNetBlock.set_batch_norm_momentum()
        • ResNetBlock.set_dropout_rate()
    • ResNetInterface
      • ResNetInterface
  • DenseNet
    • ConvBlock
      • ConvBlock
        • ConvBlock.call()
    • DenseBlock
      • DenseBlock
        • DenseBlock.call()
    • DenseNetArch
      • DenseNetArch
        • DenseNetArch.call()
        • DenseNetArch.clone_with_new_top()
        • DenseNetArch.freeze_block()
        • DenseNetArch.freeze_init_layer()
        • DenseNetArch.freeze_top()
        • DenseNetArch.get_feature_extraction_base()
        • DenseNetArch.unfreeze_block()
        • DenseNetArch.unfreeze_init_layer()
        • DenseNetArch.unfreeze_top()
    • DenseNetInterface
      • DenseNetInterface
    • TransitionBlock
      • TransitionBlock
        • TransitionBlock.call()
  • Inception
    • ConvBatchNormRelu
      • ConvBatchNormRelu
        • ConvBatchNormRelu.call()
    • InceptionArch
      • InceptionArch
        • InceptionArch.call()
        • InceptionArch.clone_with_new_top()
        • InceptionArch.freeze_block()
        • InceptionArch.freeze_init_layer()
        • InceptionArch.freeze_top()
        • InceptionArch.get_feature_extraction_base()
        • InceptionArch.unfreeze_block()
        • InceptionArch.unfreeze_init_layer()
        • InceptionArch.unfreeze_top()
    • InceptionBlock
      • InceptionBlock
        • InceptionBlock.call()
    • InceptionInterface
      • InceptionInterface
  • Developer utilities
    • Losses
      • FScoreLoss
        • FScoreLoss
          • FScoreLoss.call()
    • Neural-Network Interface
      • NNInterface
        • NNInterface
          • NNInterface.add_learning_rate_scheduler()
          • NNInterface.build()
          • NNInterface.checkpoint_dir
          • NNInterface.early_stopping_monitor
          • NNInterface.load()
          • NNInterface.log_dir
          • NNInterface.run_on_batch()
          • NNInterface.run_on_instance()
          • NNInterface.run_on_test_generator()
          • NNInterface.save()
          • NNInterface.save_recipe_file()
          • NNInterface.test_generator
          • NNInterface.train_generator
          • NNInterface.train_loop()
          • NNInterface.transform_batch()
          • NNInterface.val_generator
          • NNInterface.valid_losses
          • NNInterface.valid_metrics
          • NNInterface.valid_optimizers
      • RecipeCompat
        • RecipeCompat
          • RecipeCompat.instantiate_template()
    • Detection
      • compute_score_running_avg
        • compute_score_running_avg()
      • batch_load_hdf5_data
        • batch_load_hdf5_data()
      • batch_load_audio_file_data
        • batch_load_audio_file_data()
      • add_detection_buffer
        • add_detection_buffer()
      • apply_detection_threshold
        • apply_detection_threshold()
      • filter_by_threshold
        • filter_by_threshold()
      • convert_sequence_to_snapshot
        • convert_sequence_to_snapshot()
      • filter_by_label
        • filter_by_label()
      • merge_overlapping_detections
        • merge_overlapping_detections()
      • merge_consecutive_detections
        • merge_consecutive_detections()
    • Export
      • export_to_ketos_protobuf
        • export_to_ketos_protobuf()
      • export_to_protobuf
        • export_to_protobuf()
• Utilities
  • complex_value
    • complex_value()
  • detect_peaks
    • detect_peaks()
  • ensure_dir
    • ensure_dir()
  • factors
    • factors()
  • get_member
    • get_member()
  • morlet_func
    • morlet_func()
  • ndim
    • ndim()
  • nearest_values
    • nearest_values()
  • octave_bands
    • octave_bands()
  • octave_bands_json
    • octave_bands_json()
  • random_floats
    • random_floats()
  • signif
    • signif()
  • str_is_int
    • str_is_int()
  • tostring
    • tostring()
  • ceil
    • ceil()
  • floor
    • floor()
  • ceil_round_down
    • ceil_round_down()
  • floor_round_up
    • floor_round_up()